Skip to content
Theme
Upload a photo Upload
Theme
Theme
Upload a photo

Developers

Developer overview

What the MutexAI Studio API does today, what is coming, the base URL, conventions and where to start.

On this page
  1. What you can do today
  2. Coming soon
  3. Base URL
  4. Conventions
  5. Where to go next

The MutexAI Studio API lets your app, shop or back office use your Studio account over HTTPS. It is a JSON REST API with API-key authentication, a free sandbox and signed webhooks.

curl
# Your test key from Developers → API keys. Keep it out of your code and your Git history.
export MUTEXAI_API_KEY="mx_test_..."

curl https://studio-api.mutexai.net/v1/balance \
  -H "Authorization: Bearer $MUTEXAI_API_KEY"
Response
{
  "object": "balance",
  "available": 1000,
  "livemode": false,
  "as_of": "2026-11-17T09:30:12Z"
}

What you can do today#

EndpointWhat it doesScope
GET /v1/healthChecks the API is up. No key needed.none
GET /v1/balanceYour available credits.balance:read
GET /v1/ledgerYour credit history, newest first.ledger:read
GET /v1/webhook-endpointsLists your webhook endpoints.webhooks:manage
POST /v1/webhook-endpointsRegisters an endpoint and returns its signing secret once.webhooks:manage
GET /v1/webhook-endpoints/{id}Gets one endpoint.webhooks:manage
DELETE /v1/webhook-endpoints/{id}Deletes an endpoint and stops its deliveries.webhooks:manage
GET /v1/events/{id}Fetches an event you received, to confirm it came from us.webhooks:manage

Every parameter and field is in the API reference, generated from openapi.json (OpenAPI 3.1). Import that file into Postman, Insomnia or a code generator.

Coming soon#

EndpointWhat it will do
POST /v1/uploadsUpload a poster or photo.
POST /v1/sets, GET /v1/sets, GET /v1/sets/{id}Make, list and read photo sets.
POST /v1/sets/{id}/confirmConfirm the detected colours.
POST /v1/sets/{id}/images/{image}/redoRedo one image, free within fair use.
POST /v1/backgrounds, GET /v1/backgrounds/{id}Remove, replace or make transparent backgrounds.
POST /v1/logos, GET /v1/logos/{id}Logo ideas, concepts, refinements, clean-up, SVG and brand kits.

Jobs that spend credits will be asynchronous: the POST answers 202 with "status": "queued", and you get a webhook (or poll) when the job is succeeded or failed. They will require an Idempotency-Key.

Base URL#

Base URL
https://studio-api.mutexai.net

All requests use HTTPS. The major version is in the path (/v1). See Versioning.

Conventions#

  • JSON in and out. Send Content-Type: application/json with a body. Responses are application/json, and errors are application/problem+json.
  • Every object has an object field, such as "balance", "list" or "webhook_endpoint".
  • IDs have a prefix that tells you the type: we_ webhook endpoint, evt_ event, le_ ledger entry, key_ API key. Treat IDs as opaque strings.
  • livemode is on every object: true for live keys, false for test keys.
  • Times are ISO 8601 in UTC, for example 2026-11-17T09:30:12Z.
  • Credits are whole numbers. Negative values in the ledger are credits leaving your available balance.
  • Every response has an X-Request-Id header. Log it. It is the fastest way for us to find a request.
  • Another account's ID returns 404, never 403, so IDs cannot be probed.

Where to go next#

  1. Quickstart: your first call.
  2. Authentication: keys, scopes and IP allowlists.
  3. Webhooks: get told when things happen.

Still stuck? Email [email protected] with what you tried and, for API problems, the request_id.

Type at least 2 letters. Use the arrow keys to move and Enter to open.

    Type at least 2 letters. Use the arrow keys to move and Enter to open.