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 '
{
"agentOId": "agent_123",
"companyDomain": "example.com",
"companyName": "<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>"
}
},
"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>"
}
},
"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>"
}
]
},
"annotations": {
"annotations": [
{
"type": "<string>",
"title": "<string>",
"meta": "<unknown>",
"description": "<string>",
"url": "<string>"
}
],
"metadata": "<unknown>"
}
}
}Determine if a company is qualified for a given Product and/or Segment
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 '
{
"agentOId": "agent_123",
"companyDomain": "example.com",
"companyName": "<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>"
}
},
"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>"
}
},
"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>"
}
]
},
"annotations": {
"annotations": [
{
"type": "<string>",
"title": "<string>",
"meta": "<unknown>",
"description": "<string>",
"url": "<string>"
}
],
"metadata": "<unknown>"
}
}
}Qualify input
AgentOId is required when creating an agent in the application. You can find it in the Agents section of your dashboard.
"agent_123"
Company domain to qualify
"example.com"
Company name to qualify
Runtime context for qualification