POST
/
api
/
v2
/
agents
/
enrich-person
/
run
Enrich Person Agent
curl --request POST \
  --url https://app.octavehq.com/api/v2/agents/enrich-person/run \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "email": "john.doe@example.com",
  "jobTitle": "Software Engineer",
  "companyDomain": "<string>",
  "companyName": "Example",
  "firstName": "John",
  "linkedInProfile": "https://www.linkedin.com/in/john-doe/",
  "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": {
    "product": {
      "oId": "<string>",
      "name": "<string>",
      "internalName": "Product Internal Name",
      "description": "Product Description",
      "primaryUrl": "https://www.product.com",
      "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>"
            ]
          }
        ]
      },
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ],
      "matchConfidence": "LOW",
      "matchAnalysis": "<string>"
    },
    "persona": {
      "oId": "<string>",
      "name": "<string>",
      "internalName": "Sally the Sales Leader",
      "description": "<string>",
      "data": {
        "internalName": "<string>",
        "primaryResponsibilities": [
          "Responsibility 1",
          "Responsibility 2"
        ],
        "painPoints": [
          "Pain Point 1",
          "Pain Point 2"
        ],
        "keyConcerns": [
          "Concern 1",
          "Concern 2"
        ],
        "keyObjectives": [
          "Objective 1",
          "Objective 2"
        ],
        "commonJobTitles": [
          "Job Title 1",
          "Job Title 2"
        ],
        "whyTheyMatterToUs": [
          "Reason 1",
          "Reason 2"
        ],
        "whyWeMatterToThem": [
          "Reason 1",
          "Reason 2"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ],
      "activeSequences": 123,
      "sentEmails": 123,
      "matchConfidence": "LOW",
      "matchAnalysis": "<string>"
    },
    "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>"
    },
    "references": [
      {
        "name": "",
        "oId": "<string>",
        "matchConfidence": "LOW",
        "matchAnalysis": "<string>",
        "howTheyUseProduct": "",
        "howTheyBenefitFromProduct": "",
        "howWeImpactedTheirBusiness": [],
        "keyStats": []
      }
    ],
    "valueProps": [
      {
        "oId": "<string>",
        "title": "<string>",
        "details": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "evidence": [
          "<string>"
        ]
      }
    ],
    "research": {
      "currentPosition": [
        "<string>"
      ],
      "previousPositions": [
        "<string>"
      ],
      "keyExpertise": [
        "<string>"
      ],
      "careerArc": [
        "<string>"
      ],
      "notableExperience": [
        "<string>"
      ],
      "keyFindings": [
        "<string>"
      ]
    },
    "companyResearch": [
      {
        "summary": [
          "<string>"
        ],
        "businessDescription": [
          "<string>"
        ],
        "businessCharacteristics": [
          "<string>"
        ],
        "businessEnvironment": [
          "<string>"
        ]
      }
    ],
    "profile": {
      "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>"
          }
        }
      ]
    },
    "jobFunction": "<string>",
    "seniority": "<string>"
  }
}

Authorizations

api_key
string
header
required

Body

application/json

Enrichment input

The body is of type object.

Response

200
application/json

Enrichment successful

The response is of type object.