Give Feedback

dots.v2.genAi.scenario_library.get()

Generated on 27 Oct 2026 from DoTs version v1.21.0

Copy page as Markdown View page as Markdown

Usage

client.v2.genAi.scenario_library.get(requestConfiguration?: RequestConfiguration<Scenario_libraryRequestBuilderGetQueryParameters>): Promise<undefined | ApiListScenarioLibraryOutput>

Description

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

Parameters

page integer optional

Example: 1

Page number.

perPage integer optional

Example: 1

Items per page.

category string optional

Example: example string

Filter by category (exact match). Empty means no category filter.

search string optional

Example: example string

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

sortBy string optional

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.

One of: SCENARIO_LIBRARY_SORT_FIELD_UNSPECIFIED, SCENARIO_LIBRARY_SORT_FIELD_NAME, SCENARIO_LIBRARY_SORT_FIELD_CREATED_AT

Default: SCENARIO_LIBRARY_SORT_FIELD_UNSPECIFIED

sortDirection string optional

Sort direction. Defaults to ascending when unspecified.

One of: SORT_DIRECTION_UNSPECIFIED, SORT_DIRECTION_ASC, SORT_DIRECTION_DESC

Default: SORT_DIRECTION_UNSPECIFIED

Request Sample

Show Request Sample

import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import {
    createDigitalOceanClient,
    DigitalOceanApiKeyAuthenticationProvider,
} from "@digitalocean/dots";

const authProvider = new DigitalOceanApiKeyAuthenticationProvider(process.env.DIGITALOCEAN_TOKEN!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);

const response = await client.v2.genAi.scenario_library.get();

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 query parameter:

let response = await client.v2.genAi.scenario_library.get();
let pages = response?.links?.pages;

while (pages && "next" in pages && typeof pages.next === "string") {
    const page = Number(new URL(pages.next).searchParams.get("page"));
    response = await client.v2.genAi.scenario_library.get({
        queryParameters: {
            page,
        },
    });
    pages = response?.links?.pages;
}

Response Example

Show Response Example

{
  "available_categories": [
    "example string"
  ],
  "available_sort_by": [
    "SCENARIO_LIBRARY_SORT_FIELD_UNSPECIFIED"
  ],
  "available_sort_directions": [
    "SORT_DIRECTION_UNSPECIFIED"
  ],
  "links": {
    "pages": {
      "first": "example string",
      "last": "example string",
      "next": "example string",
      "previous": "example string"
    }
  },
  "meta": {
    "page": 123,
    "pages": 123,
    "total": 123
  },
  "scenarios": [
    {
      "category": "example string",
      "created_at": "2023-01-01T00:00:00Z",
      "description": "example string",
      "goal_description": "example string",
      "library_scenario_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "name": "example name",
      "scenario_count": 123,
      "status": "SCENARIO_LIBRARY_ENTRY_STATUS_UNSPECIFIED",
      "updated_at": "2023-01-01T00:00:00Z"
    }
  ]
}

More Information

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