A-00 OVERVIEW
One key. Five production surfaces.
Generate video, images, music, multimodal routes, and persistent agents through one production API.
curl https://api.arkie.ai/v2/me \
-H "Authorization: Bearer $ARKIE_API_KEY"A-01 QUICKSTART
Ship your first request
Arkie uses standard HTTPS. Add your Bearer key, choose a family, and send JSON.
none
HTTPS
optional
Never expose a live key in a browser bundle or public repository.
A-02 AUTHENTICATION
Authenticate every request
Use the same Bearer token across production REST, queue, and regional hosts.
Environment variable
Store the key in your server environment and rotate it from the dashboard when needed.
export ARKIE_API_KEY=arkie_live_...Narrow scopes
Create limited keys for CI and individual families to reduce blast radius.
video:generatefamily:*read:usagewrite:filesA-03 BASE URLS
Choose the execution surface
Production, sandbox, queue, realtime, and regional hosts share one contract shape.
A-04 MODEL FAMILIES
Five surfaces, one production graph
Pin a specialist when the contract cannot drift. Use Ultra when the product should behave like one brain.
B-00 API REFERENCE
Every documented operation
Filter by family or search by path, capability, and description. Select an operation to view request examples.
Try a family name, path, or capability.
C-01 WEBHOOKS & OBSERVABILITY
Observe every long-running job
Poll jobs, subscribe over SSE, or receive a signed webhook when assets settle.
Verify the raw request body before parsing JSON. Do not parse the human-readable error message.
C-02 ERRORS
Stable error envelopes
Every error returns JSON with code, message, parameter, retryability, and a documentation link.
{ code, message, param, retryable, docs }