Skip to main content
POST
/
agent
/
v1
/
run
Create run
curl --request POST \
  --url https://api.case.dev/agent/v1/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "<string>",
  "prompt": "<string>",
  "guidance": "<string>",
  "model": "<string>",
  "objectIds": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "agentId": "<string>",
  "status": "queued",
  "objectIds": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key starting with sk_case_

Body

application/json
​
agentId
string
required

ID of the agent to run

​
prompt
string
required

Task prompt for the agent

​
guidance
string | null

Additional guidance for this run

​
model
string | null

Override the agent default model for this run

​
objectIds
string[] | null

Scope this run to specific vault object IDs. The agent will only be able to access these objects during execution.

Response

Run created in queued state

​
id
string
​
agentId
string
​
status
enum<string>
Available options:
queued
​
objectIds
string[] | null
​
createdAt
string<date-time>