Skip to main content

​
Just getting started?

Start with the introduction or pick a door: Identify an account or embed an agent.

​
Base URL

The API is REST. Resource-oriented URLs, JSON request bodies, JSON responses, standard HTTP verbs and status codes. Every response is an envelope:
or
Unknown fields are omitted — we do not send nulls. See Errors.

​
Authentication

Authenticate with a bearer token on every request.
The credential’s form selects the Loom mode: a JWT is direct; anything else is relay. Details in Authentication.

​
Products

Identify

Resolve a bank or wallet identifier. Live.

Loom

Threads, messages, runs, traces, outcomes. Live.

FX rates

Coming soon.

Extract

Coming soon.

Vision

Coming soon.
The dashboard API (/api/*) is not part of this reference. It is for the studio, not for your product.

​
Versioning

Public endpoints live under /v1. Breaking changes get a new prefix. Additive fields may appear on existing objects without a version bump.

​
Rate limits

Requests are rate-limited per workspace. A limited call returns 429 with RATE_LIMITED and a Retry-After header. Successful calls include RateLimit-Limit and RateLimit-Remaining.

​
Idempotency

Identify is a lookup — repeat a call and you get the same resolution (and another charge if the result is identified). Loom messages start a run; do not retry a 202 unless you intend a second turn. Outcome posts are safe to retry: a tool call that already has an outcome is a no-op.

​
Credits

We charge outcomes, not requests. An identified result on Identify. A closed Loom run that is not a platform failure. Promo credits cover first calls. There is no complimentary test lane. 402 means the workspace is out of credits.