Skip to main content
POST
/
api
/
v2
/
dataset
/
start
Build a dataset based on a description, without a workflow, ad-hoc
curl --request POST \
  --url https://api.jsonify.com/api/v2/dataset/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<the users name>",
  "company": "<the users company>"
}
'
{
  "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

​
query
string
required

The query to make

​
method
string

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

Example:

"simple"

Body

application/json

A JSON schema to extract against

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

Response

200 - application/json

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

​
message
string
Example:

"started"

​
result
object
​
success
boolean
Example:

true