Skip to main content
POST
/
api
/
v2
/
agents
/
qualify-company
/
run
Qualify Company Agent
curl --request POST \
  --url https://app.octavehq.com/api/v2/agents/qualify-company/run \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "companyDomain": "example.com",
  "companyName": "<string>",
  "runtimeContext": "<any>",
  "agentOId": "agent_123"
}'
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "found": true,
  "message": "Additional information",
  "data": {
    "company": {
      "name": "<string>",
      "description": "<string>",
      "domain": "<string>",
      "website": "<string>",
      "founded": 123,
      "location": {
        "region": "<string>",
        "locality": "<string>",
        "postalCode": "<string>",
        "countryCode": "<string>",
        "streetAddress": "<string>"
      },
      "employeeCount": 123,
      "followerCount": 123,
      "type": "<string>",
      "slug": "<string>",
      "logoUrl": "<string>",
      "countryCode": "<string>",
      "specialties": [
        "<string>"
      ],
      "industry": "<string>",
      "crunchBaseFunding": [
        {
          "fundingRoundCount": 123,
          "roundDate": "<string>",
          "roundName": "<string>",
          "investorNames": [
            "<string>"
          ],
          "investorCount": 123,
          "roundAmount": 123,
          "roundCurrency": "<string>"
        }
      ]
    },
    "score": 123,
    "rationale": "<string>",
    "product": {
      "message": "<string>",
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "qualification": {
        "answers": [
          {
            "answer": "<string>",
            "rationale": "<string>",
            "confidence": "LOW",
            "question": "<string>"
          }
        ],
        "score": 123,
        "rationale": "<string>"
      }
    },
    "segment": {
      "message": "<string>",
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "qualification": {
        "answers": [
          {
            "answer": "<string>",
            "rationale": "<string>",
            "confidence": "LOW",
            "question": "<string>"
          }
        ],
        "score": 123,
        "rationale": "<string>"
      }
    },
    "playbook": {
      "message": "<string>",
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "qualification": {
        "answers": [
          {
            "answer": "<string>",
            "rationale": "<string>",
            "confidence": "LOW",
            "question": "<string>"
          }
        ],
        "score": 123,
        "rationale": "<string>"
      }
    }
  }
}

Authorizations

api_key
string
header
required

Body

application/json

Qualify input

agentOId
string
required

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

Example:

"agent_123"

companyDomain
string | null

Company domain to qualify

Example:

"example.com"

companyName
string | null

Company name to qualify

runtimeContext
any

Runtime context for qualification

Response

Qualification successful

_metadata
object
required
found
boolean
required

Whether the operation was successful

Example:

true

message
string | null

Message

Example:

"Additional information"

data
object | null
I