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.
from retab import Retabclient = Retab()schema = client.schemas.generate(documents=["freight/booking_confirmation_1.jpg","freight/booking_confirmation_2.jpg",],model="retab-small",instructions="Capture shipment dates, parties, and reference numbers.",)print(schema.json_schema)
import { Retab } from '@retab/node';const client = new Retab({ apiKey: process.env.RETAB_API_KEY });const schema = await client.schemas.generate([ "freight/booking_confirmation_1.jpg", "freight/booking_confirmation_2.jpg", ], "retab-small", "Capture shipment dates, parties, and reference numbers.");console.log(schema.jsonSchema);
import com.retab.RetabClient;public final class Example { public static void main(String[] args) throws Exception { RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY")); var result = client.schemas().generate(null, "retab-1.5", "Extract the invoice fields", null); System.out.println(result); }}