Frequently asked questions

# 1. Replay with the original key and body: 200 with the answer, or 202 while pending
curl -sS -i https://api.opentype.dev/v1/runs \
  -H "Authorization: Bearer $OPENTYPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: ticket-4822-triage" \
  -d @ticket-4822-triage.json

# 2. Read the run by id
curl -sS https://api.opentype.dev/v1/runs/run_a4314b6cc08f4bd8814099a613abeb44 \
  -H "Authorization: Bearer $OPENTYPE_API_KEY"

const API = "https://api.opentype.dev";
const auth = { Authorization: `Bearer ${process.env.OPENTYPE_API_KEY}` };

// Replay with the ORIGINAL Idempotency-Key and body after a client-side timeout.
async function recover(idempotencyKey: string, body: object) {
  const res = await fetch(`${API}/v1/runs`, {
    method: "POST",
    headers: { ...auth, "Content-Type": "application/json", "Idempotency-Key": idempotencyKey },
    body: JSON.stringify(body),
    signal: AbortSignal.timeout(160_000),
  });
  const run = await res.json();
  if (res.status === 200) return run; // settled: completed (with its answer) or failed
  if (res.status === 202) {
    // Not finished. Read it again by id once its deadline has passed.
    await new Promise((r) => setTimeout(r, 120_000));
    const again = await fetch(`${API}/v1/runs/${run.run_id}`, { headers: auth }).then((r) => r.json());
    if (again.state === "pending") throw new Error(`run ${run.run_id} is stuck: resend with a new Idempotency-Key`);
    return again;
  }
  throw new Error(`${run.error.code} (${run.error.request_id})`);
}

import os, time
import requests

API = "https://api.opentype.dev"
AUTH = {"Authorization": f"Bearer {os.environ['OPENTYPE_API_KEY']}"}

def recover(idempotency_key: str, body: dict) -> dict:
    """Replay with the ORIGINAL Idempotency-Key and body after a client-side timeout."""
    res = requests.post(f"{API}/v1/runs", headers={**AUTH, "Content-Type": "application/json", "Idempotency-Key": idempotency_key},
                        json=body, timeout=160)
    run = res.json()
    if res.status_code == 200:
        return run  # settled: completed (with its answer) or failed
    if res.status_code == 202:
        time.sleep(120)  # let its deadline pass, then read it by id
        again = requests.get(f"{API}/v1/runs/{run['run_id']}", headers=AUTH, timeout=30).json()
        if again["state"] == "pending":
            raise RuntimeError(f"run {run['run_id']} is stuck: resend with a new Idempotency-Key")
        return again
    raise RuntimeError(f"{run['error']['code']} ({run['error']['request_id']})")