Start

Build a dataset based on a description, without a workflow, ad-hoc

This sends an agent to build a dataset with a specific data schema

post

/api/v2/dataset/start

Authorizations

Query parameters

querystringrequired

The query to make

Example: [e-mail]

methodstring

Method to use, 'simple' or 'advanced'. Advanced may return better results, but uses more credits

Example: simple

Body

string

A JSON schema to extract against

Example: {"name":"<the users name>","company":"<the users company>"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.jsonify.com/api/v2/dataset/start?query=text' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "<the users name>",
    "company": "<the users company>"
  }'

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}