OpenAPI 3.1.0raw.githubusercontent.com2026-08-19143194543.0 KB

879ca349c804

Scenarios

Get a scenario

One scenario's full read-only settings: model, system prompt, tool-approval policy, attached servers, and share link. A scenario that exists but belongs to a different project reads as 404 NOT_FOUND.

get/projects/{projectId}/scenarios/{scenarioId}

Path parameters

projectIdstring required

ID of the hosted project that contains the server.

scenarioIdstring required

Scenario ID, as returned by publishing an environment or by the project's scenario reads.

Response

The scenario settings.

idstring required

projectIdstring nullable

namestring required

descriptionstring nullable

mode'project_members' | 'invited_only' | 'anyone_with_link' | 'null' nullable

Who can use the scenario.

hostStylestring nullable

Chat surface style the scenario renders (e.g. claude, chatgpt).

hostIdstring nullable

The named host the scenario publishes (hosts and scenarios are 1:1).

hostNamestring nullable

serverCountinteger required

serverNamesstring[] required

createdAtnumber nullable

Unix epoch milliseconds.

updatedAtnumber nullable

Unix epoch milliseconds.

modelIdstring nullable

Model the scenario chats with.

systemPromptstring nullable

temperaturenumber nullable

requireToolApprovalboolean required