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

List Common Scenario & Goal Library

To list the platform-curated Common Scenario & Goal Library, send a GET request to /v2/gen-ai/scenario_library.

6 parameters
pageintegeroptional
Page number.
per_pageintegeroptional
Items per page.
categorystringoptional
Filter by category (exact match). Empty means no category filter.
searchstringoptional
Free-text search across name, description, and goal_description (case-insensitive substring match). Empty means no search.
sort_bystringoptional
Field to sort by. Defaults to name when unspecified. - SCENARIO_LIBRARY_SORT_FIELD_NAME: Sort by customer-facing name (case-insensitive). Default. - SCENARIO_LIBRARY_SORT_FIELD_CREATED_AT: Sort by creation date.
Allowed:SCENARIO_LIBRARY_SORT_FIELD_UNSPECIFIEDSCENARIO_LIBRARY_SORT_FIELD_NAMESCENARIO_LIBRARY_SORT_FIELD_CREATED_ATDefault:SCENARIO_LIBRARY_SORT_FIELD_UNSPECIFIED
sort_directionstringoptional
Sort direction. Defaults to ascending when unspecified.
Allowed:SORT_DIRECTION_UNSPECIFIEDSORT_DIRECTION_ASCSORT_DIRECTION_DESCDefault:SORT_DIRECTION_UNSPECIFIED

6 status codes
200A successful response.
available_categoriesarray<string>optional
Categories currently in use, for filtering library results.
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.
linksobjectoptional
Links to other pages
metaobjectoptional
Meta information about the data set
scenariosarray<object>optional
The library entries 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.