Skip to main content

Get specific data from your files using a template

POST 

/v1/extract

Extract specific information from your files (like names, dates, amounts) by providing a template (JSON schema) of what you want to find.

Request

Body

required

    file_urls string[]required

    List of file URLs to process for extraction. Supports two URL types:

        1. Public URLs - accessible from the internet

    2. `nomic://` prefixed URLs - obtained from the `/upload` endpoint
    extraction_schema objectrequired

    JSON schema defining the structure and data types for the extracted information. This schema guides the AI model to extract specific fields and maintain consistent output format.

    system_prompt System Prompt (string)

    Custom system prompt to guide the AI extraction process across the entire file. Use this to provide specific instructions, context, or constraints for how information should be extracted and formatted according to your requirements.

Responses

The task id of the extraction task.

Schema

    task_id Task Id (string)required

    The id of the task.

Loading...