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)

POSThttps://api.jsonify.com/api/v2/document/start

Authorization

bearerAuth

Query parameters

Body

application/jsonmultipart/form-data

string

A JSON schema to extract against

Response

200

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

Body

application/json

messagestring

Example: "started"

resultAgent (object)

successboolean

Example: true

Request

JavaScriptCurlPython

const response = await fetch('https://api.jsonify.com/api/v2/document/start', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "schema": {
        "name": "<the site name>"
      }
    }),
});
const data = await response.json();

Response

200

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