Skip to content
Page
API reference
Base URL
https://api.parserai.co
Authentication
API key (Bearer)
Format
JSON · multipart upload

API reference

Every endpoint, parameter and example below is read from the OpenAPI spec at api.parserai.co when this page opens.

01
Basics
Rules every endpoint shares

How every call works.

How a call to the API works
TopicHow it works
Authentication
An API key from the console's API keys page, sent as Authorization: Bearer $PARSER_API_KEY. Each endpoint below says whether it needs the header.
Request bodies
JSON. File uploads are the exception: multipart/form-data for POST /documents/upload, or raw bytes sent with PUT to a signed URL.
Responses
JSON where there is a body. A 204 and the signed-URL PUT return none.
Errors
A failed call returns a 4xx or 5xx status, and each endpoint lists the codes it documents. A 422 carries a detail list with loc, msg and type for each invalid field.
02
Endpoints
By group

Every endpoint, by group.

Open an endpoint for its parameters, a request to copy and its responses.

Reading the spec

api.parserai.co/openapi.json

Loading the endpoints from the OpenAPI spec…