ai-agents

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-ai-agents"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/d2fcd74d-2231-4e73-9386-48dce30182be/social-card.svg?v=3e7ae33eec8b" alt="ai-agents" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/ai-agents/{id}/leads

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/ai-agents/{id}/leads" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "profileId": "string",
      "profileEmail": "string",
      "items": 0,
      "lastStatus": "pending",
      "lastAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
profileIdstringrequired
profileEmailstringrequired
itemsintegerrequired
lastStatusstringrequired
pending | sent | blocked | rejected | failed
lastAtstringrequired
nextCursorstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/ai-agents/{id}/leads

GEThttps://hermeticor.com/v1/ai-agents/{id}/leads/{profileId}/research

What the agent knew about a lead when it wrote to them, and every proposal it made

Parameters

idstringpathrequired
profileIdstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/ai-agents/{id}/leads/{profileId}/research" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "profileId": "string",
  "research": "string",
  "items": [
    {
      "id": "string",
      "agentId": "string",
      "agentKind": "inbox_manager",
      "kind": "reply",
      "status": "pending",
      "profileId": "string",
      "profileEmail": "string",
      "refId": "string",
      "subject": "string",
      "body": "string",
      "reason": "string",
      "research": "string",
      "jobId": "string",
      "outcome": "string",
      "autoSent": true,
      "decidedBy": "string",
      "decidedAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ]
}
Schema
profileIdstringrequired
researchstringrequired
itemsItemsItem212[]required
Show child parameters
idstringrequired
agentIdstringrequired
agentKindstringrequired
inbox_manager | sales
kindstringrequired
reply | outreach
statusstringrequired
pending | sent | blocked | rejected | failed
profileIdstringrequired
profileEmailstringrequired
refIdstringrequired
subjectstringrequired
bodystringrequired
reasonstringrequired
researchstringrequired
jobIdstringrequired
outcomestringrequired
autoSentbooleanrequired
decidedBystringrequired
decidedAtstringrequired
createdAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/ai-agents/{id}/leads

5XX Default Response

Same as 4XX · GET /v1/ai-agents/{id}/leads

GEThttps://hermeticor.com/v1/ai-agents/{id}/opportunities

Where the leads a sales agent emailed stand now

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/ai-agents/{id}/opportunities" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "contacted": 0,
  "replied": 0,
  "interested": 0,
  "meetings": 0,
  "won": 0,
  "pipelineValueCents": 0
}
Schema
contactedintegerrequired
repliedintegerrequired
interestedintegerrequired
meetingsintegerrequired
wonintegerrequired
pipelineValueCentsintegerrequired
4XX Default Response

Same as 4XX · GET /v1/ai-agents/{id}/leads

5XX Default Response

Same as 4XX · GET /v1/ai-agents/{id}/leads

Updated