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>

POSThttps://hermeticor.com/v1/ai/reply-draft

Request body

application/json

threadobject[]required

Show child parameters

fromstringrequired

us | them

textstringrequired

goalstring

{
  "thread": [
    {
      "from": "us",
      "text": "string"
    }
  ],
  "goal": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/ai/reply-draft" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"thread":[{"from":"us","text":"string"}],"goal":"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

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/ai/reply-draft

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

Draft a flow from a prompt; validated with the workflow validator, never saved (create it through /v1/workflows)

Request body

application/json

descriptionstringrequired

{
  "description": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/ai/flow-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": {
    "graph": {
      "start": null,
      "nodes": [
        {
          "id": "string",
          "type": "send_email",
          "config": {
            "templateId": "string",
            "versionId": "string",
            "route": {
              "connectionId": "string",
              "poolId": "string",
              "routePolicyId": "string"
            },
            "topicId": "string",
            "replyToStep": "string",
            "onBlocked": "continue",
            "skipOnFailure": true,
            "skipIfMessagedWithinHours": 0,
            "filter": {
              "type": "group",
              "op": "and",
              "negate": true,
              "children": [
                {}
              ]
            },
            "retries": 0,
            "senderIdentityId": "string",
            "replyTo": "string",
            "oneClickUnsubscribe": true
          },
          "position": {
            "x": 0,
            "y": 0
          },
          "name": "string"
        }
      ],
      "edges": [
        {
          "id": "string",
          "source": "string",
          "sourceHandle": "string",
          "target": "string"
        }
      ]
    },
    "triggers": [
      {
        "type": "profile_created",
        "reentry": {
          "mode": "after_completion"
        }
      }
    ],
    "settings": {
      "purpose": "marketing",
      "mode": "journey",
      "filterCheck": "before_send",
      "filterFailAction": "exit",
      "profileFilter": {
        "type": "group",
        "op": "and",
        "negate": true,
        "children": [
          {}
        ]
      },
      "goal": {
        "kind": "event",
        "eventName": "string",
        "filter": {},
        "definition": {
          "type": "group",
          "op": "and",
          "negate": true,
          "children": [
            {}
          ]
        },
        "windowDays": 30,
        "onReach": "exit"
      },
      "quietHours": "inherit",
      "quietHoursAction": "wait",
      "sendWindow": {
        "startMin": 0,
        "endMin": 0,
        "weekdays": [
          0
        ]
      },
      "smartSending": {
        "skipIfMessagedWithinHours": 0,
        "frequencyCap": {
          "maxSends": 0,
          "windowHours": 0
        }
      },
      "enrollmentCap": {
        "maxTotal": 0,
        "maxConcurrent": 0
      },
      "activeWindow": {
        "from": "2024-01-01T00:00:00Z",
        "until": "2024-01-01T00:00:00Z"
      },
      "failureAlert": {
        "userIds": [],
        "emails": []
      },
      "timezoneSource": "profile",
      "timezone": "UTC",
      "exitOn": {
        "type": "group",
        "op": "and",
        "negate": true,
        "children": [
          {}
        ]
      },
      "sequence": {
        "steps": [],
        "schedule": {
          "weekdays": [
            1,
            2,
            3,
            4,
            5
          ],
          "startMin": 540,
          "endMin": 1020,
          "timezoneSource": "prospect",
          "timezone": "UTC"
        },
        "mailbox": {
          "sticky": true,
          "onUnavailable": "pause"
        },
        "dailyNewLimit": 0,
        "followUpPercent": 0,
        "plainTextOnly": true,
        "trackOpens": true,
        "unsubscribeText": "string",
        "spintaxMode": "random",
        "variables": {},
        "blocklist": {
          "emails": [],
          "domains": []
        },
        "reviewBeforeSend": true,
        "reviewEachMessage": true,
        "stop": {
          "onReply": "human",
          "onAutoReply": "continue",
          "onOoo": "pause_until_return",
          "onCompanyReply": "none"
        },
        "onCategory": [
          {
            "category": "positive",
            "sequenceId": "string",
            "stopCurrent": true
          }
        ],
        "ownerUserId": "string",
        "scheduleId": "string",
        "dedupe": {
          "crossSequence": "skip",
          "contactedWithinDays": 0,
          "domain": false
        },
        "startAt": "2024-01-01T00:00:00Z",
        "minGapMinutes": 0,
        "senderOverrides": {},
        "abm": {
          "maxPerAccount": 5,
          "onAccountReply": "stop"
        }
      }
    }
  },
  "validation": {
    "ok": true,
    "errors": [
      {
        "severity": "error",
        "code": "string",
        "message": "string",
        "nodeId": "string",
        "fix": "string"
      }
    ],
    "warnings": [
      {
        "severity": "error",
        "code": "string",
        "message": "string",
        "nodeId": "string",
        "fix": "string"
      }
    ]
  },
  "draft": true,
  "model": "string"
}

Schema

definitionobjectrequired

Show child parameters

graphobjectrequired

Show child parameters

startstringrequired

= null

nodesNodesItem2[]required

edgesEdgesItem2[]required

triggersTriggersItem2[]required

settingsobjectrequired

Show child parameters

purposestringrequired

marketing | prospecting | transactional | operational = marketing

modestringrequired

journey | sequence = journey

filterCheckstringrequired

entry | every_step | before_send = before_send

filterFailActionstringrequired

exit | skip = exit

profileFilterobject

goalobject

quietHoursstring | Windowrequired

= inherit

quietHoursActionstring

wait | skip | exit

sendWindowobject

smartSendingobject

enrollmentCapobject

activeWindowobject

failureAlertobject

timezoneSourcestringrequired

profile | workspace = profile

timezonestringrequired

= UTC

exitOnobject

sequenceobject

validationobjectrequired

Show child parameters

okbooleanrequired

errorsErrorsItem[]required

Show child parameters

severitystringrequired

error | warning

codestringrequired

messagestringrequired

nodeIdstring

fixstring

warningsErrorsItem[]required

Show child parameters

severitystringrequired

error | warning

codestringrequired

messagestringrequired

nodeIdstring

fixstring

draftbooleanrequired

true

modelstringrequired

4XX Default Response

Same as 4XX · POST /v1/ai/reply-draft

5XX Default Response

Same as 4XX · POST /v1/ai/reply-draft

POSThttps://hermeticor.com/v1/campaigns/{id}/ai-summary

A plain-language summary of the campaign report, written from its own figures only. Needs AI assist switched on; sends the figures (no recipient data) to the AI provider

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/ai/reply-draft

4XX Default Response

Same as 4XX · POST /v1/ai/reply-draft

5XX Default Response

Same as 4XX · POST /v1/ai/reply-draft

POSThttps://hermeticor.com/v1/commerce/stores/{id}/ai-summary

A plain-language summary of a store's orders and carts, written from its own totals only. Needs AI assist switched on; no customer data leaves

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/ai/reply-draft

4XX Default Response

Same as 4XX · POST /v1/ai/reply-draft

5XX Default Response

Same as 4XX · POST /v1/ai/reply-draft

POSThttps://hermeticor.com/v1/profiles/{id}/ai-commerce-summary

A plain-language read of one customer's buying behaviour (frequency, spend, top products, carts), from their order figures only. Needs AI assist switched on; no name, email or address leaves

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/ai/reply-draft

4XX Default Response

Same as 4XX · POST /v1/ai/reply-draft

5XX Default Response

Same as 4XX · POST /v1/ai/reply-draft

POSThttps://hermeticor.com/v1/commerce/orders/{id}/ai-summary

A plain-language status of one order (payment, fulfilment, refunds, contents). Needs AI assist switched on; the shipping address and links never leave

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/ai/reply-draft

4XX Default Response

Same as 4XX · POST /v1/ai/reply-draft

5XX Default Response

Same as 4XX · POST /v1/ai/reply-draft

Next part

Updated Nov 8, 2026

Was this page helpful?