RefyneBETA
API ReferenceJobs

List jobs

GET
/api/v1/jobs

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication. Include your API key in the Authorization header as Bearer rf_your_key.

In: header

Query Parameters

limit?integer

Number of jobs to return

Default20
Formatint64
Rangevalue <= 100
offset?integer

Offset for pagination

Default0
Formatint64

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:8080/api/v1/jobs"
{
  "jobs": [
    {
      "completed_at": "string",
      "cost_usd": 0.1,
      "created_at": "string",
      "error_category": "string",
      "error_message": "string",
      "id": "string",
      "page_count": 0,
      "started_at": "string",
      "status": "string",
      "token_usage_input": 0,
      "token_usage_output": 0,
      "type": "string",
      "url": "string",
      "urls_queued": 0
    }
  ]
}
{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Get job webhook deliveries GET

Previous Page

Stream job results via SSE GET

Server-Sent Events stream for real-time job results. Events sent: - **status**: Initial job status and progress updates - **result**: Each extracted result as it completes - **complete**: Final status when job finishes - **error**: Error notifications The stream sends heartbeat comments every 15 seconds to keep connections alive through proxies. Example usage with curl: ```bash curl -H "Authorization: Bearer rf_your_key" \ -H "Accept: text/event-stream" \ https://api.refyne.dev/api/v1/jobs/{id}/stream ```