Exoscale AI API Key API

The ai-api-key API from Exoscale — 3 operation(s) for ai-api-key.

GitHub OpenAPI
Business capability
Developer Identity & Credential Management BC-4270.40

Operations 8

DELETE /ai/api-key/{id} [BETA] Delete AI API Key #
GET /ai/api-key/{id} [BETA] Get AI API Key #
PATCH /ai/api-key/{id} [BETA] Update AI API Key #
POST /ai/api-key/{id}/rotate [BETA] Rotate AI API Key #
GET /ai/api-key/{id}/reveal [BETA] Reveal AI API Key #
GET /ai/api-key [BETA] List AI API Keys #
POST /ai/api-key [BETA] Create AI API Key #
GET /ai/quota [BETA] Get Organization Consumption Quota #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/exoscale:exoscale-ai-api-key-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

exoscale-ai-api-key-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: 2.0.0
  termsOfService: https://exoscale.com/terms
  contact:
    email: support@exoscale.com
    name: Exoscale Support
    url: https://portal.exoscale.com/tickets
  title: Exoscale AI API Key API
  description: Infrastructure automation API, allowing programmatic access to all Exoscale products and services.
servers:
- url: https://api-{zone}.exoscale.com/v2
  variables:
    zone:
      default: ch-gva-2
      enum:
      - ch-gva-2
      - ch-dk-2
      - de-fra-1
      - de-muc-1
      - at-vie-1
      - at-vie-2
      - bg-sof-1
      - hr-zag-1
tags:
- description: API keys for accessing inference deployments.
  parent: ai
  externalDocs:
    description: Read more
    url: https://www.exoscale.com/ai-cloud-infrastructure/managed-inference/
  name: ai-api-key
  x-display-name: AI API Key
  x-weight: 940
  x-icon: exo-license
paths:
  /ai/api-key/{id}:
    delete:
      tags:
      - ai-api-key
      responses:
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/operation'
      description: Delete AI API key
      parameters:
      - in: path
        required: true
        name: id
        schema:
          type: string
          format: uuid
      summary: '[BETA] Delete AI API Key'
      operationId: delete-ai-api-key
    get:
      tags:
      - ai-api-key
      responses:
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get-ai-api-key-response'
      description: Get AI API key metadata
      parameters:
      - in: path
        required: true
        name: id
        schema:
          type: string
          format: uuid
      summary: '[BETA] Get AI API Key'
      operationId: get-ai-api-key
    patch:
      tags:
      - ai-api-key
      responses:
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/update-ai-api-key-response'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
      description: Update AI API key name and/or scope
      parameters:
      - in: path
        required: true
        name: id
        schema:
          type: string
          format: uuid
      summary: '[BETA] Update AI API Key'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update-ai-api-key-request'
      operationId: update-ai-api-key
  /ai/api-key/{id}/rotate:
    post:
      tags:
      - ai-api-key
      responses:
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rotate-ai-api-key-response'
      description: Rotate AI API key value
      parameters:
      - in: path
        required: true
        name: id
        schema:
          type: string
          format: uuid
      summary: '[BETA] Rotate AI API Key'
      operationId: rotate-ai-api-key
  /ai/api-key/{id}/reveal:
    get:
      tags:
      - ai-api-key
      responses:
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reveal-ai-api-key-response'
      description: Reveal AI API key plaintext value
      parameters:
      - in: path
        required: true
        name: id
        schema:
          type: string
          format: uuid
      summary: '[BETA] Reveal AI API Key'
      operationId: reveal-ai-api-key
  /ai/api-key:
    get:
      tags:
      - ai-api-key
      responses:
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list-ai-api-keys-response'
      description: List AI API keys for an organization
      parameters: []
      summary: '[BETA] List AI API Keys'
      operationId: list-ai-api-keys
    post:
      tags:
      - ai-api-key
      responses:
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/create-ai-api-key-response'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
      description: Create a new AI API key
      parameters: []
      summary: '[BETA] Create AI API Key'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create-ai-api-key-request'
      operationId: create-ai-api-key
  /ai/quota:
    get:
      tags:
      - ai-api-key
      responses:
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-response'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/org-consumption-quota-response'
      description: Get per-org Unit Of Measurement (UOM) consumption quota (UOM/min). Null means unlimited. UOM represents weighted units across different AI workloads (e.g., tokens for LLMs, minutes for TTS, pages for OCR).
      parameters: []
      summary: '[BETA] Get Organization Consumption Quota'
      operationId: get-user-org-consumption-quota
components:
  schemas:
    create-ai-api-key-request:
      description: Request to create a new AI API key
      properties:
        name:
          description: Human-readable name for the AI API key
          type: string
          minLength: 1
          maxLength: 50
          pattern: ^[A-Za-z0-9](?:[A-Za-z0-9 _'()-]*[A-Za-z0-9])?$
        scope:
          description: 'Key scope: ''public'' for all deployments, or a specific deployment UUID'
          type: string
      type: object
      required:
      - name
      - scope
    rotate-ai-api-key-response:
      description: Rotate AI API key response
      properties:
        value:
          description: Plaintext AI API key value
          type: string
      type: object
      required:
      - value
    update-ai-api-key-request:
      description: Request to update an AI API key (at least one property required)
      properties:
        name:
          description: Human-readable name for the AI API key
          type: string
          minLength: 1
          maxLength: 50
          pattern: ^[A-Za-z0-9](?:[A-Za-z0-9 _'()-]*[A-Za-z0-9])?$
        scope:
          description: 'Key scope: ''public'' for all deployments, or a specific deployment UUID'
          type: string
      type: object
      minProperties: 1
    create-ai-api-key-response:
      description: Create AI API key response
      properties:
        updated-at:
          description: Last update timestamp
          format: date-time
          type: string
          readOnly: true
        name:
          description: Human-readable name for the AI API key
          type: string
        value:
          description: Plaintext AI API key value
          type: string
        scope:
          description: 'Key scope: ''public'' for all deployments, or a specific deployment UUID'
          type: string
        id:
          description: AI API key ID
          format: uuid
          type: string
          readOnly: true
        org-uuid:
          description: Organization UUID that owns this key
          format: uuid
          type: string
          readOnly: true
        created-at:
          description: Creation timestamp
          format: date-time
          type: string
          readOnly: true
      type: object
      required:
      - id
      - org-uuid
      - name
      - scope
      - created-at
      - updated-at
      - value
    update-ai-api-key-response:
      description: Update AI API key response
      properties:
        updated-at:
          description: Last update timestamp
          format: date-time
          type: string
          readOnly: true
        name:
          description: Human-readable name for the AI API key
          type: string
        scope:
          description: 'Key scope: ''public'' for all deployments, or a specific deployment UUID'
          type: string
        id:
          description: AI API key ID
          format: uuid
          type: string
          readOnly: true
        org-uuid:
          description: Organization UUID that owns this key
          format: uuid
          type: string
          readOnly: true
        created-at:
          description: Creation timestamp
          format: date-time
          type: string
          readOnly: true
      type: object
      required:
      - id
      - org-uuid
      - name
      - scope
      - created-at
      - updated-at
    get-ai-api-key-response:
      description: Get AI API key response
      properties:
        updated-at:
          description: Last update timestamp
          format: date-time
          type: string
          readOnly: true
        name:
          description: Human-readable name for the AI API key
          type: string
        scope:
          description: 'Key scope: ''public'' for all deployments, or a specific deployment UUID'
          type: string
        id:
          description: AI API key ID
          format: uuid
          type: string
          readOnly: true
        org-uuid:
          description: Organization UUID that owns this key
          format: uuid
          type: string
          readOnly: true
        created-at:
          description: Creation timestamp
          format: date-time
          type: string
          readOnly: true
      type: object
      required:
      - id
      - org-uuid
      - name
      - scope
      - created-at
      - updated-at
    org-consumption-quota-response:
      description: Per-org Unit Of Measurement (UOM) consumption quota response
      properties:
        quota-uom-per-minute:
          description: Per-org Unit Of Measurement (UOM) consumption quota (UOM/min). Null means unlimited. UOM represents weighted units across different AI workloads (e.g., tokens for LLMs, minutes for TTS, pages for OCR).
          type:
          - integer
          - 'null'
          minimum: 0
      type: object
    error-response:
      type: object
      description: RFC 9457 Problem Details error response
      required:
      - type
      - title
      - status
      - detail
      properties:
        type:
          type: string
          format: uri-reference
          description: An absolute or relative URI reference pointing to human-readable documentation concerning the specific problem type encountered.
        title:
          type: string
          description: A brief summary defining the class of failure, optimal for quick user interface groupings.
        status:
          type: integer
          minimum: 100
          maximum: 599
        detail:
          type: string
          description: A highly contextual, readable explanation breaking down explicitly what triggered this error scenario.
    list-ai-api-keys-response-entry:
      description: AI API key list entry
      properties:
        updated-at:
          description: Last update timestamp
          format: date-time
          type: string
          readOnly: true
        name:
          description: Human-readable name for the AI API key
          type: string
        scope:
          description: 'Key scope: ''public'' for all deployments, or a specific deployment UUID'
          type: string
        id:
          description: AI API key ID
          format: uuid
          type: string
          readOnly: true
        org-uuid:
          description: Organization UUID that owns this key
          format: uuid
          type: string
          readOnly: true
        created-at:
          description: Creation timestamp
          format: date-time
          type: string
          readOnly: true
      type: object
      required:
      - id
      - org-uuid
      - name
      - scope
      - created-at
      - updated-at
    reveal-ai-api-key-response:
      description: Reveal AI API key response
      properties:
        value:
          description: Plaintext AI API key value
          type: string
      type: object
      required:
      - value
    list-ai-api-keys-response:
      description: List of AI API keys
      properties:
        ai-api-keys:
          type: array
          items:
            $ref: '#/components/schemas/list-ai-api-keys-response-entry'
      type: object
      example:
        ai-api-keys:
        - updated-at: '2026-03-25T10:00:00Z'
          name: default-public-key
          scope: public
          id: 11111111-1111-1111-1111-111111111111
          org-uuid: 22222222-2222-2222-2222-222222222222
          created-at: '2026-03-25T10:00:00Z'
      required:
      - ai-api-keys
    operation:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: Operation ID
        reason:
          type: string
          enum:
          - incorrect
          - unknown
          - unavailable
          - forbidden
          - busy
          - fault
          - partial
          - not-found
          - interrupted
          - unsupported
          - conflict
          readOnly: true
          description: Operation failure reason
        reference:
          type: object
          properties:
            id:
              type: string
              format: uuid
              description: Reference ID
            link:
              type: string
              readOnly: true
              description: Link to the referenced resource
            command:
              type: string
              description: Command name
          description: Related resource reference
          readOnly: true
        message:
          type: string
          readOnly: true
          description: Operation message
        state:
          type: string
          enum:
          - failure
          - pending
          - success
          - timeout
          readOnly: true
          description: Operation status
      description: Operation
x-topics:
- title: API Request Signature
  content: '

    In order to authenticate legitimate users, the Exoscale API requires incoming requests to be signed using valid Exoscale API account credentials with the following mechanism.


    ## Signature Mechanism


    The *message* (i.e. content) to sign contains several segments concatenated using a line return character (`\n`).


    All segments must be included and in the described order. For cases where a segment doesn''t fit the context of the request (e.g. no request body) **an empty line must be used instead**.


    * Request method and request URL (path only), separated by a space character

    * Request body

    * Request URL parameters (Query String) values, concatenated without separator. The matching parameter names have to be specified in the resulting signature header `signed-query-args=` pragma, separated by semicolons (e.g. `p1;p2;pN`).

    * Request header values, concatenated without separator (none at the moment, leave empty)

    * Request expiration date in UNIX timestamp format


    Example *message* to sign for `GET /v2/resource/a02baf5a-a3e4-49a0-857b-8a08d276c1c0?p1=v1&p2=v2`:


    ```

    GET /v2/resource/a02baf5a-a3e4-49a0-857b-8a08d276c1c0


    v1v2


    1599140767

    ```


    The two blank lines above are due to the absence of a request body and signed headers.


    Example *message* to [create a security group](https://community.exoscale.com/reference/api/compute/security-group/#create-security-group)


    ```

    POST /v2/security-group

    {"name": "my-security-group"}



    1599140767

    ```


    The two blank lines above are due to the absence of query parameters and signed headers.


    The request signature consists of the base64-encoded [HMAC](https://en.wikipedia.org/wiki/HMAC) hash of the UTF-8 encoded *message* and the Exoscale API secret using the SHA265 function:


    ```

    signature = BASE64_ENCODE(HMAC_SHA256(Exoscale API secret, message))

    ```


    Finally, the computed signature must be added to the API request in a `Authorization` header such as:


    ```

    Authorization: EXO2-HMAC-SHA256 credential=<Exoscale API key>,expires=<expiration date UNIX timestamp>,signature=<signature>

    ```


    Example API query:


    ```

    GET /v2/resource/a02baf5a-a3e4-49a0-857b-8a08d276c1c0?p1=v1&p2=v2 HTTP/1.1

    Host: api-ch-gva-2.exoscale.com

    Authorization: EXO2-HMAC-SHA256 credential=EXO29147e9f89102b7ac1e88514,signed-query-args=p1;p2,expires=1599140767,signature=2AOBQsbElQb4FpKT/FM/9T4NobjlmZkSGvvdUth/xlY=

    ```


    ## Reference Implementations


    You can look up the following existing reference implementations:


    * Go: [github.com/exoscale/egoscale/api/v2 > `SecurityProviderExoscale.signRequest`](https://github.com/exoscale/egoscale/blob/master/v2/api/security.go)

    * Python: [requests-exoscale-auth > `ExoscaleV2Auth`](https://github.com/exoscale/requests-exoscale-auth/blob/master/exoscale_auth.py)


    '
- title: Zone local resources
  content: '

    The API is deployed across all Exoscale zones. When performing a compute call, you should use the relevant zone for your resource.

    For example: https://api-de-fra-1.exoscale.com/v2/instance would return only the instances from `de-fra-1`, https://api-ch-gva-2.exoscale.com/v2/instance from `ch-gva-2`.

    To obtain a list of all instances across all zones, you would need to do the corresponding request for each zone.

    '
x-provenance:
  method: harvested
  publisher: Exoscale
  source: https://openapi-v2.exoscale.com/source.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)