Skip to main content
POST
/
v1
/
scenarios
Create a scenario
curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/scenarios \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "intent": "<string>",
  "journey": "",
  "mock_world": {},
  "source": "manual",
  "source_brief": "<string>",
  "source_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tags": [
    "<string>"
  ],
  "agent_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "success_criteria": [
    {
      "description": "<string>"
    }
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "intent": "<string>",
  "journey": "<string>",
  "success_criteria": [
    {
      "description": "<string>"
    }
  ],
  "mock_world": {},
  "tags": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "source_brief": "<string>",
  "source_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_agent_name": "<string>",
  "source_persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_persona_name": "<string>",
  "agents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "created_by": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required
Required string length: 1 - 255
intent
string
required
Required string length: 1 - 500
journey
string
default:""
Maximum string length: 20000
mock_world
Mock World · object
source
enum<string>
default:manual
Available options:
manual,
drafted
source_brief
string | null
Maximum string length: 2000
source_agent_id
string<uuid> | null
source_persona_id
string<uuid> | null
tags
string[]
agent_ids
string<uuid>[]
success_criteria
SuccessCriterion · object[]

Response

Successful Response

id
string<uuid>
required
organization_id
string<uuid>
required
name
string
required
intent
string
required
journey
string
required
success_criteria
SuccessCriterion · object[]
required
mock_world
Mock World · object
required
source
enum<string>
required
Available options:
manual,
drafted
tags
string[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
source_brief
string | null
source_agent_id
string<uuid> | null
source_agent_name
string | null
source_persona_id
string<uuid> | null
source_persona_name
string | null
agents
ScenarioAgentRef · object[]
created_by
string | null