API Guide v1.0

API Guide

Complete reference guide for the Receiptli API. Learn how to integrate document extraction capabilities into your applications.

Quick Reference

Base URL
https://www.receiptli.com/api/v1
Authentication
Bearer Token
Format
JSON

API Documentation

Introduction
Authentication
API Endpoints
Health Check
Extract Text

Introduction

The Receiptli API allows you to extract structured data from documents using advanced AI and OCR technology. Whether you're processing receipts, invoices, forms, or any other document type, our API can identify and extract the information you need in a structured JSON format.

This guide covers the core endpoints currently available. The API is RESTful, uses JSON for data exchange, and follows standard HTTP response codes. All requests require authentication via API keys.

Getting Started

To use the Receiptli API, you'll need an API key. Sign up for an account and generate your API key from the dashboard. Include it in the Authorization header as a Bearer token for all requests.

Key Features

Custom Schema Support
Define exactly what data to extract
Multi-format Support
PDF, JPG, PNG, and more
High Accuracy
AI-powered extraction with confidence scores
Fast Processing
Optimized for speed and reliability

Authentication

The Receiptli API uses API key authentication. Include your API key in the Authorization header of all requests using the Bearer token format.

Authentication Header Format

Authorization: Bearer rcp_your_api_key_here

Keep Your API Key Secure

Never expose your API key in client-side code or public repositories. Store it securely and use environment variables or secure configuration management.

Rate Limits

The API has the following rate limits:

Free Tier: 100 requests/hour
Perfect for development and testing
Pro Tier: 1,000 requests/hour
Suitable for production applications
Enterprise: Custom limits
Contact us for high-volume needs

API Endpoints

GET

/api/v1

API Health Check

Returns the current status and version of the Receiptli API. Use this endpoint to verify that the API is operational and to get basic information about the service.

Parameters

This endpoint does not require any parameters.

POST

/api/v1/extract-text

Extract Structured Data from Documents

Upload a document (PDF, image, etc.) and extract structured data based on a custom schema. This endpoint uses AI-powered OCR and data extraction to convert unstructured documents into structured JSON data.

Parameters

Parameter	Type	Required	Description
Authorization header	string	Required	Bearer token for API authentication Example: Bearer rcp_your_api_key_here