Start

Turn a single document to data without a workflow, ad-hoc.

Send an agent to extract data from a document, optionally transforming it to a specific data schema. POST a file called 'file'. Must be a filetype readable from the dashboard document task (ie pdf or image)

post

/api/v2/document/start

Authorizations

Query parameters

additional_instructionsstring

Additional hints to the AI about what you want to extract

Example: I want a list of people

modelstring · enum

The model to use. Large is slower but may be more accurate. Small is faster but may be less accurate.

Options: auto, large, small

extendedboolean

Attempt to extract extended metadata, like URLs and images

cap_screenshotsinteger · default: 5

Increasing this will cause the AI to scroll further down the page

Body

application/jsonmultipart/form-data

string

A JSON schema to extract against

Example: {"schema":{"name":"<the site name>"}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.jsonify.com/api/v2/document/start' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "schema": {
      "name": "<the site name>"
    }
  }'

200

200

{
  "message": "started",
  "result": {
    "id": "e4ab8b5b-45bd-4e0f-8abb-5ce8a4db255e"
  },
  "success": true
}

An in-progress result, which you can retrieve later with /result/{result_id}