Developers

Quick start

1. Sign in, then create a key below. The plaintext key is shown once.
2. Upload a file (POST /api/v1/uploads) and keep the returned objectKey.
3. Create a job (POST /api/v1/jobs) and poll GET /api/v1/jobs/{id} until outputs appear.
4. Check quota any time via GET /api/v1/usage.

curl -s https://www.aimp6.com/openapi.json | head -40

# 1. proxy upload
curl -s -X POST https://www.aimp6.com/api/v1/uploads \
  -H "Authorization: Bearer aimp6_live_XXXX" \
  -F "[email protected]"
# -> { "mode":"direct", "objectKey":"inputs/.../interview.mp3" }

# 2. create job
curl -s -X POST https://www.aimp6.com/api/v1/jobs \
  -H "Authorization: Bearer aimp6_live_XXXX" \
  -H "content-type: application/json" \
  -d '{"tool":"ai-subtitles","objectKey":"inputs/.../interview.mp3"}'
# -> 202 { "jobId":"job_...", "poll":"/api/v1/jobs/job_..." }

# 3. poll
curl -s https://www.aimp6.com/api/v1/jobs/job_... \
  -H "Authorization: Bearer aimp6_live_XXXX"

Authentication & limits

Send Authorization: Bearer aimp6_live_... on every call. Keys are stored as HMAC-SHA256 hashes; revoking a key takes effect immediately.

• Default quota: 200 requests/day per key (UTC reset). Exceeding it returns 429 with a Retry-After header.
• Every response carries x-request-id, x-ratelimit-limit and x-ratelimit-remaining.
• Credits are shared with your site account balance; failed jobs are refunded automatically.

Error codes