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>

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

Whether agents can run: operator switch and workspace AI opt-in

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "operatorEnabled": true,
  "workspaceEnabled": true,
  "available": true
}

Schema

operatorEnabledbooleanrequired

workspaceEnabledbooleanrequired

availablebooleanrequired

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

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

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "kind": "inbox_manager",
      "name": "string",
      "enabled": true,
      "autoSend": true,
      "config": {},
      "lastRunAt": "2024-01-01T00:00:00Z",
      "lastError": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem210[]required

Show child parameters

idstringrequired

kindstringrequired

inbox_manager | sales

namestringrequired

enabledbooleanrequired

autoSendbooleanrequired

configobjectrequired

lastRunAtstringrequired

lastErrorstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/ai-agents/status

5XX Default Response

Same as 4XX · GET /v1/ai-agents/status

POSThttps://hermeticor.com/v1/ai-agents

Create an agent. It starts switched off and review-only

Request body

application/json

Example

{
  "kind": "inbox_manager",
  "name": "string",
  "config": {
    "categories": [
      "positive",
      "neutral",
      "meeting"
    ],
    "goal": "string",
    "signature": "string"
  }
}

Option 1

kindstringrequired

inbox_manager

namestringrequired

configobjectrequired

Show child parameters

categoriesstring[]

= ["positive","neutral","meeting"]

goalstring

signaturestring

{
  "kind": "inbox_manager",
  "name": "string",
  "config": {
    "categories": [
      "positive",
      "neutral",
      "meeting"
    ],
    "goal": "string",
    "signature": "string"
  }
}

Option 2

kindstringrequired

sales

namestringrequired

configobjectrequired

Show child parameters

offerstringrequired

audiencestring

connectionIdstringrequired

dailyLimitinteger

= 10

researchFieldstring

{
  "kind": "sales",
  "name": "string",
  "config": {
    "offer": "string",
    "audience": "string",
    "connectionId": "string",
    "dailyLimit": 10,
    "researchField": "string"
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/ai-agents" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"inbox_manager","name":"string","config":{"categories":["positive","neutral","meeting"],"goal":"string","signature":"string"}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "kind": "inbox_manager",
  "name": "string",
  "enabled": true,
  "autoSend": true,
  "config": {},
  "lastRunAt": "2024-01-01T00:00:00Z",
  "lastError": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

kindstringrequired

inbox_manager | sales

namestringrequired

enabledbooleanrequired

autoSendbooleanrequired

configobjectrequired

lastRunAtstringrequired

lastErrorstringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/ai-agents/status

5XX Default Response

Same as 4XX · GET /v1/ai-agents/status

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/ai-agents

4XX Default Response

Same as 4XX · GET /v1/ai-agents/status

5XX Default Response

Same as 4XX · GET /v1/ai-agents/status

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/ai-agents/status

5XX Default Response

Same as 4XX · GET /v1/ai-agents/status

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

Rename, switch on or off, turn auto-send on or off, or change its settings

Parameters

idstringpathrequired

Request body

application/json

namestring

enabledboolean

autoSendboolean

configobject

{
  "name": "string",
  "enabled": true,
  "autoSend": true,
  "config": {}
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/ai-agents/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","enabled":true,"autoSend":true,"config":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/ai-agents

4XX Default Response

Same as 4XX · GET /v1/ai-agents/status

5XX Default Response

Same as 4XX · GET /v1/ai-agents/status

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

Run the agent now instead of waiting for its next pass. Drafts go to the review feed unless auto-send is on

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "drafted": 0,
  "sent": 0,
  "blocked": 0,
  "skipped": 0
}

Schema

draftedintegerrequired

sentintegerrequired

blockedintegerrequired

skippedintegerrequired

4XX Default Response

Same as 4XX · GET /v1/ai-agents/status

5XX Default Response

Same as 4XX · GET /v1/ai-agents/status

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

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}/guidances" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

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

Schema

itemsItemsItem211[]required

Show child parameters

idstringrequired

agentIdstringrequired

titlestringrequired

bodystringrequired

positionintegerrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/ai-agents/status

5XX Default Response

Same as 4XX · GET /v1/ai-agents/status

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

Add a guidance rule (at most 10 per agent)

Parameters

idstringpathrequired

Request body

application/json

titlestringrequired

bodystringrequired

positioninteger

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

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

201 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 · GET /v1/ai-agents/status

5XX Default Response

Same as 4XX · GET /v1/ai-agents/status

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

Parameters

idstringpathrequired

guidanceIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/ai-agents/{id}/guidances

4XX Default Response

Same as 4XX · GET /v1/ai-agents/status

5XX Default Response

Same as 4XX · GET /v1/ai-agents/status

Next part

Updated Nov 8, 2026

Was this page helpful?