Skip to main content
Schemas define the structured output you expect from Retab. They are standard JSON Schema objects used by extraction, processor, and workflow calls to validate the data returned from documents. Use POST /v1/schemas/generate when you want Retab to infer a schema from example documents.

Generate Schema

The schema generation endpoint accepts one or more documents and returns a JSON Schema inferred from those examples. You can pass optional instructions and model routing.

Request Fields

MIMEData[]
required
Example documents used to infer the schema.
string
default:"retab-small"
Model or Retab router alias used for schema generation.
string
Extra guidance for fields, naming conventions, or domain-specific details.
boolean
default:"false"
Whether to stream schema generation output.

Response Fields

string
Always "schema".
string
Timestamp for the generated schema response.
object
The generated JSON Schema.
boolean
Whether the schema should be treated as strict structured output.