Skip to main content
FileRouter is a provider-neutral document parsing service for TypeScript, the terminal, and the web. Instead of integrating each OCR and parsing provider separately, you call one consistent API and FileRouter handles the rest. Use the hosted service with a FileRouter API key, or run providers directly with your own credentials.

Quick Start

Parse your first document in minutes using the hosted API or TypeScript SDK

Authentication

Get your API key and authenticate requests to the hosted service

TypeScript SDK

Install and configure the SDK for hosted or direct BYOK usage

CLI

Parse and compare documents from the terminal with the FileRouter CLI

Core Concepts

Understand providers, inputs, outputs, and the job lifecycle

API Reference

Explore the REST API endpoints, request shapes, and response contracts

​
How It Works

FileRouter exposes two operations — parse and compare — that work the same way whether you use the hosted service, the TypeScript SDK, or the CLI.
1

Get an API key

Sign in at filerouter.dev to create an API key, or run npx @file_router/cli login to authenticate the CLI.
2

Choose your surface

Use the hosted FileRouterClient in TypeScript, the @file_router/cli CLI, or call the REST API directly with any HTTP client.
3

Parse a document

Send a file or URL and choose a provider. FileRouter normalizes the result into a consistent shape regardless of which provider processed it.
4

Compare across providers

Run the same document through multiple providers with a single compare call to evaluate output quality side by side.

​
Supported Providers

FileRouter currently supports three document parsing providers:
You can use the hosted FileRouter service without providing any provider API keys. FileRouter manages credentials for you. Switch to BYOK mode if you want to use your own provider keys directly.