Skip to main content
POST
/
api
/
v2
/
agents
/
qualify-person
/
run
Qualify Person Agent
curl --request POST \
  --url https://app.octavehq.com/api/v2/agents/qualify-person/run \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "agentOId": "agent_123",
  "email": "[email protected]",
  "jobTitle": "<string>",
  "companyDomain": "example.com",
  "companyName": "<string>",
  "firstName": "<string>",
  "linkedInProfile": "<string>",
  "runtimeContext": "<unknown>"
}
'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "found": true,
  "message": "Additional information",
  "data": {
    "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>"
      }
    },
    "persona": {
      "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>"
      }
    },
    "person": {
      "firstName": "<string>",
      "lastName": "<string>",
      "title": "<string>",
      "profileUrl": "<string>",
      "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>"
          }
        ]
      },
      "companyName": "<string>",
      "companyDomain": "<string>",
      "companyFoundedYear": 123,
      "companyEmployeeCount": 123,
      "companyDescription": "<string>",
      "headline": "<string>",
      "summary": "<string>",
      "slug": "<string>",
      "internalPictureUrl": "<string>",
      "countryCode": "<string>",
      "location": "<string>",
      "city": "<string>",
      "currentJobFunction": "<string>",
      "currentSeniority": "<string>",
      "followers": 123,
      "allPositionsCount": 123,
      "currentPositionsCount": 123,
      "positions": [
        {
          "companyName": "<string>",
          "title": "<string>",
          "summary": "<string>",
          "is_current": false,
          "startDate": "<string>",
          "endDate": "<string>",
          "seniority": "<string>",
          "jobFunction": "<string>",
          "company": {
            "name": "<string>",
            "domain": "<string>",
            "founded": 123,
            "employeeCount": 123,
            "description": "<string>",
            "location": {
              "region": "<string>",
              "locality": "<string>",
              "postalCode": "<string>",
              "countryCode": "<string>",
              "streetAddress": "<string>"
            },
            "slug": "<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"

​
email
string | null

Email of the person to qualify

Example:

"[email protected]"

​
jobTitle
string | null

Job title of the person to qualify

​
companyDomain
string | null

Company domain of the person to qualify

Example:

"example.com"

​
companyName
string | null

Company name of the person to qualify

​
firstName
string | null

First name of the person to qualify

​
linkedInProfile
string | null

LinkedIn profile of the person to qualify

​
runtimeContext
any | null

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