ai

Embed

<a href="https://hermeticor.com/docs/ref-ai"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/98a6220a-4faf-4bff-85cf-4938b3b52dbc/social-card.svg?v=3e7ae33eec8b" alt="ai" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/ai/settings

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "enabled": true,
  "model": "string",
  "enabledAt": "2024-01-01T00:00:00Z",
  "configured": true,
  "brandVoice": "string"
}

Schema

enabledbooleanrequired

modelstringrequired

enabledAtstringrequired

configuredbooleanrequired

brandVoicestringrequired

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

PUThttps://hermeticor.com/v1/ai/settings

Workspace opt-in / kill switch for AI assist (off by default)

Request body

application/json

enabledbooleanrequired

acknowledgeThirdPartyProcessingboolean

modelstring

{
  "enabled": true,
  "acknowledgeThirdPartyProcessing": true,
  "model": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/ai/settings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"acknowledgeThirdPartyProcessing":true,"model":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/ai/settings

4XX Default Response

Same as 4XX · GET /v1/ai/settings

5XX Default Response

Same as 4XX · GET /v1/ai/settings

GEThttps://hermeticor.com/v1/ai/usage

Parameters

fromstringqueryrequired

tostringqueryrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/ai/usage?from=<from>&to=<to>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "requests": 0,
  "inputTokens": 0,
  "outputTokens": 0,
  "byFeature": {}
}

Schema

requestsintegerrequired

inputTokensintegerrequired

outputTokensintegerrequired

byFeatureobjectrequired

4XX Default Response

Same as 4XX · GET /v1/ai/settings

5XX Default Response

Same as 4XX · GET /v1/ai/settings

POSThttps://hermeticor.com/v1/ai/subject-suggestions

Request body

application/json

bodystringrequired

countinteger

= 5

tonestring

{
  "body": "string",
  "count": 5,
  "tone": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/ai/subject-suggestions" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"string","count":5,"tone":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "suggestions": [
    "string"
  ],
  "draft": true,
  "model": "string"
}

Schema

suggestionsstring[]required

draftbooleanrequired

true

modelstringrequired

4XX Default Response

Same as 4XX · GET /v1/ai/settings

5XX Default Response

Same as 4XX · GET /v1/ai/settings

POSThttps://hermeticor.com/v1/ai/rewrite-tone

Request body

application/json

textstringrequired

tonestringrequired

{
  "text": "string",
  "tone": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/ai/rewrite-tone" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"string","tone":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "text": "string",
  "draft": true,
  "model": "string"
}

Schema

textstringrequired

draftbooleanrequired

true

modelstringrequired

4XX Default Response

Same as 4XX · GET /v1/ai/settings

5XX Default Response

Same as 4XX · GET /v1/ai/settings

POSThttps://hermeticor.com/v1/ai/translate

Request body

application/json

textstringrequired

targetLanguagestringrequired

{
  "text": "string",
  "targetLanguage": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/ai/translate" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"string","targetLanguage":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/ai/rewrite-tone

4XX Default Response

Same as 4XX · GET /v1/ai/settings

5XX Default Response

Same as 4XX · GET /v1/ai/settings

POSThttps://hermeticor.com/v1/ai/body-from-brief

Request body

application/json

briefstringrequired

tonestring

channelstring

email | sms = email

{
  "brief": "string",
  "tone": "string",
  "channel": "email"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/ai/body-from-brief" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"brief":"string","tone":"string","channel":"email"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/ai/rewrite-tone

4XX Default Response

Same as 4XX · GET /v1/ai/settings

5XX Default Response

Same as 4XX · GET /v1/ai/settings

PUThttps://hermeticor.com/v1/ai/brand-voice

Tone/style guide applied to every AI draft

Request body

application/json

brandVoicestringrequired

{
  "brandVoice": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/ai/brand-voice" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"brandVoice":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/ai/settings

4XX Default Response

Same as 4XX · GET /v1/ai/settings

5XX Default Response

Same as 4XX · GET /v1/ai/settings

POSThttps://hermeticor.com/v1/ai/segment-from-text

Draft a segment definition from a description; validated, never saved (create it through /v1/segments)

Request body

application/json

descriptionstringrequired

{
  "description": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/ai/segment-from-text" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"description":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "definition": {},
  "explanation": [
    "string"
  ],
  "draft": true,
  "model": "string"
}

Schema

definitionrequired

explanationstring[]required

draftbooleanrequired

true

modelstringrequired

4XX Default Response

Same as 4XX · GET /v1/ai/settings

5XX Default Response

Same as 4XX · GET /v1/ai/settings

POSThttps://hermeticor.com/v1/ai/schedule-from-text

Turn “next Tuesday at 9am” into one concrete send time for a preview; never schedules anything (use /v1/campaigns/{id}/schedule)

Request body

application/json

textstringrequired

timezonestringrequired

{
  "text": "string",
  "timezone": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/ai/schedule-from-text" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"string","timezone":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "localTime": "string",
  "iso": "string",
  "label": "string",
  "timezone": "string",
  "draft": true,
  "model": "string"
}

Schema

localTimestringrequired

isostringrequired

labelstringrequired

timezonestringrequired

draftbooleanrequired

true

modelstringrequired

4XX Default Response

Same as 4XX · GET /v1/ai/settings

5XX Default Response

Same as 4XX · GET /v1/ai/settings

POSThttps://hermeticor.com/v1/ai/first-line

Request body

application/json

prospectobjectrequired

Show child parameters

firstNamestring

companystring

titlestring

researchstringrequired

offerstring

{
  "prospect": {
    "firstName": "string",
    "company": "string",
    "title": "string"
  },
  "research": "string",
  "offer": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/ai/first-line" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prospect":{"firstName":"string","company":"string","title":"string"},"research":"string","offer":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/ai/rewrite-tone

4XX Default Response

Same as 4XX · GET /v1/ai/settings

5XX Default Response

Same as 4XX · GET /v1/ai/settings

Next part

Updated Nov 8, 2026

Was this page helpful?