Platform APISimulations

Create a simulation case

Create a new simulation case for a workspace.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired
Name of the simulation case.
promptstringRequired
Prompt used during the simulation case.
typeenumRequired
Simulation case type.
Allowed values:
success_criterialist of stringsRequired
Success criteria evaluated for the case.
call_success_typeenumRequired
Success logic for the case.
Allowed values:
suite_idstringOptionalformat: "uuid"
ID of the simulation suite to add this case to. Required for v2 simulation suites.
base_agent_idstring or nullOptional
Agent ID to base the generated case on.

Response

200
statusstring
Whether the request was successful.
responseobject

Errors

400
Bad Request Error
422
Unprocessable Entity Error