Desarrolladores

1 · Autenticación

Genera una clave "po_…" en Perfil → Claves API (solo el dueño de la oficina). Envíala en cada solicitud con la cabecera X-API-Key — la clave se muestra UNA SOLA VEZ al crearla.

2 · Poner un brief en cola

POST /api/v1/runs — devuelve 202; la ejecución es asíncrona. Campos: pixmate_slug, brief (≤20.000 caracteres), locale (tr|en).

curl -X POST https://pixel-office-api-production.up.railway.app/api/v1/runs \
  -H "X-API-Key: po_XXXXXXXXXXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{
    "pixmate_slug": "ava-generalist-marketer",
    "brief": "Yeni single için 6 sosyal medya postu yaz",
    "locale": "tr"
  }'
# → 202 Accepted
# { "id": "…", "status": "queued", "pixmate_slug": "ava-generalist-marketer", … }

3 · Ver resultado

GET /api/v1/runs (liste) · GET /api/v1/runs/{id}

curl https://pixel-office-api-production.up.railway.app/api/v1/runs/RUN_ID \
  -H "X-API-Key: po_XXXXXXXXXXXXXXXX"
# status: queued → running → completed | failed

4 · Límites de tasa

60 peticiones por minuto y clave. Al superarlo devuelve 429 + Retry-After; cada respuesta incluye las cabeceras X-RateLimit-Limit / X-RateLimit-Remaining.

5 · Webhooks

Registra un endpoint HTTPS en Perfil → Webhooks. Cuando una ejecución llega a un estado final (completed/failed/cancelled) llega un POST firmado; 3 intentos (0/5/25 s). Firma: HMAC-SHA256("{timestamp}.{cuerpo}").

También puedes suscribirte con una clave de API (Zapier/Make “REST hook”): POST /api/v1/webhooks {"url": "https://…"} devuelve la clave de firma una sola vez; GET /api/v1/webhooks lista; DELETE /api/v1/webhooks/{id} cancela la suscripción.

{
  "event": "run.completed",          // ya da run.failed / run.cancelled
  "run": {
    "id": "…", "status": "completed",
    "pixmate_slug": "ava-generalist-marketer", "kind": "chat",
    "tokens_consumed": 3,
    "error_message": null, "session_id": "…",
    "created_at": "…", "finished_at": "…"
  },
  "sent_at": "…"
}

Verificación (Python):

import hashlib, hmac

def verify(secret: str, ts: str, raw_body: bytes, signature: str) -> bool:
    expected = hmac.new(
        secret.encode(), f"{ts}.".encode() + raw_body, hashlib.sha256
    ).hexdigest()
    return hmac.compare_digest(f"sha256={expected}", signature)

# headers: X-Webhook-Timestamp / X-Webhook-Signature