POST
/
api
/
v2
/
async
/
agent
/
run
Run Agent
curl --request POST \
  --url https://app.octavehq.com/api/v2/async/agent/run \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "companyDomain": "example.com",
  "companyName": "Example",
  "runtimeContext": "<any>",
  "agentOId": "ca_...",
  "callbackUrl": "https://example.com/api/callbacks/unique-id",
  "experimentOId": "ae_..."
}'
{
  "status": "pending",
  "message": "Additional information",
  "requestId": "requestId"
}

Authorizations

​
api_key
string
header
required

Headers

​
x-request-source
string

Optional header used to identify the source of the request. Helps us apply appropriate rate limiting or disable it when necessary.

Example:

"some-source"

​
x-external-request-id
string

External Request ID. Add this header to identify the request from the client for better tracking and debugging.

Example:

"external-request-id"

Body

application/json

Run agent by given input, the input is different for each agent

Response

200
application/json

Agent data

The response is of type object.