Compatibility API (/v1) verification

View as Markdown

POST /v1/verify · operationId compatVerify

For developers: your server sends this request with a server key; it is not a button in the dashboard.

Note

This is the compatibility API (/v1): it keeps the request and response shapes of the v1 agent-verification API that existing integrations were built on, so such an integration works unchanged. New integrations should use the /api/v1 operations, which return reasons, decision, policy and attribution and work with the server adapter.

Uses the stricter actionVerdict from /api/v1/verify (analytics-only AI agent is excluded), returned in the v1 shape {verdict, score}. Scores are categorical (human 1, unknown 50, agent 99), never probabilities; unknown is not human. Failures are exactly {"error":"<code>"}. The request body is closed (sessionToken and actionId only); to forward Web Bot Auth headers use /api/v1/verify.

Authentication

Send Authorization: Bearer YOUR_SERVER_KEY (siteServerKey: Site server key in Authorization: Bearer <key> (the scheme is case-insensitive and required; a bare key is 401). Shown once on creation or rotation. Publishable keys cannot authenticate). Keep the server key in server-only configuration; never send it to a browser.

Request body

Content-Type: application/json (required)

JSON
{
  "sessionToken": "PASTE_BROWSER_SESSION_TOKEN",
  "actionId": "export_report"
}

Responses

Success body fields

Failures are not verdicts. Error bodies follow the CompatError schema: error is one of bad_request, unauthorized, forbidden, not_found, session_reinit_required, rate_limited, internal_error, config_unavailable, session_unavailable, discovery_not_ready, discovery_unavailable, session_not_found. Errors and retries explains each code and what to do.

Example

curl
curl -sS -X POST 'https://app.trytelltale.dev/v1/verify' \
  -H "Authorization: Bearer $TELLTALE_SERVER_KEY" \
  -H 'Content-Type: application/json' \
  --data '{"sessionToken":"PASTE_BROWSER_SESSION_TOKEN","actionId":"export_report"}'
fetch
const response = await fetch("https://app.trytelltale.dev/v1/verify", {
  method: "POST",
  headers: {
    Authorization: 'Bearer ' + process.env.TELLTALE_SERVER_KEY,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "sessionToken": "PASTE_BROWSER_SESSION_TOKEN",
    "actionId": "export_report"
  }),
  signal: AbortSignal.timeout(5000)
});
const result = await response.json();

Machine-readable contract: openapi.json. Request builder: the API explorer shows every operation as curl; it sends requests only on a local dashboard.