API Reference

curl -H "Authorization: Bearer {your_api_key}" \
  https://app.pinksheep.ai/api/v1/agents

https://app.pinksheep.ai/api/v1

GET /agents

{
  "agents": [
    {
      "agent_uuid": "psf-abc123",
      "name": "Weekly Pipeline Report",
      "status": "active",
      "app_slugs": ["hubspot", "slack"],
      "autonomy": "act",
      "schedule": {
        "cron": "0 8 * * 1",
        "description": "Every Monday at 8am"
      },
      "created_at": "2026-03-01T10:00:00Z"
    }
  ]
}

GET /agents/{agent_uuid}

POST /agents/{agent_uuid}/run

{
  "params": {}
}

{
  "run_id": 42,
  "status": "queued",
  "agent_uuid": "psf-abc123"
}

GET /agents/{agent_uuid}/runs/{run_id}

{
  "run_id": 42,
  "status": "completed",
  "trigger": "manual",
  "steps_completed": 3,
  "credits_used": 2,
  "duration_ms": 4500,
  "step_log": [
    {
      "step_id": "pull_open_deals",
      "status": "completed",
      "duration_ms": 1200
    },
    {
      "step_id": "analyze_health",
      "status": "completed",
      "duration_ms": 2100
    },
    {
      "step_id": "post_summary",
      "status": "completed",
      "duration_ms": 1200
    }
  ],
  "completed_at": "2026-03-14T08:00:04Z"
}

GET /agents/{agent_uuid}/runs?limit=10

GET /credits/balance

{
  "balance": 142,
  "currency": "credits"
}

GET /credits/transactions?limit=20

{
  "event": "run.completed",
  "agent_uuid": "psf-abc123",
  "run_id": 42,
  "timestamp": "2026-03-14T08:00:04Z",
  "data": {
    "status": "completed",
    "credits_used": 2,
    "duration_ms": 4500
  }
}

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Retry after 30 seconds.",
  "retry_after_ms": 30000
}