Formend API
Formend continuously evaluates customer support conversations, identifies operational risks, scores interactions, and escalates failures to supervisors in real time.
The API is REST-based, returns JSON, and authenticates via Bearer token. A developer with an API key can send a conversation and receive a risk assessment in under 300ms.
API Keys
All requests require a Bearer token in the Authorization header. Your API key is issued when you subscribe and can be found in your welcome email.
Key rotation
To rotate your API key, contact hello@formend.tech. Enterprise clients can request programmatic key management.
Analyze Conversation
The primary endpoint. Send a customer message and agent response — Formend returns a risk score, status, and any identified issues.
Request
| Field | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | Yes | Unique identifier for the conversation |
| agent_id | string | No | Agent identifier for tracking purposes |
| customer_message | string | Yes | The customer's inbound message |
| agent_response | string | Yes | The agent's reply to evaluate |
Response
| Field | Type | Description |
|---|---|---|
| score | integer | 0–100. Lower scores indicate higher risk. |
| status | string | ok · warning · critical |
| issues | array | List of identified issues. Empty if none. |
| escalate | boolean | Whether a supervisor alert has been triggered. |
Batch Analysis
Submit multiple conversations in a single request. Designed for historical ticket reviews, CRM imports, and Zendesk exports.
Maximum batch size is 100 conversations per request.
Webhook Configuration
Formend can POST event payloads to any HTTPS endpoint you control. To register a webhook, contact hello@formend.tech with your endpoint URL.
Supported events
| Event | Description |
|---|---|
| analysis.completed | A conversation has been scored successfully. |
| analysis.failed | A conversation could not be processed. |
| escalation.created | A supervisor alert has been triggered. |
| escalation.closed | A supervisor has marked an escalation resolved. |
Example payload
All webhook requests include a X-Formend-Signature header for payload verification. Respond with HTTP 200 to acknowledge receipt.
Error Handling
All errors return a JSON object with an error field and an appropriate HTTP status code.
| Status | Error | Description |
|---|---|---|
| 401 | invalid_api_key | API key is missing or invalid. |
| 422 | missing_required_field | A required field is absent from the request. |
| 429 | rate_limit_exceeded | Monthly analysis limit reached for your tier. |
| 500 | internal_error | An unexpected error occurred. Contact support. |
Rate Limits
Limits are applied per billing cycle. When the monthly limit is reached, the API returns a 429 rate_limit_exceeded response.
| Plan | Monthly analyses | Per-minute limit |
|---|---|---|
| Starter | 3,000 | 10 / min |
| Growth | 12,000 | 30 / min |
| Enterprise | Custom | Custom |
To upgrade your plan or discuss enterprise volume, contact info@formend.tech.