> ## Documentation Index > Fetch the complete documentation index at: https://flow.engineer/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get a test key without an account > Creates a new app with a `fk_test_` key, without an account or sign-in. This is the first call for an AI coding agent that has no key: no API key is sent, and the answer holds everything needed to start (the key, the sandbox senders with their links and the app's join message). The key and the `claim_token` are shown **once**: save both. The app has a sandbox allowance of 1 contact and 50 messages sent in total on the Telegram sandbox, and WhatsApp's when it opens (inbound messages are free; iMessage is not included), and its keys **expire after 7 days**. After expiry the keys stop working and the contact is removed from the sandbox; a person can still claim the app. To keep the app, a person signs in through the device flow with the `claim_token` (`POST /v0/device/authorizations`), or opens `claim_url` in a browser. The app then shares the person's signed-in allowance (3 contacts and 100 messages each, one allowance per person over all their apps). A claim through `claim_url` revokes this key unless the person chooses to keep their agent's key working; a device sign-in replaces it with a new key. Calls are limited per client address, per network (/24, /64) and wider network (/16, /48), and service-wide per day; going over answers `429 rate_limited` with `retry_after`. Do not call this when you already have a key: check `FLOW_MESSAGING_KEY` first, and reuse the key you saved. ## OpenAPI ````yaml unified-messaging-api/openapi.yaml POST /v0/sandbox/keys openapi: 3.1.0 info: title: Flow Messaging API version: 2026-11-01 summary: Two-way messaging for AI agents on WhatsApp, Telegram and iMessage. description: | Flow Messaging lets an AI agent hold conversations with people on **WhatsApp**, **Telegram** and **iMessage** through one HTTP API, and on **SMS and MMS in the US** (in pilot: dedicated numbers arranged with the Flow team). Flow hosts the senders (bots, numbers and lines), receives every inbound message, and passes every send through one gate that enforces each channel's rules. You never handle vendor keys or channel webhooks. Channels today: Telegram is live. iMessage is live on lines the Flow team connects to your app: it replies to people who write first, in one-to-one conversations and in group chats people add the line to; writing first is available on request on dedicated lines (`Sender.imessage.can_initiate`). WhatsApp numbers are connected by the Flow team too, either a number Flow provides or one in your business's own WhatsApp Business Account, and the WhatsApp-only parts (templates, the 24-hour window) apply on them; the shared WhatsApp sandbox is not open yet. This API is in **beta**: the shape may still change before it is declared stable. Changes are released as new dated versions (see Versioning). ## Concepts - An **app** is one agent integration. It owns API keys, webhook endpoints and settings, and has a test mode and a live mode. - A **sender** is what your agent talks *from*: a Telegram bot, a WhatsApp number, an iMessage line or a US SMS number. Shared sandbox senders serve many apps; dedicated senders are yours alone. - A **contact** is a person on one channel. There is no cross-channel identity: a contact on Telegram and a contact on WhatsApp are different contacts, even if they are the same person. Never assume a contact has a phone number. - A **conversation** is one sender talking with one contact (`type` `direct`), or, on iMessage, with a group chat the line was added to (`type` `group`, see Groups). You reply into a conversation; you never pick a channel per message. - A **message** is one **kind**: `basic` (text, or media with a caption), `voice`, `buttons`, `list`, `carousel`, `template`, `contact_card`, `location`, `effect`, `reaction`, and more (see `MessageKind`). Each kind you can send has its own endpoint, named after it (`POST /v0/conversations/{conversation_id}/basic`, `/buttons`, ...), whose page opens with the channels it works on. The same kind objects describe what you receive (`Message.content`, with `kind`). - An **event** is one entry in your app's ordered log. Everything you receive (inbound messages, delivery statuses, reactions, sender changes) is an event, delivered by webhook, by the live stream (`GET /v0/stream`) and by polling (`GET /v0/events`). ## Authentication Every request carries an API key as a bearer token: ``` Authorization: Bearer fk_live_... ``` Keys belong to one app and one mode. `fk_test_` keys see only sandbox senders and test data, and nothing they send reaches a real contact unless that contact joined the sandbox. `fk_live_` keys reach real contacts through your dedicated senders. A key is shown once when it is created and stored only as a hash. Keys are never accepted in the query string. The live stream (`GET /v0/stream`) also takes the key as a WebSocket subprotocol, for browsers, which cannot set headers on a WebSocket (see that endpoint). ### No key yet? Get one in one call Anyone, including an AI coding agent, can get a test key without signing up: ``` curl -X POST https://api.flow.engineer/v0/sandbox/keys ``` The answer (`SandboxKey`) holds a `fk_test_` key for a new app of its own, shown once, and the sandbox senders with the links and join message a person uses to join it. Save the key (for example as `FLOW_MESSAGING_KEY`) and the `claim_token`. This key needs no account and has a **sandbox allowance**: 1 contact and 50 messages sent in total on the Telegram sandbox (and WhatsApp's when it opens), and it **expires after 7 days**. Only messages your agent sends count; inbound messages are free. iMessage is not part of the allowance. To keep the app, a person signs in with a Flow account (flow.engineer) through the device flow: the agent or the CLI (`npx @flow-engineer/messaging login`) calls `POST /v0/device/authorizations` with the `claim_token`, shows the person the `verification_uri` and `user_code` (they type the code on that page), and polls `POST /v0/device/token` until it returns a key. The app is claimed: its data and keys are kept, its keys no longer expire, and it moves under the person's signed-in allowance of 3 contacts and 100 messages each, **one allowance per person, shared by every app they own or claim** (a person may claim up to 10 apps). `GET /v0/app` shows what is left of the allowance (`allowance`). When it runs out, sends answer `403 permission` with `channel_code` `sandbox_allowance_used`. The apps of your own account get the free trial instead, started at your first sign-in: 25 people per channel on Flow's shared Telegram, WhatsApp and iMessage senders, over all the account's apps (their `allowance` is absent). ## Versioning The API is versioned by date. Send `Flow-Version: 2026-11-01` to choose a version; without the header, the version pinned to your app when it was created is used. Responses echo the version that served them in `Flow-Version`. Every path starts with `/v0`: this is API V0, the shape before the stable release. `/v1` is kept for that release, version 1.0, after which the shape is frozen. ## Idempotency Every `POST` that takes an API key accepts an `Idempotency-Key` header (any unique string up to 255 characters; a UUID or ULID is a good choice); the onboarding calls `POST /v0/sandbox/keys`, `POST /v0/device/authorizations` and `POST /v0/device/token` ignore it. Keys are kept for 24 hours per app and mode. Repeating a request with the same key returns the first answer, with the header `Idempotent-Replayed: true`, and does not act twice. Otherwise a key already used answers `409 idempotency_conflict`, and its `channel_code` says which case it is: - `body_mismatch`: the key was used with a different method, path or body. Use a new key for a new request; do not retry. - `in_progress`: the first request with this key is still running. Wait `retry_after` seconds and repeat the identical request with the same key to get its answer. - `secret_not_kept`: the first request went through, but its answer carried a secret shown only once (creating a webhook endpoint, rotating its secret, connecting a WhatsApp number), so that answer was not kept. Answers that are worth retrying (`429`, `500`, `502`, `503`, `504`) are not kept, so a retry with the same key runs again. ## Errors Errors share one shape: ```json {"error": { "type": "unsupported_content", "channel": "telegram", "param": "kind", "message": "Carousels work on WhatsApp only.", "hint": "On Telegram, send a basic message, then one buttons message with an image header per card.", "doc_url": "https://api.flow.engineer/docs/errors/unsupported_content", "conversation": "conv_01JB..."}} ``` `error.type` is a closed list (see the `ErrorType` schema); switch on it, not on the message text. Every error carries `hint`, one sentence saying what to change for this case, and `doc_url`, the page for its type (`https://api.flow.engineer/docs/errors/`: what it means, why it happens, how to fix it, with code). Errors that can be retried carry `retry_after` in seconds. Coding agents can act on `hint` directly; the MCP tool `explain_error` returns the page for a type. ## Pagination Lists are paged with cursors. Pass `limit` (1 to 100, default 20) and either `after` or `before`, set to the ID of an item you already have. IDs are prefixed ULIDs, so they sort by creation time. The event log (`GET /v0/events`) is oldest first, so `after` moves forward in time; every other list is newest first, so `after` moves back in time. A list answer says `has_more` when more items lie in that direction. ## Rate limits Requests are limited per key. Every answer carries `RateLimit-Limit`, `RateLimit-Remaining` and `RateLimit-Reset`. Sends are also paced per sender by the send gate (see below): each sender has a sending rate it may not exceed. Going over either limit answers `429` with type `rate_limited`, a `Retry-After` header and `error.retry_after` in seconds; wait that long and retry with the same `Idempotency-Key`. The send gate also answers `429` with type `new_contact_limit` when a sender has used its budget for starting conversations. ## The send gate Every send (HTTP, the stream, or a reply in a webhook response) passes the same gate, which also refuses what the channel does not take (see "Exact or 422"): - **WhatsApp**: free-form messages only while the contact's last message is less than 24 hours old (the window); otherwise only a `template` (`409 outside_window`). - **iMessage**: a line may only reply unless it can start conversations (`Sender.imessage.can_initiate`, available on request on dedicated lines); a new conversation from a reply-only line is refused (`403 permission`). A line that can start conversations spends the sender's new-contact budget, with a warm-up curve, and a contact who has never messaged the line (or opted in) gets a `message.failed` event with `outside_window`. Group conversations always begin with the group writing; a start never makes one. - **Telegram**: the contact must have started the bot; Telegram enforces this. - **SMS (US, in pilot)**: a conversation starts only with a contact who texted one of your numbers before, or whose consent you record with the start (`consent` on `POST /v0/messages`); otherwise `403 permission` with `channel_code` `consent_required`. A contact who texts STOP (or STOPALL, UNSUBSCRIBE, CANCEL, END, QUIT, REVOKE, OPT OUT, OPTOUT) is opted out of every SMS sender of your app at once: sends to them answer `403 permission` with `channel_code` `contact_opted_out`, and messages already queued fail the same way, until they text START (or UNSTOP, YES) to a number they opted out through (carriers and providers block per number, so START to another of your numbers changes nothing). HELP (or INFO) gets the sender's help reply. Flow answers these keywords itself, and you still receive the message as `message.received`. The contact's `opted_out_at` shows the state. Messages to a contact who has not texted in the last hour respect the sender's quiet hours (`Sender.sms.quiet_hours`, by default 21:00 to 08:00 in the contact's time zone, worked out from the area code): inside them a send answers `409 outside_window` with `channel_code` `quiet_hours` and `retry_after` set to when they end; a message that waited in the queue into the quiet hours is held until they end, not sent at night. - **HIPAA accounts** (`Account.hipaa`): only channels under a business associate agreement carry messages (SMS). Sends, typing and read receipts on Telegram, WhatsApp and iMessage, and connecting senders there, answer `403 permission` with `channel_code` `hipaa_channel_not_covered`; messages already queued there fail the same way. Contacts get a fixed refusal from the sandbox senders instead of reaching the app, and nothing they send there is stored or delivered. Simulated conversations (`POST /v0/test/conversations`) follow the same rule: only SMS can be simulated. - **Sandbox senders**: only contacts who joined through your app (by sending its join message, for example `Hi Sandbox app (ref brave-otter-40718263)`, or by opening its Telegram link). Starting a conversation spends budget per sender (new contacts per day and per hour, with a warm-up curve for new lines) and per plan. When abuse signals trip (the same text to many new contacts, many starts with no reply, blocks, a drop in WhatsApp quality) the sender is throttled and you receive `sender.status_changed`: until the sender's `throttled_until`, starts fail with `429 sender_throttled`, while replies into existing conversations still go. The sender recovers by itself, with another `sender.status_changed`. ## Groups (iMessage) When someone adds one of your dedicated iMessage lines to a group chat (Flow's shared iMessage line ignores group chats), the group is one conversation with `type` `group`. It has no `contact`; `group` lists the participants (`participants`, each a Flow contact on the channel, made the first time Flow sees them) and the group's name when it has one. Every inbound message carries `from`, the contact who wrote it. Participants who join or leave change the list without an event: read the conversation (`GET /v0/conversations/{conversation_id}`) for the current list. Reply with the normal sends (`POST /v0/conversations/{conversation_id}/basic` and the other kinds' endpoints). Basic messages (with `imessage.styles`, `imessage.subject` and `link_preview`), voice notes, effects, `reply_to`, edits and unsends work in groups. Groups take no reactions, typing indicator or read receipts from your line: each answers `422 unsupported_content` with `param` `kind` and `channel_code` `group_unsupported`, and nothing is sent. Dedicated iMessage lines receive and reply in groups; Flow's shared iMessage line ignores group chats. A group cannot be started, renamed, or have people added or removed through the API. ## Exact or 422 What you send is what the contact gets. Each endpoint's page opens with the channels it works on and their limits; a send of a kind, a field, a channel block or a value the conversation's channel does not take fails with `422 unsupported_content` and sends nothing. `param` names what was refused (`kind`, a field such as `reply_to` or `telegram.is_big`, or a value's field such as `emoji`), `channel` the conversation's channel, and `hint` what to send instead over plain HTTP (for example, for a carousel on Telegram, a basic message, then one buttons message with an image header per card). Flow never converts a message into another kind, never drops a field, and never answers `2xx` for something it did not send. Fields that only one channel has sit in a block named after it (`telegram`, `imessage`), typed per endpoint; an unknown key in a block, or an unknown field, is refused with `400 invalid_request` naming it, and so is a read-only field Flow fills on received messages (such as `media.mime_type` or a voice note's `transcript`). `text` is sent exactly as written on every channel: Flow does not read markdown, strip marks or warn. Style it in the channel's own terms: `telegram.parse_mode`, `imessage.styles`; WhatsApp's app reads its own `*bold*` and `_italic_`. With `telegram.parse_mode`, Telegram's length limits count the text after its tags or marks are parsed, as Telegram counts them, so a styled text may be longer than the limit before parsing. ## Order and duplicates Sends to one conversation go out in the order Flow accepted them, one at a time, across every endpoint, webhook replies and the stream. A message sent as several (a text and one message per card) arrives in the order you sent the calls. Give each call its own `Idempotency-Key` (for example `evt_123:card:2` for the second card answering event `evt_123`): a retry with the same key never sends twice (see Idempotency). A `422` answer is kept under its key like any other, so a message you send instead of a refused one (a `basic` after a `buttons` came back `422`) is a new request with a new key: add what it is to the refused one's key, such as `evt_123:card:2:basic`. ## Webhooks Register endpoints with `POST /v0/webhook_endpoints`. Each event is `POST`ed as JSON (the `event` webhook below), in order per conversation, and signed: ``` Flow-Signature: t=1791763200,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd ``` `v1` is the lowercase hex HMAC-SHA256, keyed with the endpoint's signing secret (`whsec_...`), of the string `t.{t}.{body}`: the letter `t`, a dot, the timestamp from the header, a dot, and the raw request body exactly as received. Compare in constant time and reject timestamps more than 5 minutes from your clock. While a secret is being rotated (`POST /v0/webhook_endpoints/{webhook_endpoint_id}/rotate_secret`), the header carries one `v1` per active secret; accept the request if any of them matches. Answer `2xx` within 10 seconds. To reply at once, answer a `message.received` event with `200` and a body `{"reply": }` or `{"reply": [, ...]}` (up to 11 pieces, each a kind object with `kind`, such as `{"kind": "buttons", ...}`); the reply is sent into the event's conversation through the send gate, in order, which saves a round trip. A string is a basic message: `{"reply": "Hi"}` sends `{"kind": "basic", "text": "Hi"}`. Any other `2xx` answer (an empty body, plain text such as `OK`, or JSON without `reply`) sends nothing and is not an error. A JSON object whose `reply` is not valid `WebhookReply` content, or a body that starts with `{` but is not valid JSON, sends nothing at all and is recorded on the delivery as an `invalid_request` error (the MCP tool `get_webhook_deliveries` shows it); the delivery still counts as delivered and is not retried. Slow agents answer `200 {}` at once and send later with the kinds' endpoints (`POST /v0/conversations/{conversation_id}/basic`, ...). Failed deliveries are retried with backoff for 3 days; within a conversation, later events wait behind a failing one. After that the event stays in the log, marked failed, and can be read again with `GET /v0/events`. Inbound messages keep the channel's order within a conversation. iMessage: inbound order is best-effort (arrival order); messages sent within about a second of each other may arrive out of order. ## Retention and deleting contacts Message content and files are kept for your plan's retention period (30 days by default). After it, a message's content is removed and the message is no longer returned, files are deleted, and events older than it leave the log. `DELETE /v0/contacts/{contact_id}` erases one contact at once, for example when the person asks you to delete their data or when you delete them in your own product: their name and address, the content of every message in their conversations, the files in them, their events and pending webhook deliveries, and messages still queued to them. It cannot be undone. What stays is only IDs, timestamps and the counts that bill and pace your senders. If the person writes again, or you send to their address, they are a new contact with a new ID. ## Testing with simulated contacts A test key can play the end user's side without a phone or a real channel. `POST /v0/test/conversations` creates a conversation on `telegram`, `whatsapp`, `imessage` or `sms` with a **simulated contact**; `POST /v0/test/conversations/{conversation_id}/inbound` writes as that contact (text, or media uploaded with `POST /v0/files`). Each turn reaches your agent exactly like a real message: a `message.received` event by webhook, on the stream and in the event log, in order. Your agent replies with its normal sends, which pass the real send gate (the channel's kinds and fields, text limits, edit targets) and end `sent` on your app's simulated sender, without touching a network. On Telegram, as with a real bot, nothing reaches a contact who has not written yet: a send before the contact's first turn ends `failed` (`channel_error`, `channel_code` `403`). `GET /v0/test/conversations/{conversation_id}/transcript` shows both sides, oldest first: what was sent is exactly what the contact sees. Simulated traffic is free: it does not count against the sandbox allowance, since nothing leaves Flow and no real person is reached. Two limits bound it instead: an app has at most 500 simulated conversations (a new one past that answers `403 permission` with `channel_code` `simulated_conversation_limit`), and a key makes at most 120 requests a minute to the `/v0/test/` endpoints (`429 rate_limited`), counted on top of its plan's request rate limit. The gate also skips the rules that protect a real number's standing with its channel (pacing, the new-contact budget and warm-up, abuse throttling), so a test suite can run cases in parallel. Simulated conversations, contacts and senders carry `simulated: true` (senders `kind: simulated`), exist only in test mode, are never shown to live keys, and follow your plan's retention like other test data. The SMS rules that concern the contact hold on a simulated SMS conversation as on a real number. A start or reply before the contact's first turn needs their recorded consent (`consent` on `POST /v0/messages`; otherwise `403 permission` with `channel_code` `consent_required`). A turn with the text STOP (or a variant) opts the simulated contact out (its `opted_out_at`, `opted_out_via` `keyword`; sends answer `403 permission` with `channel_code` `contact_opted_out`), and START to the simulated sender lifts it; the turn is still delivered as `message.received`, and the transcript shows no automatic keyword reply. A simulated SMS sender keeps no quiet hours, so a test's outcome never depends on the time of day, and it sends media as MMS. A HIPAA account (`Account.hipaa`) can simulate only SMS: creating a simulated `telegram`, `whatsapp` or `imessage` conversation, or posting a turn to one made before the flag was set, answers `403 permission` with `channel_code` `hipaa_channel_not_covered`. A simulated WhatsApp conversation keeps WhatsApp's rules. The contact's turns go through the same inbound path as a real WhatsApp message, so each turn opens the 24-hour window, and the send gate applies WhatsApp's rules: outside the window (also before the contact's first turn) only a `template` can be sent (`409 outside_window`); buttons take up to 3 reply buttons (a `list` up to 10 rows); reactions and `reply_to` work; edits and unsends answer `422 unsupported_content`. ## MCP server `https://api.flow.engineer/mcp` is a Model Context Protocol server (Streamable HTTP transport, protocol version 2025-06-18 or later) for coding agents such as Claude Code, Codex and Cursor. It is not a REST endpoint: clients `POST` JSON-RPC messages to it (and `GET` answers `405`, since the server keeps no sessions). Authenticate with the same API key as the REST API: ``` claude mcp add --transport http flow https://api.flow.engineer/mcp --header "Authorization: Bearer $FLOW_MESSAGING_KEY" ``` Without a key, `/mcp` answers `401` and its `hint` gives the one call that gets a test key (`curl -X POST https://api.flow.engineer/v0/sandbox/keys`). The key's mode chooses the tools. A `fk_test_` key gets build-time tools to integrate and verify an app end to end: `whoami`, `sandbox_join`, `send_test_message`, `simulate_inbound`, `get_test_transcript`, `wait_for_event`, `list_events`, `get_webhook_deliveries`, `replay_event` and `explain_error`. A `fk_live_` key gets production tools: `send_message`, `reply`, `react`, `edit_message`, `unsend_message`, `typing`, `list_conversations` and `get_conversation_messages`, plus `whoami` and `explain_error`. The tools that send take a `message` that is a kind object, as in a webhook reply (a string is a basic message's text). Every send passes the same send gate as the REST API, and a refusal comes back as the tool's error with the same `type`, `param`, `hint` and `doc_url`. contact: name: Flow Engineer url: https://docs.flow.engineer license: name: Apache-2.0 url: https://www.apache.org/licenses/LICENSE-2.0 servers: - url: https://api.flow.engineer description: Production. Test and live mode are chosen by the API key. security: - bearerAuth: [] paths: /v0/sandbox/keys: post: operationId: createSandboxKey tags: - Onboarding security: [] summary: Get a test key without an account description: | Creates a new app with a `fk_test_` key, without an account or sign-in. This is the first call for an AI coding agent that has no key: no API key is sent, and the answer holds everything needed to start (the key, the sandbox senders with their links and the app's join message). The key and the `claim_token` are shown **once**: save both. The app has a sandbox allowance of 1 contact and 50 messages sent in total on the Telegram sandbox, and WhatsApp's when it opens (inbound messages are free; iMessage is not included), and its keys **expire after 7 days**. After expiry the keys stop working and the contact is removed from the sandbox; a person can still claim the app. To keep the app, a person signs in through the device flow with the `claim_token` (`POST /v0/device/authorizations`), or opens `claim_url` in a browser. The app then shares the person's signed-in allowance (3 contacts and 100 messages each, one allowance per person over all their apps). A claim through `claim_url` revokes this key unless the person chooses to keep their agent's key working; a device sign-in replaces it with a new key. Calls are limited per client address, per network (/24, /64) and wider network (/16, /48), and service-wide per day; going over answers `429 rate_limited` with `retry_after`. Do not call this when you already have a key: check `FLOW_MESSAGING_KEY` first, and reuse the key you saved. requestBody: required: false content: application/json: schema: $ref: "#/components/schemas/SandboxKeyRequest" responses: "201": description: The new app and its key. The key and the claim token are not shown again. content: application/json: schema: $ref: "#/components/schemas/SandboxKey" "400": $ref: "#/components/responses/InvalidRequest" "413": $ref: "#/components/responses/PayloadTooLarge" "429": $ref: "#/components/responses/RateLimited" default: $ref: "#/components/responses/Error" components: headers: RateLimitLimit: description: Requests allowed in the current window for this key. schema: type: integer RateLimitRemaining: description: Requests left in the current window for this key. schema: type: integer RateLimitReset: description: Seconds until the current window resets. schema: type: integer RetryAfter: description: Seconds to wait before retrying. schema: type: integer responses: Error: description: An error. `error.type` says which (see `ErrorType`). content: application/json: schema: $ref: "#/components/schemas/Error" InvalidRequest: description: | The request is malformed or a parameter is invalid (`invalid_request`). `error.param` names the parameter. Every endpoint answers this for a `Flow-Version` header that is not a date this API serves (`param` `Flow-Version`), and every `POST` that takes an `Idempotency-Key` for a key over 255 characters (`param` `Idempotency-Key`). content: application/json: schema: $ref: "#/components/schemas/Error" example: error: type: invalid_request message: limit must be between 1 and 100. hint: Pass limit between 1 and 100 (default 20), and page with after or before. doc_url: https://api.flow.engineer/docs/errors/invalid_request param: limit PayloadTooLarge: description: | The request body is larger than Flow takes (`invalid_request`): 32 MB, or 101 MB for `POST /v0/files` (a 100 MB file and its multipart framing). A body that declares a larger `Content-Length` is refused before it is read. Send media as a `file_id` from `POST /v0/files` or by `url` instead of inlining it. content: application/json: schema: $ref: "#/components/schemas/Error" example: error: type: invalid_request message: The request body is larger than 33554432 bytes. hint: Send a smaller body; upload media with POST /v0/files and send its file_id instead of inlining it. doc_url: https://api.flow.engineer/docs/errors/invalid_request RateLimited: description: | Too many requests (`rate_limited`): either this key's request limit (see the `RateLimit-*` headers) or the sender's sending rate (pacing) was exceeded; retry after `Retry-After` seconds (also `error.retry_after`) with the same `Idempotency-Key`. Or the sender has used its budget for starting conversations (`new_contact_limit`), or the sender is throttled after abuse signals (`sender_throttled`); wait `retry_after` seconds. headers: Retry-After: $ref: "#/components/headers/RetryAfter" RateLimit-Limit: $ref: "#/components/headers/RateLimitLimit" RateLimit-Remaining: $ref: "#/components/headers/RateLimitRemaining" RateLimit-Reset: $ref: "#/components/headers/RateLimitReset" content: application/json: schema: $ref: "#/components/schemas/Error" example: error: type: new_contact_limit message: This sender has started its 15 new conversations for today. hint: Retry after 3600 seconds; replies into existing conversations still go. doc_url: https://api.flow.engineer/docs/errors/new_contact_limit retry_after: 3600 sender: snd_01JB8Z4Q3V6W0R2N7C5H1M9K4T schemas: Account: type: object description: A customer company. Holds the plan, billing and members. Every app belongs to one account. required: - id - name - plan - created_at properties: id: $ref: "#/components/schemas/AccountId" name: type: string description: The company's name. plan: type: string description: | The account's plan, set by the Flow team (there is no self-serve checkout). Each plan caps how many people your apps may talk with per channel; `people` shows the caps and what is used. - `free`: a small number of people per channel in total (25 today). - `shared`: Flow's shared senders, with caps per channel a day and a month (200 a day and 300 a month today). - `dedicated`: your own iMessage line, with a daily cap on it and no monthly cap (1,000 a day today); on Flow's shared senders it has `shared`'s caps, counted apart (`people` shows each `pool`). The numbers are settings and may change; read the caps that apply now from `people`, not from this list. - `pro`, `business`, `enterprise`: older plans, kept for accounts that have them; they have no people caps. New values may be added; treat one you do not know like `free`. enum: - free - shared - dedicated - pro - business - enterprise x-enum-varnames: - Free - PlanShared - PlanDedicated - Pro - Business - Enterprise people: $ref: "#/components/schemas/PeopleLimits" hipaa: type: boolean readOnly: true description: | `true` when the account handles protected health information under a business associate agreement with Flow. Its messages then go only through channels Flow holds such an agreement for (SMS): sends, typing, read receipts and sender connections on Telegram, WhatsApp and iMessage answer `403 permission` with `channel_code` `hipaa_channel_not_covered`, and messages already queued there fail the same way. The sandbox senders answer the account's contacts with a fixed refusal and store and deliver nothing they send; turning the flag on ends the account's sandbox joins. Only SMS can be simulated (`POST /v0/test/conversations`): creating a simulated Telegram, WhatsApp or iMessage conversation, or posting a turn to one made before the flag was set, answers the same refusal. Set by the Flow team. created_at: type: string format: date-time description: When the account was created. AccountId: type: string description: An account ID, `acct_` and a ULID. pattern: ^acct_[0-9A-HJKMNP-TV-Z]{26}$ examples: - acct_01JB8YZ3N2Q4R6T8V0X2Z4B6D8 AllowanceCount: type: object description: Contacts the allowance has room for, and how many have joined (with `scope` `person`, over all the person's apps). required: - limit - used properties: limit: type: integer minimum: 0 description: How many contacts may join on the sandbox (1 for an anonymous app; 3 for a signed-in person, over all their apps). used: type: integer minimum: 0 description: How many have joined so far. AllowanceMessages: type: object description: Messages sent against the allowance, over all its contacts (with `scope` `person`, from all the person's apps). required: - limit - used - remaining properties: limit: type: integer minimum: 0 description: "`contacts.limit` times `messages_per_contact`." used: type: integer minimum: 0 description: Messages sent so far on the allowance's sandbox senders. remaining: type: integer minimum: 0 description: Messages still allowed, counting each contact's own cap and the contacts that may still join. ApiKey: type: object description: An API key's record. The key itself is shown once, at creation, and stored only as a hash. required: - id - mode - last4 - created_at properties: id: $ref: "#/components/schemas/ApiKeyId" mode: $ref: "#/components/schemas/Mode" last4: type: string description: The key's last four characters, to tell keys apart. minLength: 4 maxLength: 4 created_at: type: string format: date-time description: When the key was created. expires_at: type: string format: date-time description: | When the key stops working. Set only on keys of an unclaimed app made with `POST /v0/sandbox/keys` (7 days after it was made); signing in through the device flow claims the app and removes it. An expired key can still start that sign-in for 30 days after this time, and claiming the app within those 30 days makes the key work again. ApiKeyId: type: string description: An API key's ID, `key_` and a ULID. Not the secret key itself. pattern: ^key_[0-9A-HJKMNP-TV-Z]{26}$ examples: - key_01JB8Z1B2D4F6H8K0M2P4R6T8W App: type: object description: One agent integration. Owns API keys (per mode), webhook endpoints and settings. required: - id - account - name - api_version - settings - created_at properties: id: $ref: "#/components/schemas/AppId" account: $ref: "#/components/schemas/AccountId" name: type: string description: The app's name. api_version: type: string format: date description: The API version pinned to the app when it was created, used when a request sends no `Flow-Version`. settings: $ref: "#/components/schemas/AppSettings" sandbox_join_code: type: string description: | The app's sandbox join code on its own: two words and eight digits, for example `brave-otter-40718263`. A contact joins this app by sending a shared sandbox sender the join message, which ends with this code in brackets after `ref` (`Hi Sandbox app (ref brave-otter-40718263)`), or on Telegram by opening the bot's link with the code (`https://t.me/?start=brave-otter-40718263`, which sends `/start brave-otter-40718263`). Each shared sender's `join_code` gives the whole message: show that to testers, not this code. examples: - brave-otter-40718263 created_at: type: string format: date-time description: When the app was created. AppId: type: string description: An app ID, `app_` and a ULID. pattern: ^app_[0-9A-HJKMNP-TV-Z]{26}$ examples: - app_01JB8Z0A1C3E5G7J9K1M3P5R7T AppSettings: type: object description: Per-app behaviour. The Flow team sets it for now; ask them to change it. required: - transcription - auto_read properties: transcription: type: boolean description: Not used yet. Flow makes no transcripts of its own on any channel; on iMessage, a received voice note carries the transcript iMessage made of it, whatever this setting says. auto_read: type: boolean description: When on, Flow marks inbound messages as read as soon as your endpoint accepts them. CallForwarding: type: object description: | Dedicated lines only: where phone calls to the line's number are forwarded, set up with the Flow team. Forwarded calls send no event. FaceTime calls are not forwarded; they arrive as `call.received`. Absent when calls are not forwarded (always on shared lines). required: - phone properties: phone: type: string description: The E.164 number calls are forwarded to. pattern: ^\+[1-9][0-9]{6,14}$ examples: - "+15555550123" Channel: type: string description: A messaging channel. `sms` is US SMS and MMS (in pilot), from dedicated numbers only. enum: - telegram - whatsapp - imessage - sms ChannelPeople: type: object description: | The caps on people for one channel and one pool of senders, and how many people are held. A channel can appear twice, once per pool, since each pool is counted apart (a `dedicated` account has `shared`'s caps on Flow's shared senders and its own cap on its own line). required: - pool - limits - held properties: channel: $ref: "#/components/schemas/Channel" pool: type: string description: "`shared`: Flow's shared senders on this channel. `own`: the account's own senders on it (a dedicated line, its own bot or number). Counted apart." enum: - shared - own x-enum-varnames: - PeoplePoolShared - PeoplePoolOwn limits: type: array description: "Each window the plan caps (`free`: `total`; `shared`: `day` and `month`; `dedicated`: `day`)." items: $ref: "#/components/schemas/PeopleWindow" held: type: integer minimum: 0 description: People held now because a cap is reached; their messages wait and are delivered when a place frees or the window rolls over. ConversationId: type: string description: A conversation ID, `conv_` and a ULID. pattern: ^conv_[0-9A-HJKMNP-TV-Z]{26}$ examples: - conv_01JB8ZC3K5M7P9R1T3V5X7Z9B1 Error: type: object description: The body of every error answer. required: - error properties: error: $ref: "#/components/schemas/ErrorBody" ErrorBody: type: object description: The details of an error. required: - type - message - hint - doc_url properties: type: $ref: "#/components/schemas/ErrorType" message: type: string description: A sentence for a developer saying what went wrong. Do not parse it; switch on `type`. hint: type: string description: | One sentence saying what to change to make the request succeed, specific to this case, for example "Send a template instead: POST /v0/conversations/{conversation_id}/template." For `unsupported_content` it says what to send instead over plain HTTP. Written for developers and coding agents alike. Do not parse it; it may be reworded at any time. examples: - "Send a template instead: POST /v0/conversations/{conversation_id}/template." doc_url: type: string format: uri description: The documentation page for this error's type, `https://api.flow.engineer/docs/errors/`. It says what the error means, why it happens and how to fix it, with code. examples: - https://api.flow.engineer/docs/errors/outside_window param: type: string description: The request parameter the error is about, as a dotted path (`kind`, `telegram.is_big`, `buttons`, `cards[1].header.type`, `limit`). retry_after: type: integer minimum: 0 description: Seconds to wait before retrying, for errors that clear by themselves. channel: $ref: "#/components/schemas/Channel" description: The conversation's channel, on errors about what it takes (`unsupported_content`) and its windows (`outside_window`). conversation: $ref: "#/components/schemas/ConversationId" sender: $ref: "#/components/schemas/SenderId" channel_code: type: string description: | For `channel_error`, the channel's own error code, as given by the channel. For some other errors, Flow's own code naming the case, for example `sandbox_allowance_used` (`permission`: the sandbox allowance is used up), `sandbox_contact_limit` (`permission`: the allowance has no room for another contact), `sandbox_channel_not_included` (`permission`: the allowance does not cover this sandbox channel), `sign_in_required` (`permission`: an app made without an account cannot do this) or `sandbox_key_expired` (`authentication`: a key from `POST /v0/sandbox/keys` passed its `expires_at`; `permission`, for a send that carries no key, such as a reply in a webhook answer, from such an app). For `idempotency_conflict`, always one of `body_mismatch` (the key was used for a different request), `in_progress` (the first request is still running; `retry_after` says when to repeat it) or `secret_not_kept` (its answer carried a secret shown only once). SMS: `contact_opted_out` and `consent_required` (`permission`), `quiet_hours` (`outside_window`, with `retry_after`), and `carrier_filtered`, `unreachable`, `invalid_number`, `landline`, `registration_required`, `carrier_error` and `provider_not_configured` (`channel_error`). HIPAA accounts: `hipaa_channel_not_covered` (`permission`). Connecting your own WhatsApp number (`POST /v0/senders`): `whatsapp_token_malformed`, `whatsapp_token_rejected`, `whatsapp_app_secret_malformed` and `whatsapp_number_not_in_account` (`invalid_request`), and `whatsapp_number_taken`, `whatsapp_account_taken` and `whatsapp_number_managed` (`permission`). Simulated conversations (`permission`): `test_mode_only`, `not_simulated`, `simulated_contact` and `simulated_conversation_limit`. For a message that failed after it was queued (`message.failed`): `sandbox_contact_left` (`permission`), `window_closed` and `queued_too_long` (`outside_window`), and `channel_timeout_unknown_outcome` (`channel_error`: the channel never confirmed the send, so it may or may not have arrived). iMessage (`unsupported_content`): `group_unsupported` (a reaction, typing or a read receipt in a group conversation; `param` `kind`) and `not_on_sms` (an edit or unsend of a message that went by SMS or RCS; `param` `kind`). SMS (`unsupported_content`): `no_mms` (media to a number without MMS; `param` `media`). Edits and unsends (`unsupported_content`): `edit_window_closed` and `unsend_window_closed` (the message is older than the channel allows for the change) and `first_message_not_editable` (iMessage: the message that started the conversation). From typing and read receipts, `unknown_outcome` (`channel_error`: the call timed out after it was sent). request_id: type: string description: Flow's ID for this request. Quote it when asking for help. ErrorType: type: string description: | What went wrong. A closed list: new types arrive only with a new API version. Each type has a page at `https://api.flow.engineer/docs/errors/`, given in the error's `doc_url`; the error's `hint` says what to change for the case. - `invalid_request` (400, or 413 for a request body over the size limit): the request is malformed or a parameter is invalid. Fix the parameter named in `param`; the `hint` says what it must look like. Every endpoint answers it for a `Flow-Version` header that is not a version this API serves. - `authentication` (401): the API key is missing, malformed, unknown, revoked or expired. An `Authorization: Bearer` header with nothing after it usually means the environment variable holding the key was empty when the header was built (for an MCP client, when the server was added): the `hint` says so. Send `Authorization: Bearer fk_test_...` or `fk_live_...` with a current key; with no key at all, get a test key with `POST /v0/sandbox/keys`. A sandbox key past its `expires_at` has `channel_code` `sandbox_key_expired`: sign in to claim the app, or get a new key. - `permission` (403): the key may not do this, for example a test key using a live sender, a sandbox contact who joined another app, a new conversation from an iMessage line that may only reply, or a send past the app's sandbox allowance (`channel_code` `sandbox_allowance_used`, `sandbox_contact_limit` or `sandbox_channel_not_included`). Use the key of the right mode, have the contact send your join message, wait for the contact to message the line first, or sign in through the device flow to lift the allowance. On SMS: `contact_opted_out` (the contact texted STOP; nothing more goes to them until they text START), `consent_required` (a start to someone who never texted your numbers: record their consent with `consent` on the start). In a HIPAA account: `hipaa_channel_not_covered` (the channel has no business associate agreement; use SMS). Simulated conversations: `simulated_contact` (a real sender was pointed at a simulated contact; reply in the contact's simulated conversation), `not_simulated` (a simulated sender or test endpoint was pointed at a real contact), `test_mode_only`, `simulated_conversation_limit`. In `message.failed`: `sandbox_contact_left` (the contact joined another app on the sandbox sender while the message was queued; have them send your join message again). - `not_found` (404): no such object for this app and mode. Check the ID's prefix and that it was made with a key of the same mode (test and live data are separate). - `idempotency_conflict` (409): the idempotency key was used for a different request (`channel_code` `body_mismatch`: use a new key), or that request is still running (`in_progress`: wait `retry_after` seconds and repeat it with the same key), or it already created a secret that is shown only once (`secret_not_kept`: creating a webhook endpoint, rotating its secret, connecting a WhatsApp number; a secret that was lost must be rotated again, and a WhatsApp number connected again to see its verify token). - `outside_window` (409, or in `message.failed`): the channel will not deliver outside its conversation window. On WhatsApp the 24-hour window is closed: send a template (`POST /v0/conversations/{conversation_id}/template`, or `POST /v0/messages` with `kind` `template` to start), or wait for the contact to write. On iMessage the contact has not messaged the line (or opted in) yet, or not recently, so the failure arrives as a `message.failed` event: wait for the contact to write, then reply in that conversation. Typing and read receipts answer `409 outside_window` directly when the channel's window for them is closed (iMessage typing works only within 5 minutes of the contact's last message; WhatsApp read receipts go at any time); ignore it and send your reply. On SMS, `channel_code` `quiet_hours`: the contact has not texted in the last hour and it is inside the sender's quiet hours in their time zone; retry after `retry_after` seconds, or wait for them to text. In `message.failed`: `window_closed` (WhatsApp's 24-hour window closed while the message was queued; send a template) and `queued_too_long` (the message waited in the queue longer than its sender allows, for example while the sender was paused; send it again if it still applies). - `unsupported_content` (422): the conversation's channel does not take this kind, field, block or value, and nothing was sent; Flow never converts a message. `param` names what was refused: `kind` (the endpoint's kind is not on this channel, such as a carousel on Telegram), a field or block (`reply_to` on SMS, `telegram` on WhatsApp, `telegram.is_big`), or the field whose value is not taken (`emoji` outside Telegram's reaction emoji, `buttons` for more than 3 WhatsApp buttons). `channel` is the conversation's channel and `hint` says what to send instead over plain HTTP; each endpoint's page lists its channels. In an iMessage group conversation, a reaction, typing or a read receipt answers it with `param` `kind` and `channel_code` `group_unsupported`: leave it out. Media to an SMS number without MMS answers it with `param` `media` and `channel_code` `no_mms`. An edit or unsend of an iMessage message that went by SMS or RCS (its `network`) answers it with `channel_code` `not_on_sms`: send a new message instead. An edit or unsend past the channel's time limit answers it with `channel_code` `edit_window_closed` or `unsend_window_closed` (iMessage: edits within 15 minutes of sending, unsends within 2 minutes; Telegram: unsends within 48 hours), and an iMessage edit of the message that started the conversation with `first_message_not_editable`; `message` states the limit and how long ago the message was sent. Send a new message instead. `POST /v0/files` answers it for a type Flow does not take (programs, web pages, unknown types). A send by `file_id` of a document a contact sent before Flow malware-scanned documents answers it too: Flow sends only documents it scanned. - `new_contact_limit` (429): the sender has used its budget for starting conversations. Wait `retry_after` seconds; replies into existing conversations still go. - `sender_throttled` (429): abuse signals tripped (the same text to many new contacts, many starts with no reply, blocks), so the sender may not start conversations until `retry_after`; replies into existing conversations still go. Personalise first messages and start only conversations people expect. - `file_blocked` (422): the file failed the malware scan and was not stored. Send a different file. (When the scan cannot run at all, the upload answers a retryable `500 api_error` with `Retry-After` instead.) - `rate_limited` (429): either too many requests for this key (the per-key request limit, reported in the `RateLimit-*` headers) or sends faster than the sender's sending rate (pacing). Wait `Retry-After` (`retry_after`) seconds and retry with the same `Idempotency-Key`. - `channel_error` (502, or in `message.failed`): the channel refused or failed the message, or timed out; `channel_code` carries its own code. Read `message`, change what the channel objected to, and send again. From typing and read receipts, which call the channel at once, it is safe to ignore. SMS codes are Flow's, the same whichever carrier network carries the message: `carrier_filtered` (a carrier's spam filter blocked it: make it read like a person's message, no shortened links), `unreachable`, `invalid_number`, `landline`, `registration_required` (the number's 10DLC or toll-free registration is not approved yet), `carrier_error`, and `provider_not_configured` (the SMS sender is not fully set up on Flow's side, so nothing was sent; contact the Flow team). Flow's own codes on every channel: `channel_timeout_unknown_outcome` (in `message.failed`: the channel did not answer after the message was sent, and the resends its policy allows did not settle it, so the message may have arrived or not; check with the contact before sending it again) and `unknown_outcome` (from typing and read receipts: the call timed out after it was sent). - `not_implemented` (501): this endpoint or channel is not live yet during the beta. Use a channel that is live (Telegram, iMessage), or check the changelog. - `api_error` (500, 503): something went wrong on Flow's side. Retry with the same idempotency key after `retry_after` seconds, and quote `request_id` if it persists. enum: - invalid_request - authentication - permission - not_found - idempotency_conflict - outside_window - unsupported_content - new_contact_limit - sender_throttled - file_blocked - rate_limited - channel_error - not_implemented - api_error ImessageSender: type: object readOnly: true description: | iMessage senders only: what the line can do beyond replying in iMessage. Set by the Flow team (ask them to change it); absent on other channels. required: - fallback - can_initiate properties: fallback: type: boolean description: | Whether messages to a contact who cannot get iMessage go by SMS or RCS instead. The network is chosen for each message when it is sent, never by your app; the message's `network` says which one carried it. Included on Flow's shared lines; on a dedicated line, an add-on arranged with the Flow team. Off, a message to a contact who is not on iMessage fails (`message.failed`). A message that goes by SMS or RCS shows no `imessage.styles`, `imessage.subject` or effect, and edits and unsends of it answer `422 unsupported_content` with `channel_code` `not_on_sms` (see `Message.network`). call_forwarding: $ref: "#/components/schemas/CallForwarding" can_initiate: type: boolean description: | Whether the line may write first: start a conversation with `POST /v0/messages` with a contact who has not messaged it. Off (the default), the line only replies and a start answers `403 permission`. Writing first is available on request from the Flow team, on dedicated lines only (always `false` on shared lines); a line that starts conversations spends its new-contact budget (`limits`), which grows during warm-up. Mode: type: string description: "`test` (sandbox senders and test data only) or `live`." enum: - test - live PeopleLimits: type: object readOnly: true description: | The account's plan caps on people, and what is used now. A person counts once in a window, with their first inbound message in it on that channel's sender, whether one-to-one or in a group chat; group members who never write, calls, and your own sends do not count. A person past a cap is **held**: their messages are kept but not delivered to your app, and are delivered once a place frees or the window rolls over. Absent when the account's plan has no people caps. These numbers are the source of truth for the caps; they are settings and can change. required: - per - channels properties: per: type: string description: "`channel`: each channel has its own caps (every plan today). `account`: one set of caps over all channels, with no `channel` on its entry." enum: - channel - account channels: type: array description: One entry per channel the caps apply to (one entry without `channel` when `per` is `account`). items: $ref: "#/components/schemas/ChannelPeople" PeopleWindow: type: object description: One capped window and how many people it has used. required: - window - limit - used properties: window: type: string description: "`total`: since the account began (never resets). `day`: the UTC day. `month`: the UTC calendar month." enum: - total - day - month x-enum-varnames: - PeopleWindowTotal - PeopleWindowDay - PeopleWindowMonth limit: type: integer minimum: 0 description: How many people may write in the window. used: type: integer minimum: 0 description: How many distinct people wrote in the window so far. resets_at: type: string format: date-time description: When the window rolls over and `used` starts again. Absent for `total`. QuietHours: type: object description: | The hours, in the contact's local time zone (worked out from their area code; when it is not known, every US time zone must be outside the hours), in which the sender does not message contacts who have not texted it in the last hour. Absent when the sender has no quiet hours. A send inside them answers `409 outside_window` with `channel_code` `quiet_hours` and `retry_after`; a message that waited in the queue into them is held until they end. Replies to a contact who texted within the hour always go. required: - start - end properties: start: type: string description: When the quiet hours begin, `HH:MM` on a 24-hour clock. pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$ examples: - 21:00 end: type: string description: When they end, `HH:MM` on a 24-hour clock (earlier than `start` when they span midnight). pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$ examples: - 08:00 SandboxAllowance: type: object description: | What the app may still send on the shared sandbox senders for free. Present only on apps that have one: apps made with `POST /v0/sandbox/keys` (`anonymous`, one allowance per app), and apps of people who signed in (`signed_in`, one allowance per person: every app the person owns or claimed draws on the same contacts and messages, so the counts here are the person's, over all those apps). Only messages your agent sends count, on the channels in `channels`; inbound messages are free. A contact counts once it joins an app on a sandbox sender, and keeps counting after it leaves. Sends past the allowance answer `403 permission` with `channel_code` `sandbox_allowance_used`; a join past `contacts.limit` is refused in the chat. Absent on an account with the free trial (your own account, from your first sign-in), which replaces it, and on paid plans. required: - tier - scope - channels - contacts - messages_per_contact - messages - upgrade properties: tier: type: string description: "`anonymous`: an app made without an account, whose keys expire. `signed_in`: an app of a person who signed in (with a Flow account)." enum: - anonymous - signed_in scope: type: string description: | Who the counts belong to. `app`: this app alone (`anonymous`). `person`: the signed-in person, shared by every app they own or claimed, so sends from their other apps use the same contacts and messages. enum: - app - person channels: type: array description: The sandbox channels the allowance covers whose shared sandbox is open now (Telegram today; WhatsApp when its sandbox opens). Shared senders of other channels (iMessage) are not part of it and refuse its sends. items: $ref: "#/components/schemas/Channel" contacts: $ref: "#/components/schemas/AllowanceCount" messages_per_contact: type: integer minimum: 0 description: How many messages may be sent to each contact (50 anonymous, so 50 in total; 100 signed in). messages: $ref: "#/components/schemas/AllowanceMessages" expires_at: type: string format: date-time description: "`anonymous` only: when the app's keys expire. Signing in removes it." upgrade: type: string description: One sentence saying how to raise the allowance, for example by signing in with `npx @flow-engineer/messaging login`. SandboxKey: type: object description: A new app made without an account, with its test key. `key` and `claim_token` are shown only here. required: - key - api_key - account - app - allowance - claim_token - claim_url - senders properties: key: type: string description: The API key itself (`fk_test_...`). Shown once; store it as `FLOW_MESSAGING_KEY`. examples: - fk_test_... api_key: $ref: "#/components/schemas/ApiKey" account: $ref: "#/components/schemas/Account" app: $ref: "#/components/schemas/App" allowance: $ref: "#/components/schemas/SandboxAllowance" claim_token: type: string description: | Proves you hold this app when a person signs in to claim it: pass it to `POST /v0/device/authorizations`. Shown once; keep it with the key. It stops working once the app is claimed. examples: - fct_... claim_url: type: string format: uri description: A page where a person signs in to Flow and claims the app in the browser, without the CLI. It holds the claim token, so treat it like one. The claim hands out no key and revokes the app's keys unless the person ticks "Keep my agent's current key working"; afterwards they make keys on the dashboard's Keys page. examples: - https://api.flow.engineer/admin/claim#token=fct_... senders: type: array description: The shared sandbox senders the key can use, each with the link a person opens to join the app (`address.link`) and the join message (`join_code`). items: $ref: "#/components/schemas/Sender" SandboxKeyRequest: type: object description: Optional details for a new sandbox app. properties: name: type: string maxLength: 80 description: The app's name, shown in the dashboard once it is claimed. Defaults to "Sandbox app". Sender: type: object description: | What your agent talks from: a Telegram bot, a WhatsApp number, an iMessage line or a US SMS number. `shared` senders are Flow's sandbox, used by many apps in test mode; `dedicated` senders are yours alone; `simulated` senders exist only in test mode, for simulated conversations. Each sender has its own limits and warm-up state. required: - id - channel - kind - livemode - status - address - limits - created_at properties: id: $ref: "#/components/schemas/SenderId" channel: $ref: "#/components/schemas/Channel" kind: $ref: "#/components/schemas/SenderKind" livemode: type: boolean description: "`false` for sandbox and simulated senders, `true` for dedicated senders used in live mode." display_name: type: string description: The name contacts see, where the channel shows one. status: $ref: "#/components/schemas/SenderStatus" throttled_until: type: string format: date-time description: With status `throttled`, when starts are allowed again. Recovery is automatic. address: $ref: "#/components/schemas/SenderAddress" limits: $ref: "#/components/schemas/SenderLimits" quality_rating: type: string description: WhatsApp only. Meta's quality rating for the number. enum: - green - yellow - red - unknown sms: $ref: "#/components/schemas/SmsSender" imessage: $ref: "#/components/schemas/ImessageSender" setup: $ref: "#/components/schemas/SenderSetup" join_code: type: string description: | Shared senders only. The whole message a contact sends to this sender to join your app: `Hi `, the app's name (`there` when it has none), then the app's `sandbox_join_code` (from `GET /v0/app`) in brackets after `ref`, for example `Hi Sandbox app (ref brave-otter-40718263)`. Show it to testers as is; a link that fills it in (wa.me, sms:) carries it URL-encoded. Any message of at most 160 characters that ends with `(ref )` joins, so a tester may change the words before the brackets. examples: - Hi Sandbox app (ref brave-otter-40718263) created_at: type: string format: date-time description: When the sender was created. SenderAddress: type: object description: How contacts reach the sender. Which fields are set depends on the channel. properties: phone: type: string description: WhatsApp, iMessage and SMS. E.164 phone number. username: type: string description: Telegram. The bot's username, without `@`. handle: type: string description: iMessage. The line's handle (phone number or email address). link: type: string format: uri description: | A link that opens a chat with the sender: `https://t.me/...` for a Telegram bot, `https://wa.me/...` for a WhatsApp number. For an iMessage line it is the line's opt-in link, which opens Messages with the line and a prefilled text the person sends to start the conversation; it is set only when the line has one configured. SenderId: type: string description: A sender ID, `snd_` and a ULID. pattern: ^snd_[0-9A-HJKMNP-TV-Z]{26}$ examples: - snd_01JB8Z4Q3V6W0R2N7C5H1M9K4T SenderKind: type: string description: | `shared` (the sandbox), `dedicated` (yours) or `simulated` (test mode only: your app's stand-in for a channel, used by simulated conversations from `POST /v0/test/conversations`; it never touches a network). enum: - shared - dedicated - simulated SenderLimits: type: object description: The sender's current budget for starting conversations, and how fast it sends. required: - new_contacts_per_day - new_contacts_per_hour properties: new_contacts_per_day: type: integer description: New conversations the sender may start per day today (grows during warm-up). new_contacts_per_hour: type: integer description: New conversations the sender may start per hour. messages_per_second: type: number description: | The sender's pacing: how many messages a second it takes on average, replies included, with short bursts allowed above it. A send past it answers `429 rate_limited` with `retry_after`. A shared sandbox sender's pacing is shared by every app that uses it. Absent for simulated senders, which are not paced. examples: - 1 whatsapp_tier: type: string description: WhatsApp only. Meta's messaging tier for the number. SenderSetup: type: object readOnly: true description: | Only in the answer to `POST /v0/senders` that connected a WhatsApp number: what you still set in your own Meta app, which Flow cannot set for you. Flow already points the number's webhooks at `callback_url` (Meta's phone-number-level override); entering the same URL in your app makes its field subscriptions apply. The verify token is shown only in this answer (connecting the number again shows it again); keep it like a password. required: - callback_url - verify_token - webhook_fields - steps properties: callback_url: type: string format: uri description: The callback URL to enter in your Meta app (App Dashboard > WhatsApp > Configuration > Webhook). examples: - https://api.flow.engineer/ingress/whatsapp/snd_01J9ZK3N5B6VQ1M2X4C7R8T9WA verify_token: type: string description: The verify token to enter with the callback URL. webhook_fields: type: array description: The webhook fields to subscribe in the same place. items: type: string examples: - - messages - message_template_status_update - phone_number_quality_update - account_update - business_capability_update - template_category_update - account_alerts steps: type: array description: The steps in your Meta app, in order, as plain sentences to show a person. items: type: string SenderStatus: type: string description: | - `pending`: requested, being provisioned. - `active`: sending normally. - `warming_up`: active, with a new-contact budget that grows day by day. - `throttled`: the gate slowed it after an abuse signal; it recovers by itself. - `flagged`: the channel or Flow flagged it; starts are paused. A Telegram bot is also `flagged` when Telegram rejects its token (revoked in @BotFather): it then sends nothing, new sends answer `403 permission`, and queued messages wait until you connect the bot again with its new token (`POST /v0/senders`). They wait at most 72 hours after Flow accepted them; older ones fail with `outside_window` (`channel_code` `queued_too_long`) in `message.failed` instead of going out late. - `banned`: it cannot send or receive: the channel banned it, you disconnected it (`DELETE /v0/senders/{sender_id}`), or its bot or line was connected to another app. enum: - pending - active - warming_up - throttled - flagged - banned SmsSender: type: object readOnly: true description: | SMS senders only: how the number is registered with US carriers and what it can do. An SMS number stays `pending` until its registration is approved (carriers block traffic from unregistered numbers). required: - number_type - registration_status - two_way - mms properties: number_type: type: string description: "`10dlc` (a local 10-digit number, registered as a brand and campaign) or `toll_free` (a verified toll-free number)." enum: - 10dlc - toll_free registration_status: type: string description: | The number's carrier registration (the 10DLC campaign, or toll-free verification): `pending` (submitted, not approved yet; the sender is `pending` and sends nothing), `approved`, or `rejected` (the sender is `flagged`; the Flow team resubmits). enum: - pending - approved - rejected two_way: type: boolean description: Whether the number receives texts. Always `true` for senders Flow connects today. mms: type: boolean description: Whether the number sends and receives MMS (images, audio and video). Without it, a basic message with `media` answers `422 unsupported_content` with `param` `media` and `channel_code` `no_mms`. quiet_hours: $ref: "#/components/schemas/QuietHours" securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: fk_test_... or fk_live_... description: | An API key of one app, sent as `Authorization: Bearer `. Keys start with `fk_test_` (test mode: sandbox senders and test data only) or `fk_live_` (live mode). Keep live keys on your server; never ship them in an app or page. ````