POST
/
api
/
v2
/
document
/
start
curl --request POST \
  --url https://api.jsonify.com/api/v2/document/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "schema": {
    "name": "<the site name>"
  }
}'
{
  "message": "started",
  "result": {
    "id": "e4ab8b5b-45bd-4e0f-8abb-5ce8a4db255e"
  },
  "success": true
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
additional_instructions
string

Additional hints to the AI about what you want to extract

​
model
enum<string>

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

Available options:
auto,
large,
small
​
extended
boolean

Attempt to extract extended metadata, like URLs and images

​
cap_screenshots
integer
default:5

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

Body

A JSON schema to extract against

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

Response

200 - application/json

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

The response is of type object.