Getting Started

Authentication & Keys

API keys start with tp_live_ or tp_test_. Requests send the raw secret as a Bearer token. Secrets are hashed at rest using SHA-256.

Every request to the Transpera API is authenticated using an API key presented in the HTTP Authorization header. API keys are managed in the Developer Console and linked to an account wallet.

Header Format

curl https://transpera-api-dev-vv55i7vbvq-el.a.run.app/v1/operations \
  -H "authorization: Bearer tp_live_abc1234567890abcdef"

Live vs. Test Keys

PrefixLivemodeSpend BehaviorDefault Cap
tp_live_trueCharges wallet balance directlyNo artificial cap
tp_test_falseChecks wallet but enforces a spend limit450 credits (configurable in console)

Scopes & Permissions

jobs:writescoperequired

Allows requesting signed upload URLs and queueing new AI operations (POST /v1/uploads, POST /v1/jobs).

jobs:readscoperequired

Allows listing jobs and fetching public status and progress (GET /v1/jobs, GET /v1/jobs/{id}).

wallet:readscopeoptional

Allows checking available credit balance for the key's billing owner (GET /v1/wallet).