About the REST API

The XPlor3 REST API is the same API the studio uses. Its endpoints, validation, prices and refund rules are no different: an API key simply takes the place of a signed-in session.

Base URLCopy Anchor Link

https://api.xplor3.space/v1

Every endpoint in these docs is relative to that address.

AuthenticationCopy Anchor Link

Send your API key in the Authorization header of every request:

Authorization: Bearer xpk_your_key

A request with no key, or with a wrong, revoked or expired one, is answered 401 UNAUTHORIZED. Starting a generation needs an account with a verified email; otherwise the answer is 403 EMAIL_UNVERIFIED.

Test your first keyCopy Anchor Link

curl https://api.xplor3.space/v1/wallet \
  -H "Authorization: Bearer $XPLOR3_API_KEY"

A successful answer holds your balance and the last 20 credit entries:

{
  "balance": 120.4,
  "ledger": [
    {
      "id": "cm...",
      "delta": -9.6,
      "reason": "JOB_DEBIT",
      "jobId": "cm...",
      "orderId": null,
      "createdAt": "2026-10-23T08:12:44.120Z"
    }
  ]
}

FormatCopy Anchor Link

• JSON requests and responses, with Content-Type: application/json for bodies. The exception is multipart file uploads.
• Credits are decimal numbers, for example 9.6.
• Times are ISO 8601 in UTC, for example 2026-10-23T08:12:44.120Z.
• Error messages follow Accept-Language: en for English, Indonesian otherwise.
• Long lists are paginated with limit (at most 50) and cursor. The answer carries items and nextCursor; send nextCursor back as cursor for the next page until it is null.

Next stepsCopy Anchor Link