Skip to main content
Built for Developers

Comprehensive API documentation

Full API reference, quickstart guides, integration tutorials, and code examples in cURL, JavaScript, and Python. Everything you need to integrate Redirections into your stack.

Complete
Full API Reference
3 langs
Code Examples
Guided
Integration Guides
LLM-ready
AI-Readable Docs
quickstart.ts
CODE
1const params = new URLSearchParams({
2 project: "PROJECT_ID",
3 path: "/old-page",
4})
5const response = await fetch(
6 `https://edge.redirections.app/v1/lookup?${params}`,
7 {
8 headers: { "Authorization": "Bearer rk_live_..." },
9 }
10)
11const { destination, statusCode } = await response.json()

How the developer documentation is organized

The documentation is structured in three tiers: quickstart guides for getting up and running in minutes, integration tutorials for connecting Redirections with specific platforms, and a complete API reference for every endpoint. Each tier links to the others, so you can move from a high-level overview to implementation details naturally.

Every API endpoint is documented with the HTTP method, URL path, request parameters, response format, error codes, and a working code example. Examples are provided in cURL, JavaScript, and Python, so you can copy-paste directly into your project.

All documentation is available as structured markdown for AI consumption. AI coding assistants and language models can read the full documentation set via dedicated endpoints to provide context-aware integration help.

Why teams choose this

Built for performance, reliability, and developer experience.

Complete

Full API Reference

Every endpoint documented with request/response examples and error codes.

3 langs

Code Examples

Copy-paste examples in cURL, JavaScript, and Python.

Guided

Integration Guides

Step-by-step guides for Nginx, HAProxy, and more.

LLM-ready

AI-Readable Docs

Structured markdown endpoints for AI coding assistants and language models.

Developer docs use cases

1

Getting started

Follow the quickstart guide to create your first redirect rule and query it via the Edge API in under 5 minutes.

2

Platform integration

Use step-by-step integration guides for Nginx, HAProxy, Cloudflare Workers, Next.js, and other platforms.

3

Debugging redirects

Reference the troubleshooting section for common issues like unexpected 404s, chain loops, and caching behavior.

4

API automation

Use the full API reference to build automated workflows for rule management, deployment, and analytics retrieval.

How we compare

See how Redirections compares to alternatives.

Feature
Redirections
Alternatives
Documentation
Full API reference + guides
Basic README
Code examples
cURL, JavaScript, Python
cURL only
AI-readable
Structured markdown for LLMs
HTML only
Versioning
Versioned docs
Single version

Documentation designed for developer productivity

Developer documentation should reduce time-to-integration, not add to it. Every page in the Redirections docs is designed to answer a specific question or complete a specific task. There is no marketing language in the docs — just technical content with clear examples and accurate information.

The documentation is versioned alongside the API. When a new API version is released, the docs are updated simultaneously, and previous versions remain accessible for teams that have not yet migrated. Deprecation notices are prominently displayed with migration guides when breaking changes are introduced.

All documentation is available as structured markdown for AI consumption. AI coding assistants and language models can read the full documentation set to provide context-aware integration help. This means you can ask your AI assistant to write Redirections integration code and it will have access to accurate, up-to-date API documentation.

Read the docs, ship in minutes

From quickstart to production in under 5 minutes. Full API reference included.

No credit card required · Free tier available