API reference

Quick start

Send each request to https://www.sirv.studio with your API key as a bearer token. This request removes the background from a product image:

curl https://www.sirv.studio/api/tools/remove-background \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"image_url": "https://example.com/product.jpg"}'

For this background-removal request, read the result URLs from images. The response also shows the remaining workspace credits. Other tools can return different fields, as listed in their endpoint reference:

{
  "images": [{ "url": "https://example.com/result.png" }],
  "image": { "url": "https://example.com/result.png" },
  "credits_remaining": 241
}

Authentication

Create a key on the API keys page in your workspace settings. Keys start with sk_live_. We show a key once, so store it in a secret manager.

A key acts as the person who created it, in the workspace where they created it. Requests get that person's permissions, so a key can do no more than they can in the app.

API access depends on your plan. Some plans allow read requests only.

Credits

Requests that run a paid AI operation use workspace credits at the same price as in the app. The endpoint list marks these requests. Processing responses can include credits_remaining. Check the endpoint’s response fields and the job’s credit outcome before retrying a failed request.

Rate limits

Limits apply per hour and depend on your plan. Read requests (GET) and write requests have separate limits. Rate-limited endpoints send these headers:

Errors

Errors return JSON with a readable message in error. Most errors also have a stable code that your integration can match:

{
  "error": "Insufficient credits. Required: 2, Available: 0",
  "code": "INSUFFICIENT_CREDITS",
  "credits_required": 2,
  "credits_available": 0
}