Welcome to the Refyne API. This guide covers authentication, rate limits, error handling, and provides an overview of available endpoints.

Base URL

https://api.refyne.uk

Authentication

All endpoints require authentication via Bearer token:

Authorization: Bearer YOUR_API_KEY

Get your API key from the Dashboard.

Endpoint Categories

Extraction

Extract, crawl, and analyze web pages

Jobs

Job status, results, and streaming

Schemas

Schema catalog management

Sites

Saved site configuration

Webhooks

Webhook management and deliveries

API Keys

API key management

LLM Providers

Available LLM providers and models

LLM Keys

User LLM API key management

LLM Chain

LLM fallback chain configuration

Usage

Usage statistics and billing

Pricing

Pricing and tier information

Health

System health and status

Rate Limits

Rate limits depend on your subscription tier. See Plans & Limits for full details.

Rate limit info is returned in response headers:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
X-RateLimit-Reset: 1705312800

Error Responses

All errors return JSON with an error field:

{
  "error": "Invalid API key",
  "status": 401
}

Common HTTP status codes:

Code	Description
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid or missing API key
403	Forbidden - Insufficient permissions
404	Not Found - Resource doesn't exist
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error

OpenAPI Specification

The full OpenAPI specification is available at:

https://api.refyne.uk/openapi.json

Import this into tools like Postman, Insomnia, or any OpenAPI-compatible client.

API Introduction