Create an API key
Keys live in the arbitr UI. The API cannot mint one for you.
Create Key
-
Log in to arbitr.
-
Open Settings → API Keys.
-
Click Create key.
-
Give it a name you will recognise later (for example
Production integration). -
Leave the mode on Live — real projects, real credits, prefix
abr_live_….The Test option (
abr_test_…) returns canned responses without running the pipeline or charging credits. It checks auth, scopes and request shape; it cannot tell you whether a real project will succeed. Read Test mode before choosing it. -
Select at least one scope. For the usual submit → poll → download flow, pick both:
verify:submit— create projects and resume after paymentverify:read— list projects, poll status, download deliverables
- Click Create key.
Copy the plain text immediately. It is shown once and never stored. After you close that card, the list only shows the prefix (abr_live_… / abr_test_…).
If you lose the key, Revoke it and create a new one. Revoke cannot be undone; anything still using that key fails at once.
How to Use it
Send it on every request:
X-API-Key: abr_live_…
Same host for test and live — only the prefix changes.
Check what the key can do:
curl -s https://api-arbitr.straker.ai/v1/me \
-H "X-API-Key: abr_live_…"
GET /v1/me works with any valid key. A call outside the key’s scopes returns 403 insufficient_scope.