POST v1/schemas

Beta Feature: This feature is currently in beta and restricted to approved users. If you're are interested in trying it, please contact support and we can enable this feature for your account.

The following endpoint allows you to describe a data schema for parsing an online PDF to JSON.

Create a new data schema

post

Creates a new data schema definition and returns the created schema.

Authorizations

API Key

X-API-KeystringRequired

Body

application/json

idstring · nullableOptional

The unique identifier for the data schema.

namestring · nullableOptional

The name of the schema or field.

descriptionstring · nullableOptional

A description of the schema or field.

Responses

200

Payload of DataSchema

application/json

idstring · nullableOptional

The unique identifier for the data schema.

namestring · nullableOptional

The name of the schema or field.

descriptionstring · nullableOptional

A description of the schema or field.

post

/v1/schemas

HTTPcURLJavaScriptPython

POST /v1/schemas HTTP/1.1
Host: api.gaffa.dev
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 518

"{\"name\":\"Customer Schema\",\"description\":\"Data schema for customer information\",\"fields\":[{\"type\":\"string\",\"name\":\"firstName\",\"description\":\"Customer's first name\",\"fields\":[]},{\"type\":\"string\",\"name\":\"lastName\",\"description\":\"Customer's last name\",\"fields\":[]},{\"type\":\"integer\",\"name\":\"age\",\"description\":\"Customer's age in years\",\"fields\":[]},{\"type\":\"boolean\",\"name\":\"isActive\",\"description\":\"Whether the customer account is active\",\"fields\":[]}]}"

Create Customer SchemaCreate Product Schema

200

Payload of DataSchema

{"id":"schema_abc123def456","name":"Customer Schema","description":"Data schema for customer information","fields":[{"type":"string","name":"firstName","description":"Customer's first name","fields":[]},{"type":"string","name":"lastName","description":"Customer's last name","fields":[]},{"type":"integer","name":"age","description":"Customer's age in years","fields":[]},{"type":"boolean","name":"isActive","description":"Whether the customer account is active","fields":[]}]}