For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.genai.list_scenario_sets(
    page=None,
    per_page=None,
    statuses=None,
    source_kinds=None,
    search=None,
    sort_by="SCENARIO_SET_SORT_FIELD_UNSPECIFIED",
    sort_direction="SORT_DIRECTION_UNSPECIFIED",
)

Description

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

Parameters

page integer optional

Page number.

per_page integer optional

Items per page.

statuses array of strings 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_kinds array of strings 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.

search string optional

Free-text search across name and description
(case-insensitive substring match). Empty means no search.

sort_by string optional

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.

One of: SCENARIO_SET_SORT_FIELD_UNSPECIFIED, SCENARIO_SET_SORT_FIELD_CREATED_AT, SCENARIO_SET_SORT_FIELD_NAME, SCENARIO_SET_SORT_FIELD_STATUS, SCENARIO_SET_SORT_FIELD_SCENARIO_COUNT, SCENARIO_SET_SORT_FIELD_UPDATED_AT

Default: SCENARIO_SET_SORT_FIELD_UNSPECIFIED

sort_direction string optional

Sort direction. Defaults to descending when unspecified.

One of: SORT_DIRECTION_UNSPECIFIED, SORT_DIRECTION_ASC, SORT_DIRECTION_DESC

Default: SORT_DIRECTION_UNSPECIFIED

Pagination

This method returns paginated results. The response includes a links.pages object with URLs for navigating between pages. To retrieve the next page, parse the next URL and pass the page parameter:

from urllib.parse import urlparse, parse_qs

resp = client.genai.list_scenario_sets()
pages = resp.get("links", {}).get("pages", {})

while "next" in pages:
    parsed = urlparse(pages["next"])
    page = int(parse_qs(parsed.query)["page"][0])
    resp = client.genai.list_scenario_sets(page=page)
    pages = resp.get("links", {}).get("pages", {})

Response Example

{
  "available_sort_by": [
    "SCENARIO_SET_SORT_FIELD_UNSPECIFIED"
  ],
  "available_sort_directions": [
    "SORT_DIRECTION_UNSPECIFIED"
  ],
  "available_source_kinds": [
    "SCENARIO_SET_SOURCE_KIND_UNSPECIFIED"
  ],
  "available_statuses": [
    "SCENARIO_SET_STATUS_UNSPECIFIED"
  ],
  "links": {
    "pages": {
      "first": "example string",
      "last": "example string",
      "next": "example string",
      "previous": "example string"
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  },
  "scenario_sets": [
    {
      "bucket_name": "example name",
      "bucket_region": "example string",
      "created_at": "2023-01-01T00:00:00Z",
      "deleted_at": "2023-01-01T00:00:00Z",
      "description": "example string",
      "failure_reason": "example string",
      "generator_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "library_scenario_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "name": "example name",
      "scenario_count": 123,
      "scenario_set_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "source_export_id": "123e4567-e89b-12d3-a456-426614174000",
      "source_goal_description": "example string",
      "source_kind": "SCENARIO_SET_SOURCE_KIND_UNSPECIFIED",
      "spaces_key": "example string",
      "status": "SCENARIO_SET_STATUS_UNSPECIFIED",
      "updated_at": "2023-01-01T00:00:00Z",
      "workflow_uuid": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

More Information

See /v2/gen-ai/scenario_sets in the API reference for additional detail on responses, headers, parameters, and more.