Skip to main content
POST
/
agent
/
v1
/
run
curl -X POST "https://api.case.dev/agent/v1/run" \ -H "Authorization: Bearer $CASEDEV_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "agentId": "<string>", "prompt": "<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.

​
callbackUrl
string<uri> | null

HTTPS callback URL to receive a notification when the run completes. Registered atomically with the run — eliminates the race condition of calling /watch after /exec. Additional watchers can still be added via POST /run/:id/watch.

Response

Run created in queued state

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