DigitalOcean API (unofficial showcase)
GET/v2/gen-ai/scenario_sets

List Scenario Sets

To list scenario sets, send a GET request to /v2/gen-ai/scenario_sets.

7 parameters
pageintegeroptional
Page number.
per_pageintegeroptional
Items per page.
statusesarray<string>optional
Filter by one or more statuses. Empty means no status filter. - SCENARIO_SET_STATUS_GENERATING: Generation is in progress. The scenarios are not ready yet. - SCENARIO_SET_STATUS_READY: The scenario set is ready to use. - SCENARIO_SET_STATUS_FAILED: Generation failed. The scenario set has no readable scenarios. - SCENARIO_SET_STATUS_CANCELLED: Generation was cancelled before completion.
source_kindsarray<string>optional
Filter by one or more source kinds. Empty means no source-kind filter. - SCENARIO_SET_SOURCE_KIND_USER_UPLOAD: Created from uploaded or inline scenarios. - SCENARIO_SET_SOURCE_KIND_GOAL_GENERATED: Produced by goal-driven generation. - SCENARIO_SET_SOURCE_KIND_LIBRARY: Copied from a platform-curated library entry. - SCENARIO_SET_SOURCE_KIND_SIGNAL_GENERATED: Produced from a completed Signals export.
searchstringoptional
Free-text search across name and description (case-insensitive substring match). Empty means no search.
sort_bystringoptional
Field to sort by. Defaults to creation date when unspecified. - SCENARIO_SET_SORT_FIELD_CREATED_AT: Sort by creation date. Default. - SCENARIO_SET_SORT_FIELD_NAME: Sort by customer-supplied name (case-insensitive). - SCENARIO_SET_SORT_FIELD_STATUS: Sort by status using lifecycle order (generating → ready → terminal). - SCENARIO_SET_SORT_FIELD_SCENARIO_COUNT: Sort by scenario_count. - SCENARIO_SET_SORT_FIELD_UPDATED_AT: Sort by last update date.
Allowed:SCENARIO_SET_SORT_FIELD_UNSPECIFIEDSCENARIO_SET_SORT_FIELD_CREATED_ATSCENARIO_SET_SORT_FIELD_NAMESCENARIO_SET_SORT_FIELD_STATUSSCENARIO_SET_SORT_FIELD_SCENARIO_COUNTSCENARIO_SET_SORT_FIELD_UPDATED_ATDefault:SCENARIO_SET_SORT_FIELD_UNSPECIFIED
sort_directionstringoptional
Sort direction. Defaults to descending when unspecified.
Allowed:SORT_DIRECTION_UNSPECIFIEDSORT_DIRECTION_ASCSORT_DIRECTION_DESCDefault:SORT_DIRECTION_UNSPECIFIED

6 status codes
200A successful response.
available_sort_byarray<string>optional
Sort-by values available for this list request.
available_sort_directionsarray<string>optional
Sort-direction values available for this list request.
available_source_kindsarray<string>optional
Source kinds available for filtering this list request.
available_statusesarray<string>optional
Statuses available for filtering this list request.
linksobjectoptional
Links to other pages
metaobjectoptional
Meta information about the data set
scenario_setsarray<object>optional
The scenario sets for the current page.
401Authentication failed due to invalid credentials.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
404The resource was not found.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429The API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500There was a server error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultThere was an unexpected error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

Error handling

A 401 is returned: Authentication failed due to invalid credentials. A 404 is returned: The resource was not found. A 429 is returned: The API rate limit has been exceeded. A 500 is returned: There was a server error. Any other status is an error: There was an unexpected error.