API reference

The 129 routes of the published API contract, generated from it. The CLI and the TypeScript SDK call the same routes, so anything you can do from them you can do over HTTP.

Basics

Base URL: https://api.promigence.ai. Requests and answers are JSON unless a route says otherwise.
Authentication: Authorization: Bearer <API key>. Create a key with promigence keys create or in the console; promigence login stores one for the CLI and the SDK.
Errors: an answer that is not a success carries {"error": {...}} with a stable code, a message, a fix, the CLI exit code, its category, retryable and a request_id. Every error code
Retries: send an Idempotency-Key header with a create, and a retry of the same request starts, and bills, once.
The contract itself, the document this page is generated from, as OpenAPI 3.1 for client generators and tools: /openapi.json

Two sandboxes, one command each, capped at $1

bash

curl -s https://api.promigence.ai/v1/runs \
  -H "Authorization: Bearer $PROMIGENCE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"snapshot": "promigence/base", "count": 2, "spend_cap": 1, "exec": {"sh": "python3 -c \"print(6*7)\""}}'