curl --request POST \
--url https://app.octavehq.com/api/v2/agents/enrich-company/run \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"agentOId": "agent_123",
"companyDomain": "example.com",
"companyName": "Example",
"crmAccountId": "<string>",
"runtimeContext": {
"user": {
"oId": "user_123"
}
},
"includeFullAnnotation": true
}
'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"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>"
}
]
},
"product": {
"data": {
"type": "PRODUCT",
"internalName": "<string>",
"summary": "<string>",
"capabilities": [
"Capability 1",
"Capability 2"
],
"differentiatedValue": [
"Differentiated Value 1",
"Differentiated Value 2"
],
"statusQuo": [
"Status Quo 1",
"Status Quo 2"
],
"challengesAddressed": [
"Challenge 1",
"Challenge 2"
],
"customerBenefits": [
"Benefit 1",
"Benefit 2"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"oId": "<string>",
"name": "<string>",
"internalName": "Product Internal Name",
"description": "Product Description",
"primaryUrl": "https://www.product.com",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"research": {
"summary": [
"<string>"
],
"businessDescription": [
"<string>"
],
"businessCharacteristics": [
"<string>"
],
"businessEnvironment": [
"<string>"
]
},
"valueProps": [
{
"oId": "<string>",
"name": "<string>",
"details": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"evidence": [
"<string>"
]
}
],
"references": [
{
"name": "",
"oId": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>",
"howTheyUseProduct": "",
"howTheyBenefitFromProduct": "",
"howWeImpactedTheirBusiness": [],
"keyStats": []
}
],
"useCase": {
"oId": "<string>",
"name": "<string>",
"internalName": "Use Case Internal Name",
"description": "Use Case Description",
"primaryUrl": "https://www.use-case.com",
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"businessImpact": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"playbook": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"type": "LEGACY",
"keyInsight": [
"<string>"
],
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"annotations": {
"annotations": [
{
"type": "<string>",
"title": "<string>",
"meta": null,
"description": "<string>",
"url": "<string>"
}
],
"metadata": null
},
"customTask": {
"content": "<unknown>",
"error": "<string>"
}
}
}Enrich a company
curl --request POST \
--url https://app.octavehq.com/api/v2/agents/enrich-company/run \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"agentOId": "agent_123",
"companyDomain": "example.com",
"companyName": "Example",
"crmAccountId": "<string>",
"runtimeContext": {
"user": {
"oId": "user_123"
}
},
"includeFullAnnotation": true
}
'{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"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>"
}
]
},
"product": {
"data": {
"type": "PRODUCT",
"internalName": "<string>",
"summary": "<string>",
"capabilities": [
"Capability 1",
"Capability 2"
],
"differentiatedValue": [
"Differentiated Value 1",
"Differentiated Value 2"
],
"statusQuo": [
"Status Quo 1",
"Status Quo 2"
],
"challengesAddressed": [
"Challenge 1",
"Challenge 2"
],
"customerBenefits": [
"Benefit 1",
"Benefit 2"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"oId": "<string>",
"name": "<string>",
"internalName": "Product Internal Name",
"description": "Product Description",
"primaryUrl": "https://www.product.com",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"research": {
"summary": [
"<string>"
],
"businessDescription": [
"<string>"
],
"businessCharacteristics": [
"<string>"
],
"businessEnvironment": [
"<string>"
]
},
"valueProps": [
{
"oId": "<string>",
"name": "<string>",
"details": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"evidence": [
"<string>"
]
}
],
"references": [
{
"name": "",
"oId": "<string>",
"matchConfidence": "LOW",
"matchAnalysis": "<string>",
"howTheyUseProduct": "",
"howTheyBenefitFromProduct": "",
"howWeImpactedTheirBusiness": [],
"keyStats": []
}
],
"useCase": {
"oId": "<string>",
"name": "<string>",
"internalName": "Use Case Internal Name",
"description": "Use Case Description",
"primaryUrl": "https://www.use-case.com",
"data": {
"summary": "<string>",
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"businessDrivers": [
"<string>"
],
"businessImpact": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
]
},
"scenarios": [
"<string>"
],
"desiredOutcomes": [
"<string>"
],
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"playbook": {
"oId": "<string>",
"name": "<string>",
"description": "<string>",
"type": "LEGACY",
"keyInsight": [
"<string>"
],
"matchConfidence": "LOW",
"matchAnalysis": "<string>"
},
"annotations": {
"annotations": [
{
"type": "<string>",
"title": "<string>",
"meta": null,
"description": "<string>",
"url": "<string>"
}
],
"metadata": null
},
"customTask": {
"content": "<unknown>",
"error": "<string>"
}
}
}Documentation Index
Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt
Use this file to discover all available pages before exploring further.
Enrichment 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 enrich
"example.com"
Company name to enrich
"Example"
Runtime context
{ "user": { "oId": "user_123" } }If true, returns full annotation data including metadata. If false or omitted (default), returns minimal annotations to reduce response size.