ai-agents

Embed

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

DELETEhttps://hermeticor.com/v1/ai-agents/{id}/guidances/{guidanceId}

Parameters

idstringpathrequired

guidanceIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/ai-agents/{id}/guidances/{guidanceId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

PATCHhttps://hermeticor.com/v1/ai-agents/{id}/guidances/{guidanceId}

Parameters

idstringpathrequired

guidanceIdstringpathrequired

Request body

application/json

titlestring

bodystring

positioninteger

{
  "title": "string",
  "body": "string",
  "position": 0
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/ai-agents/{id}/guidances/{guidanceId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","body":"string","position":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "agentId": "string",
  "title": "string",
  "body": "string",
  "position": 0,
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

agentIdstringrequired

titlestringrequired

bodystringrequired

positionintegerrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

5XX Default Response

Same as 4XX · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

GEThttps://hermeticor.com/v1/ai-agents/items

Parameters

agentIdstringquery

statusstringquery

pending | sent | blocked | rejected | failed

profileIdstringquery

limitintegerquery

= 50

cursorstringquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/ai-agents/items" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "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"
    }
  ],
  "nextCursor": "string"
}

Schema

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

nextCursorstringrequired

4XX Default Response

Same as 4XX · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

5XX Default Response

Same as 4XX · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

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

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/ai-agents/items/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "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

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 · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

5XX Default Response

Same as 4XX · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

PATCHhttps://hermeticor.com/v1/ai-agents/items/{id}

Edit a pending draft before approving it

Parameters

idstringpathrequired

Request body

application/json

subjectstring

bodystring

{
  "subject": "string",
  "body": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/ai-agents/items/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject":"string","body":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/ai-agents/items/{id}

4XX Default Response

Same as 4XX · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

5XX Default Response

Same as 4XX · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

POSThttps://hermeticor.com/v1/ai-agents/items/{id}/decide

Approve (sends through consent and suppression; a blocked recipient ends as blocked) or reject (nothing is sent)

Parameters

idstringpathrequired

Request body

application/json

actionstringrequired

approve | reject

subjectstring

bodystring

{
  "action": "approve",
  "subject": "string",
  "body": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/ai-agents/items/{id}/decide" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"action":"approve","subject":"string","body":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/ai-agents/items/{id}

4XX Default Response

Same as 4XX · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

5XX Default Response

Same as 4XX · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

POSThttps://hermeticor.com/v1/ai-agents/items/bulk-decide

Request body

application/json

idsstring[]required

actionstringrequired

approve | reject

{
  "ids": [
    "string"
  ],
  "action": "approve"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/ai-agents/items/bulk-decide" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"],"action":"approve"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "done": 0,
  "failed": 0
}

Schema

doneintegerrequired

failedintegerrequired

4XX Default Response

Same as 4XX · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

5XX Default Response

Same as 4XX · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

POSThttps://hermeticor.com/v1/ai-agents/items/bulk-delete

Delete items from the feed; a deleted draft is never sent

Request body

application/json

idsstring[]required

{
  "ids": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/ai-agents/items/bulk-delete" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/ai-agents/items/bulk-decide

4XX Default Response

Same as 4XX · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

5XX Default Response

Same as 4XX · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

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

Parameters

daysintegerquery

= 30

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/ai-agents/{id}/analytics/summary" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "total": 0,
  "byStatus": {},
  "approvalRate": 0,
  "autoSent": 0,
  "byDay": [
    {
      "day": "string",
      "drafted": 0,
      "sent": 0,
      "rejected": 0
    }
  ]
}

Schema

totalintegerrequired

byStatusobjectrequired

approvalRatenumberrequired

autoSentintegerrequired

byDayobject[]required

Show child parameters

daystringrequired

draftedintegerrequired

sentintegerrequired

rejectedintegerrequired

4XX Default Response

Same as 4XX · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

5XX Default Response

Same as 4XX · DELETE /v1/ai-agents/{id}/guidances/{guidanceId}

Next part

Updated Nov 8, 2026

Was this page helpful?