Skip to main content
POST
/
api
/
v2
/
agents
/
enrich-company
/
run
Enrich Company Agent
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",
  "runtimeContext": {
    "user": {
      "oId": "user_123"
    }
  }
}
'
{
  "_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>",
        "title": "<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>"
        ],
        "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>"
    }
  }
}

Authorizations

​
api_key
string
header
required

Body

application/json

Enrichment 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 enrich

Example:

"example.com"

​
companyName
string | null

Company name to enrich

Example:

"Example"

​
runtimeContext
any | null

Runtime context

Example:
{ "user": { "oId": "user_123" } }

Response

Enrichment successful

​
_metadata
object
required
​
found
boolean
required

Whether the operation was successful

Example:

true

​
message
string | null

Message

Example:

"Additional information"

​
data
object