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 '
{
"agentOId": "agent_123",
"email": "[email protected]",
"jobTitle": "Software Engineer",
"companyDomain": "<string>",
"companyName": "Example",
"firstName": "John",
"linkedInProfile": "https://www.linkedin.com/in/john-doe/",
"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": {
"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>"
},
"persona": {
"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>"
]
}
]
},
"oId": "<string>",
"name": "<string>",
"internalName": "Sally the Sales Leader",
"description": "<string>",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"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>"
}
}Enrich a Person
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 '
{
"agentOId": "agent_123",
"email": "[email protected]",
"jobTitle": "Software Engineer",
"companyDomain": "<string>",
"companyName": "Example",
"firstName": "John",
"linkedInProfile": "https://www.linkedin.com/in/john-doe/",
"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": {
"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>"
},
"persona": {
"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>"
]
}
]
},
"oId": "<string>",
"name": "<string>",
"internalName": "Sally the Sales Leader",
"description": "<string>",
"qualifyingQuestions": [
{
"question": "<string>",
"rationale": "<string>",
"fitType": "GOOD",
"weight": "MEDIUM",
"archivedAt": "<string>"
}
],
"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>"
}
}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"
Email of the person to enrich
Job title of the person to enrich
"Software Engineer"
Company domain of the person to enrich
Company name of the person to enrich
"Example"
First name of the person to enrich
"John"
LinkedIn profile of the person to enrich
"https://www.linkedin.com/in/john-doe/"
Runtime context
{ "user": { "oId": "user_123" } }Enrichment successful
Whether the operation was successful
true
Message
"Additional information"
Show child attributes
Show child attributes
Show child attributes
PRODUCT, SERVICE The internal name of the product
Key capabilities of the product
["Capability 1", "Capability 2"]The differentiated value of the product
[
"Differentiated Value 1",
"Differentiated Value 2"
]The status quo of the product
["Status Quo 1", "Status Quo 2"]The challenges addressed by the offering
["Challenge 1", "Challenge 2"]The customer benefits of the offering
["Benefit 1", "Benefit 2"]The internal name of the product
"Product Internal Name"
The description of the product
"Product Description"
The primary URL of the product
"https://www.product.com"
Show child attributes
The question to ask to qualify the entity
The rationale for the question as to why it helps qualify
The fit type of the question
GOOD, BAD "GOOD"
The weight of the question
LOW, MEDIUM, HIGH, INSTANT_QUALIFIER, INSTANT_DISQUALIFIER "MEDIUM"
The date and time the question was archived
LOW, MEDIUM, HIGH Show child attributes
Show child attributes
The internal name of the persona
The primary responsibilities of the persona
["Responsibility 1", "Responsibility 2"]The pain points of the persona
["Pain Point 1", "Pain Point 2"]The key concerns of the persona
["Concern 1", "Concern 2"]The key objectives of the persona
["Objective 1", "Objective 2"]The common job titles of the persona
["Job Title 1", "Job Title 2"]The reasons why the persona matters to us
["Reason 1", "Reason 2"]The reasons why we matter to this type of persona
["Reason 1", "Reason 2"]The internal name of the persona
"Sally the Sales Leader"
The description of the persona
Show child attributes
The question to ask to qualify the entity
The rationale for the question as to why it helps qualify
The fit type of the question
GOOD, BAD "GOOD"
The weight of the question
LOW, MEDIUM, HIGH, INSTANT_QUALIFIER, INSTANT_DISQUALIFIER "MEDIUM"
The date and time the question was archived
LOW, MEDIUM, HIGH Show child attributes
The internal name of the use case
"Use Case Internal Name"
The description of the use case
"Use Case Description"
The primary URL of the use case
"https://www.use-case.com"
Show child attributes
Summary
Scenarios
Desired Outcomes
Business Drivers
Scenarios
Desired Outcomes
LOW, MEDIUM, HIGH Show child attributes
LEGACY, SECTOR, SOLUTION, MILESTONE, PRACTITIONER, COMPETITIVE, ACCOUNT, CUSTOM LOW, MEDIUM, HIGH Show child attributes
LOW, MEDIUM, HIGH Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes