Start

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

post

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

Authorizations

Query parameters

querystringRequired

The query to make

Example: [e-mail]

methodstringOptional

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

Example: simple

Body

stringOptional

A JSON schema to extract against

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

Responses

post

HTTPcURLJavaScriptPython

POST /api/v2/dataset/start HTTP/1.1
Host: api.jsonify.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 59

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

200

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

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