Skip to main content
POST
Create Schema

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Name for the schema (unique per user)

Example:

"invoice_schema_v1"

type
enum<string>
required

Type of document the schema is for

Available options:
invoice,
bank_statement
Example:

"invoice"

schema_string
object
required

The schema definition itself

description
string

Optional description for the schema

Example:

"Schema for parsing standard invoices"

Response

200 - application/json

Schema created successfully

success
boolean
Example:

true

data
object