Test message

Sends one message through the same retrieval and generation path the widget uses, without creating a conversation.

posthttps://api.integrable.cloud/api/agents/{agent_id}/test

Authentication: Bearer token
Retries: Idempotency-Key
Body: application/json
Version: 2026-09-03

Rate-limited despite being authenticated: it is an unmetered paid model call, and an authenticated user scripting it is a cost-denial vector as real as an anonymous one.

Path parameters#

agent_idstringrequired

Headers#

Idempotency-Keystring
A unique key of your choosing, so this request can be retried safely. The first request with a given key executes; every replay returns that first response unchanged, with Idempotent-Replay: true set.
Generate one key per action, not per session - reusing a key with a different body is refused with 422 rather than silently replaying the wrong answer. Keys are remembered for 24 hours. A request that failed releases its key, so a retry after fixing the payload runs normally.
Up to 255 characters

Request body#

application/json · required

TestMessageRequest

messagestringrequired
1–4000 characters
historyarray of TestTurn
Up to 20 items
2 fieldsTestTurn
- contentstringrequired
  1–4000 characters
- rolestringrequired
  One of: user, assistant
modelstring | null
Up to 128 characters

Responses#

200OKapplication/json
TestMessageResponse
- contentstringrequired
- creditsnumberrequired
- input_tokensintegerrequired
- latency_msintegerrequired
- modelstringrequired
- output_tokensintegerrequired
- citationsarray of object
5 response headers
RateLimit-Limit
Requests permitted in the current window.
RateLimit-Remaining
Requests left in the current window. Back off before it reaches 0.
RateLimit-Reset
Seconds until the current window resets.
X-API-Version
The dated version of the API contract that served this response, e.g. 2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.
X-Request-ID
Quote this in a support request to identify the call.
422Validation error
The shared error envelope, served as application/problem+json with error.code set to validation_error. Its details name each field that failed and why.

Request · curl

curl -X POST "https://api.integrable.cloud/api/agents/$AGENT_ID/test" \
  -H "Authorization: Bearer $INTEGRABLE_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "string"
  }'

Set INTEGRABLE_API_KEY and the path variables first. The TypeScript and Python SDKs take the same fields.

Response · 200 OK · application/json

{
  "citations": [
    {}
  ],
  "content": "string",
  "credits": 0,
  "input_tokens": 0,
  "latency_ms": 0,
  "model": "string",
  "output_tokens": 0
}

Generated from the schema: the shape is exact, the values are placeholders.

Errors#

Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:

validation_error · 422 — The payload was well-formed JSON but failed schema validation.
unauthenticated · 401 — The request carried no API key, or one the API could not verify.
forbidden · 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.
idempotency_key_reused · 422 — This `Idempotency-Key` was used before, for a request with a different body.
rate_limited · 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-agent limit on top.

More Agents endpoints#

Something unclear or missing? Tell us and we’ll fix it.