Skip to main content
POST
Create new schema

Authorizations

x-api-key
string
header
required

API key for authentication

Body

application/json

Body

Request body for creating a new schema

name
string
required

Name of the schema

Required string length: 1 - 255
fields
(DataField · object | ClassificationField · object)[]
required

Schema fields for extraction - choose from Data Field (typed data) or Classification Field

Minimum array length: 1

Extraction field schema

entity
string

Entity type for the schema

Minimum string length: 1

Response

201

Response for schema creation

error
enum<boolean>
required

Error flag (always false on success)

Available options:
false
success
boolean
required

Success flag

schemaId
string
required

ID of the created schema

message
string
required

Success message

createdAt
string

Creation timestamp

updatedAt
string

Last update timestamp