Give Feedback

pydo.genai.create_scenario_set_from_library()

Generated on 1 Oct 2026 from pydo version v0.43.0

Copy page as Markdown View page as Markdown

Usage

client.genai.create_scenario_set_from_library(
    library_scenario_uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
    body={
        "library_scenario_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "name": "example name",
    },
)

Returns JSONRaises HttpResponseError

Description

To create a scenario set from a Common Scenario & Goal Library entry, send a POST request to /v2/gen-ai/scenario_library/{library_scenario_uuid}/create_scenario_set. The library scenarios are copied into a new scenario set owned by the calling team. The new set is ready to use when creating a simulation run.

Parameters

library_scenario_uuid string required

UUID of the library entry to copy.

library_scenario_uuid string optional

Example: 123e4567-e89b-12d3-a456-426614174000

UUID of the library entry to copy.

name string optional

Example: example name

Optional name for the new scenario set. Defaults to the library entry's
name when unset.

Request Sample

Show Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

req = {
  "library_scenario_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "example name"
}

resp = client.genai.create_scenario_set_from_library(library_scenario_uuid="\"123e4567-e89b-12d3-a456-426614174000\"", body=req)

Response Example

Show Response Example

{
  "scenario_set": {
    "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_library/{library_scenario_uuid}/create_scenario_set in the API reference for additional detail on responses, headers, parameters, and more.