Skip to main content
POST
Create Extract Template Generation

Authorizations

Authorization
string
header
required

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

Body

application/json
prompt
string
required

Instructions for generating the extract template.

url
string
required

Example URL used to generate the extract template.

input_schema
Input Schema · object

Optional JSON schema describing expected input parameters.

metadata
CreateExtractTemplateMetadataPublicV2 · object | null

Metadata to attach to the generated extract template.

name
string | null

Optional stable name for the generated extract template.

Required string length: 1 - 255
Pattern: ^[a-z0-9_]+$
output_schema
Output Schema · object

Optional JSON schema describing desired extracted output.

Response

Successful Response

id
string<uuid>
required

Unique extract template generation identifier.

status
string
required

Current generation status.

completed_at
string<date-time> | null

When the generation completed.

created_at
string<date-time> | null

When the generation was created.

error
string | null

Error message when generation failed.

generated_version
ExtractTemplateVersionResponsePublicV2 · object | null

Generated version details, when available.

generated_version_id
string<uuid> | null

Identifier of the generated version.

name
string | null

Extract template name associated with the generation.

source_version_id
string<uuid> | null

Identifier of the version being refined.

started_at
string<date-time> | null

When the generation started executing.

summary
string | null

Summary of the generation result.