Azurade AI Account API

openapi: 3.2.0
info:
  contact:
    email: support@azurade.com
    name: Azurade AI support
  description: 'Image and video generation, prompt tools and account access for Azurade AI.


    Credits: one balance per account, shared with the web app, same prices. Credits do not expire and are not reset by any billing cycle. A failed generation is refunded automatically. Prices are in credits; the model catalogue carries the price of a default request and POST /api/v2/generations/estimate the exact price of a specific one.


    Errors: every non-2xx body is {"error": , "code": }. Codes worth handling: unknown_model, validation_failed, insufficient_credits (402; POST /api/v2/checkout returns a link for the account holder to buy more), prompt_rejected (400, revise the prompt, do not retry it unchanged), moderation_unavailable and enhance_unavailable (503, safe to retry), generation_failed (502, the job could not be started and nothing was charged; its id is in the body and GET /api/v2/generations/{id} carries the reason), not_found (404, also for records that belong to another account).


    Generations are asynchronous: POST answers 202 with an id, GET /api/v2/generations/{id} moves from pending to completed or failed, and completed carries the output files. The files are attached a moment after the status turns completed, so poll until status is failed, or completed with a non-empty outputs array.'
  title: Azurade AI Account API
  version: '2'
servers:
- url: https://azurade.com
tags:
- description: Who the credentials belong to, what the balance is, and a checkout link to buy more credits.
  name: Account
paths:
  /api/v2/account:
    get:
      description: The account behind the credentials and its current credit balance.
      operationId: getAccount
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Invalid request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Missing or invalid credentials
      security:
      - ApiKeyAuth: []
      - SessionAuth: []
      summary: Account and credit balance
      tags:
      - Account
  /api/v2/checkout:
    post:
      description: 'Starts a card checkout for a credit pack (100 or 1000 credits) on this account and returns its link and price. Send the account holder''s country for what they will pay: subtotal, the sales tax or VAT as tax, and total, in that country''s currency, or in currency when sent. The checkout opens with the same country and currency, and does not let them change the country. Without a country only the subtotal comes back, before tax: the checkout adds the tax, and may switch to the local currency, of the country they pick there. They open the link and pay, and the credits are added the moment the payment goes through. Credits never expire. Each call is a new single-use checkout. Prices before tax: 3.99 USD for 100 credits, 29.99 USD for 1000 credits.'
      operationId: createCheckout
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Checkout'
          description: Created
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Invalid request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Missing or invalid credentials
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 'checkout_failed: the payment provider did not answer; retry in a moment'
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 'billing_unavailable: buying credits is switched off'
      security:
      - ApiKeyAuth: []
      - SessionAuth: []
      summary: Buy credits
      tags:
      - Account
components:
  schemas:
    Checkout:
      properties:
        checkout_url:
          description: Single-use card checkout for the account holder to open
          format: uri
          type: string
        country:
          description: ISO 3166-1 alpha-2 code of the country priced for, which the checkout opens with and does not let the account holder change. Absent when none was sent
          type: string
        credits:
          description: Credits added when the payment goes through
          type: number
        currency:
          description: ISO 4217 code of the amounts
          type: string
        pack:
          type: string
        subtotal:
          description: The price before tax, in currency
          type: number
        tax:
          description: 'Sales tax or VAT in country, in currency. Absent when no country was sent: the checkout then adds the tax of the country the account holder picks'
          type: number
        total:
          description: What the account holder pays, tax included, in currency. Absent when no country was sent
          type: number
      type: object
    Account:
      properties:
        credits:
          type: number
        email:
          type: string
        id:
          type: string
      type: object
    Error:
      properties:
        balance:
          type: number
        code:
          type: string
        cost:
          type: number
        error:
          type: string
        id:
          description: The failed generation, on generation_failed
          type: string
      required:
      - error
      - code
      type: object
    CheckoutRequest:
      additionalProperties: false
      properties:
        country:
          description: The account holder's country as an ISO 3166-1 alpha-2 code, such as DE. A code the checkout does not take, or a country payments are not available in, answers 400 invalid_billing
          type: string
        currency:
          description: ISO 4217 code, such as EUR, to price in instead of the country's own currency. A code the checkout does not take answers 400 invalid_billing
          type: string
        pack:
          description: Credits in the pack
          enum:
          - '100'
          - '1000'
          type: string
      required:
      - pack
      type: object
  securitySchemes:
    ApiKeyAuth:
      bearerFormat: sk-...
      description: 'API key as `Authorization: Bearer sk-...`. The same secret is also accepted in an `X-API-Key` header, with or without the `Bearer ` prefix. Keys are created and deleted on the profile page; a key signs the routes in this document, can revoke itself at /api/oauth/revoke, and cannot create keys, delete other keys or change the account. It can start a checkout, which only a person paying by card completes.'
      scheme: bearer
      type: http
    SessionAuth:
      description: PocketBase session token, as issued to the web app.
      in: header
      name: Authorization
      type: apiKey