API Reference

Analyze Data

Analyze multiple documents all at once, either by passing a list of Document IDs or by passing a dataset name. If both are pased, we will use the intersection of the two. Analysis works by passing a list of questions in natural language. If a schemaId is passed, the AI will first use the standardizations of those documents under the provided schema to narrow down which documents are relevant. Only then, it will analyze the documents and provide answers to the questions, along with confidence scores and citations.
If a schemaId is not passed, the AI will manually examine all documents, with a limit of 50.
When schemaId is passed, the AI can optionally also perform database queries for statistical calculations and answer the questions based on those results.

Body Params
documentIds
array of strings

List of document IDs to analyze. If both dataset and documentIds are provided, we take the intersection of the two.

Document IDs
string

Dataset which defines what documents are included in the analysis. If both dataset and documentIds are provided, we take the intersection of the two.

string

Unique identifier of the schema to be used for the analysis. If provided, only those documents with a valid standardization under this schema will be included in the analysis.

questions
array of strings
required

List of questions to be answered.

Questions*
integer

Maximum number of credits to spend on this job. If not provided, no maximum is enforced.

Responses

Response body
object
string
required

Unique identifier for the submitted job.

string
required

Unique identifier for the analysis.

boolean
required

Whether the job was successful launched or not.

Language
Credentials