Skip to main content
POST
Invoke a single agent

Authorizations

Authorization
string
header
required

API key starting with zt_live_ (production) or zt_test_ (sandbox). Get your key at https://developers.zebratruth.ai

Headers

Idempotency-Key
string<uuid>
required

Unique request identifier to prevent duplicate execution and double-charging. Generate a new UUID for each distinct request. Reuse the same key to safely retry.

Path Parameters

agentId
enum<string>
required

The agent to invoke (use GET /agents to discover available IDs) Agent identifier. Use GET /agents to discover all available agents dynamically. The list is filtered to the industries your workspace has selected.

Financial services. The six fs-compliance-* agents correspond one-to-one to the review scopes (financial_promotion → fs-compliance-financial-promotion, and so on). In a full check they are selected with reviewScopes. Via POST /agents/{agentId} only fs-compliance-financial-promotion can be invoked directly today; the other five return 400 review_scope_not_enabled on direct invocation and must run through POST /compliance/check. financial-services-compliance is a read-only alias of fs-compliance-financial-promotion accepted for older clients.

Pharma and healthcare. pharma-healthcare-compliance runs for workspaces on the pharma_healthcare industry and honours regulatedActor.

ai-laws is the canonical id; jurisdiction-detection is accepted as an input alias for backward compatibility with historical clients. New integrations should use ai-laws.

Note on rights-clearance variants. GET /agents exposes two registered agents for rights clearance: rights-clearance-text and rights-clearance-image — invoke them via POST /agents/{agentId} using those qualified IDs. On check response objects, however, text rights-clearance findings carry the bare agentId: "rights-clearance". Treat bare rights-clearance and rights-clearance-text as the same logical pipeline — the bare form is the value that appears on checks[] entries from that agent.

Available options:
ai-laws,
jurisdiction-detection,
advertising-law,
platform-policy,
metadata-labeling,
rights-clearance,
rights-clearance-text,
rights-clearance-image,
compliance-score,
fs-compliance-financial-promotion,
fs-compliance-advisory-suitability,
fs-compliance-credit-servicing,
fs-compliance-markets-trading,
fs-compliance-financial-crime,
fs-compliance-ai-governance,
financial-services-compliance,
pharma-healthcare-compliance

Body

application/json
jurisdictions
enum<string>[]
required
Minimum array length: 1
Available options:
us,
eu,
uk,
india,
china
platforms
enum<string>[]
required
Minimum array length: 1
Available options:
youtube,
instagram,
facebook,
tiktok,
linkedin
content
object
required
regulatedActor
enum<string>

Optional. Scopes the agent's rule set to one regulated actor.

Available options:
advertiser,
manufacturer,
platform,
provider,
payer,
pharmacy,
HCP,
telehealth_provider,
adviser,
broker_dealer,
bank,
lender,
servicer,
debt_collector,
fund_manager,
payment_service_provider,
insurer

Response

Agent result

requestId
string
required
agentId
enum<string>
required

Agent identifier. Use GET /agents to discover all available agents dynamically. The list is filtered to the industries your workspace has selected.

Financial services. The six fs-compliance-* agents correspond one-to-one to the review scopes (financial_promotion → fs-compliance-financial-promotion, and so on). In a full check they are selected with reviewScopes. Via POST /agents/{agentId} only fs-compliance-financial-promotion can be invoked directly today; the other five return 400 review_scope_not_enabled on direct invocation and must run through POST /compliance/check. financial-services-compliance is a read-only alias of fs-compliance-financial-promotion accepted for older clients.

Pharma and healthcare. pharma-healthcare-compliance runs for workspaces on the pharma_healthcare industry and honours regulatedActor.

ai-laws is the canonical id; jurisdiction-detection is accepted as an input alias for backward compatibility with historical clients. New integrations should use ai-laws.

Note on rights-clearance variants. GET /agents exposes two registered agents for rights clearance: rights-clearance-text and rights-clearance-image — invoke them via POST /agents/{agentId} using those qualified IDs. On check response objects, however, text rights-clearance findings carry the bare agentId: "rights-clearance". Treat bare rights-clearance and rights-clearance-text as the same logical pipeline — the bare form is the value that appears on checks[] entries from that agent.

Available options:
ai-laws,
jurisdiction-detection,
advertising-law,
platform-policy,
metadata-labeling,
rights-clearance,
rights-clearance-text,
rights-clearance-image,
compliance-score,
fs-compliance-financial-promotion,
fs-compliance-advisory-suitability,
fs-compliance-credit-servicing,
fs-compliance-markets-trading,
fs-compliance-financial-crime,
fs-compliance-ai-governance,
financial-services-compliance,
pharma-healthcare-compliance
checks
object[]
required
annotations
object[]
required
cached
boolean
required
creditsCharged
number
required
costBreakdown
object
required
analysisDiagnostics
object[]

Present only when the run produced pipeline diagnostics.

partial
boolean

Present and true when the agent returned a partial result.

error
string

Present when the agent failed; the findings array is then best-effort.

pricing
object

The pricing row that applied to this invocation.