API Documentation

Complete API reference, guides, and examples to help you integrate Visobird OCR into your applications.

API Reference

Complete API endpoints documentation with request/response examples.

View API Docs
OpenAPI Spec

Machine-readable API specification for automatic client generation.

Download YAML
Postman Collection

Ready-to-use Postman collection for testing and exploring the API.

Download Collection
API Overview

Base URL

https://api.visobird.com/v1

Authentication

All API requests require authentication using Bearer tokens:

Authorization: Bearer YOUR_API_KEY

Content Types

application/jsonmultipart/form-data
Main Endpoints

POST/v1/process

Process receipt images using OCR to extract structured data including merchant, total, date, and itemized details.

GET/v1/receipts

Retrieve a list of previously processed receipts with pagination support.

GET/v1/usage

Get current API usage statistics and rate limit information for your account.

GET/POST/DELETE/v1/api-keys

Manage your API keys: create new keys, list existing keys, and revoke access.

Getting Started
1

Sign up for an account

Create your free Visobird account to get started.

2

Generate an API key

Create your first API key in the dashboard.

3

Make your first request

Send a POST request to /v1/process with your receipt image.

4

Parse the response

Extract the structured data from the JSON response.