ASAP API Keys API

openapi: 3.2.0
info:
  title: ASAP Platform API Keys API
  description: 'Public HTTP API for ASAP Platform (api.asap.cool).


    All `/v1` responses are wrapped in a standard envelope. Success responses are `{ "data": , "meta": { "request_id", "next_cursor"?, "has_more"? } }` — the schema documented for each operation describes the inner `data` value. Errors are `{ "error": { "code", "message", "field"?, "request_id" } }`. Every response also carries an `X-Request-Id` header matching `meta.request_id` / `error.request_id`.'
  license:
    name: BUSL-1.1
  version: 0.0.0
servers:
- url: https://api.asap.cool
  description: Production
tags:
- name: API Keys
  description: Programmatic credentials for the public API.
paths:
  /v1/api-keys:
    get:
      tags:
      - API Keys
      summary: GET /v1/api-keys
      operationId: listApiKeys
      responses:
        '200':
          description: API keys for the active org.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiKeyView'
        '401':
          description: Caller is not a session user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
    post:
      tags:
      - API Keys
      summary: POST /v1/api-keys
      operationId: createApiKey
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRequest'
        required: true
      responses:
        '201':
          description: Key created; plaintext token returned once.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateResponse'
        '401':
          description: Caller is not a session user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '402':
          description: No active API key slot left on the org's plan.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Invalid label length, or unknown/unavailable scope requested.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
  /v1/api-keys/{id}:
    delete:
      tags:
      - API Keys
      summary: DELETE /v1/api-keys/{id}
      operationId: revokeApiKey
      parameters:
      - name: id
        in: path
        description: Api key identifier.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Key revoked (or already revoked, idempotent).
        '401':
          description: Caller is not a session user, or key belongs to another org.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
components:
  schemas:
    ErrorBody:
      type: object
      description: 'Generic error body returned by API handlers when they fail. `code` is a

        stable machine-readable token; `message` is human-friendly and meant for

        surfacing to end users.'
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: Stable machine token (e.g. `invalid_credentials`).
        field:
          type:
          - string
          - 'null'
          description: Offending request field for validation errors, when known.
        message:
          type: string
          description: Human-readable message.
    ApiKeyView:
      type: object
      description: One row in the `GET /v1/api-keys` response.
      required:
      - id
      - label
      - prefix
      - scopes
      - env
      - created_at
      properties:
        created_at:
          type: string
          description: RFC3339 creation timestamp.
        env:
          type: string
          description: '`live` or `test`.'
        id:
          type: string
          format: uuid
          description: Row id.
        label:
          type: string
          description: Display label.
        last_used_at:
          type:
          - string
          - 'null'
          description: RFC3339 last-used timestamp, if ever.
        prefix:
          type: string
          description: 17-char lookup prefix (safe to display in UI).
        revoked_at:
          type:
          - string
          - 'null'
          description: RFC3339 revocation timestamp, if any.
        scopes:
          type: array
          items:
            type: string
          description: Granted scopes as wire-format strings.
    CreateRequest:
      type: object
      description: Body of `POST /v1/api-keys`.
      required:
      - label
      properties:
        label:
          type: string
          description: Human label shown in the SPA list.
        scopes:
          type: array
          items:
            type: string
          description: Wire-format scopes to grant (e.g. `["contacts:read"]`).
    CreateResponse:
      allOf:
      - $ref: '#/components/schemas/ApiKeyView'
        description: Persisted key metadata.
      - type: object
        required:
        - token
        properties:
          token:
            type: string
            description: Plaintext token in clear. Display once, never store.
      description: 'Response body of `POST /v1/api-keys` — surfaces the plaintext token

        for the first and only time.'
  securitySchemes:
    api_key:
      type: http
      scheme: bearer
    session:
      type: apiKey
      in: cookie
      name: asap_session