Skip to content
DocsDevelopers

API keys

Workspace-scoped access to instances and SSH keys.

Create a key

Choose a name and Read only or Read & write access. Copy the secret immediately: it is shown once, and PomPod stores only its hash. Store it in your application’s secret manager.

Manage API keys

Permissions

Send Authorization: Bearer YOUR_KEY to https://pompod.ai/api/v1. A key is confined to the workspace that created it. Read-only keys can list instances and SSH keys. Read & write keys can launch, rename, and terminate instances and manage SSH keys. Billing, settings, workspace management, and admin endpoints require a signed-in browser session. Revoking a key stops subsequent requests.

Available endpoints

  1. 1

    GET /api/v1/catalog

    Public live catalog, including configuration ID, current availability, and customerRate in USD millionths per hour.

  2. 2

    GET /api/v1/instances

    List instances in the key’s workspace.

  3. 3

    POST /api/v1/instances

    Send name, catalogId, template (PyTorch, Jupyter, or Ubuntu), sshKeyId, and quotedRate matching customerRate. Include a unique Idempotency-Key of 16–100 letters, numbers, underscores, or dashes. Reuse that key for retries of the exact same request.

  4. 4

    PATCH or DELETE /api/v1/instances/{id}

    PATCH with a name renames the instance. DELETE requests irreversible termination; check its status until destruction is confirmed.

  5. 5

    GET or POST /api/v1/ssh-keys

    List keys, or create a key using name and publicKey. DELETE /api/v1/ssh-keys/{id} removes an unused key.