HTTP API reference

50 operations. Each links to its Markdown page; the whole reference is/api/index.md and the description is /openapi.json.

health

• Healthz

  GET /api/v1/healthz Markdown

runs

• List Runs

  GET /api/v1/runs Markdown

• Create Run

  POST /api/v1/runs Markdown

• Get Run

  GET /api/v1/runs/{run_id} Markdown

• Signal Run

  POST /api/v1/runs/{run_id}/{signal} Markdown

• Validate Run

  POST /api/v1/runs/validate Markdown

• Delete Run

  POST /api/v1/runs/{run_id}/delete Markdown

artifact

• Get Artifact

  GET /api/v1/runs/{run_id}/artifact Markdown

• Get Issues

  GET /api/v1/runs/{run_id}/issues Markdown

• Get Issue

  GET /api/v1/runs/{run_id}/issues/{issue_id} Markdown

• Retest Issue

  POST /api/v1/runs/{run_id}/issues/{issue_id}/retest Markdown

• List Retests

  GET /api/v1/runs/{run_id}/issues/{issue_id}/retests Markdown

• Get Retest

  GET /api/v1/runs/{run_id}/issues/{issue_id}/retests/{retest_id} Markdown

• Get Verdicts

  GET /api/v1/runs/{run_id}/verdicts Markdown

• Get Opportunities

  GET /api/v1/runs/{run_id}/opportunities Markdown

• Get Tester Errors

  GET /api/v1/runs/{run_id}/tester-errors Markdown

shares

• Create Share Link

  POST /api/v1/runs/{run_id}/sessions/{session_id}/shares Markdown

• List Share Links

  GET /api/v1/runs/{run_id}/shares Markdown

• Revoke Share Link

  POST /api/v1/shares/{share_id}/revoke Markdown

sessions

• List Sessions

  GET /api/v1/runs/{run_id}/sessions Markdown

• Get Steps

  GET /api/v1/runs/{run_id}/sessions/{session_id}/steps Markdown

usage

• Get Usage

  GET /api/v1/usage Markdown

• Get Usage CSV

  GET /api/v1/usage.csv Markdown

• Billing Portal

  POST /api/v1/billing/portal Markdown

• Billing Overview

  GET /api/v1/billing Markdown

• Billing Auto Refill

  POST /api/v1/billing/auto-refill Markdown

• Billing Upgrade

  POST /api/v1/billing/subscription Markdown

• Billing Cancel

  DELETE /api/v1/billing/subscription Markdown

• Billing Setup

  POST /api/v1/billing/setup Markdown

• Billing Top Up

  POST /api/v1/billing/top-ups Markdown

• Billing Top Up Status

  GET /api/v1/billing/top-ups/{topup_id} Markdown

providers

• Codex Login

  POST /api/v1/providers/codex/login Markdown

• Codex Status

  GET /api/v1/providers/codex Markdown

• Codex Disconnect

  POST /api/v1/providers/codex/disconnect Markdown

credentials

• List Credentials

  GET /api/v1/credentials Markdown

• Create Credential

  POST /api/v1/credentials Markdown

• Delete Credential

  DELETE /api/v1/credentials/{name} Markdown

• List GitHub Installations

  GET /api/v1/github/installations Markdown

identity

• Who Am I

  GET /api/v1/me Markdown

• List API Keys

  GET /api/v1/api-keys Markdown

• Create API Key

  POST /api/v1/api-keys Markdown

• Revoke API Key

  DELETE /api/v1/api-keys/{key_id} Markdown

files

• List Files

  GET /api/v1/files Markdown

• Upload File

  POST /api/v1/files Markdown

• Get File

  GET /api/v1/files/{file_id} Markdown

• Delete File

  POST /api/v1/files/{file_id}/delete Markdown

personas

• List Personas

  GET /api/v1/personas Markdown

• Get Persona

  GET /api/v1/personas/{address} Markdown

blobs

• Get Blob

  GET /api/v1/blobs Markdown

• Head Blob

  HEAD /api/v1/blobs Markdown