Skip to main content
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 '"<any>"'
{
  "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
  • Enrich Company
  • Enrich Person
  • Content Agent
  • Sequence Agent
  • Qualify Person Agent
  • Prospector Agent
  • Qualify Company Agent
  • Enrich Company
  • Enrich Person
  • Content Agent
  • Sequence Agent
  • Qualify Person Agent
  • Prospector Agent
  • Qualify Company Agent
  • Enrich Company
  • Enrich Person
  • Content Agent
  • Sequence Agent
  • Qualify Person Agent
  • Prospector Agent
  • Qualify Company Agent
  • Enrich Company
  • Enrich Person
  • Content Agent
  • Sequence Agent
  • Qualify Person Agent
  • Prospector Agent
  • Qualify Company Agent
  • Enrich Company
  • Enrich Person
  • Content Agent
  • Sequence Agent
  • Qualify Person Agent
  • Prospector Agent
  • Qualify Company Agent
  • Enrich Company
  • Enrich Person
  • Content Agent
  • Sequence Agent
  • Qualify Person Agent
  • Prospector Agent
  • Qualify Company Agent

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

​
agentOId
string
required

AgentOId is required when creating an agent in the application. You can find it in the Agents section of your dashboard. Agent OId

Example:

"ca_..."

​
callbackUrl
string<uri>
required

Callback URL

Example:

"https://example.com/api/callbacks/unique-id"

​
companyDomain
string | null

Company domain to enrich

Example:

"example.com"

​
companyName
string | null

Company name to enrich

Example:

"Example"

​
runtimeContext
any

Runtime context

​
experimentOId
string

Experiment OId

Example:

"ae_..."

Response

Agent data

​
status
enum<string>
required

Status

Available options:
pending,
completed,
failed
Example:

"pending"

​
requestId
string
required

Request ID

Example:

"requestId"

​
message
string | null

Message

Example:

"Additional information"

⌘I