Retrieve Analysis

get https://app.docupanda.io/analysis/{analysis_id}

Retrieve an analysis object by providing the analysis ID, which has the questions and answers.

Responses

Response body

object

analysisId

string

required

Unique identifier of the analysis object.

jobId

string

required

Unique identifier of the job that created the analysis.

documentIds

array of strings

List of document IDs that were analyzed.

Document IDs

dataset

string

Dataset which defines what documents are included in the analysis.

schemaId

string

Unique identifier of the schema used to fetch standardizations for querying.

numDocs

integer

Number of documents analyzed.

pages

array of integers

List of page numbers to analyze. If none, all pages are analyzed. Only applies for single document.

Pages

data

array of objects

required

List of questions and answers for the analysis, along with confidence and citations.

Data (Questions and Answers)*

object

question

string

required

The question to be answered.

answer

string

The answer to the question.

confidence

string

The confidence level of the answer.

high medium low

citations

array of objects

List of citations for the answer.

Citations

object

documentId

string

required

Unique identifier of the document where the citation is found.

pages

array of integers

required

List of page numbers where the citation is found (zero-indexed).

Pages*

timestamp

string

Timestamp of the analysis job.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://app.docupanda.io/analysis/analysis_id \
3
     --header 'accept: application/json'


xxxxxxxxxx
29
}
1
{
2
  "analysisId": "string",
3
  "jobId": "string",
4
  "documentIds": [
5
    "string"
6
  ],
7
  "dataset": "string",
8
  "schemaId": "string",
9
  "numDocs": 0,
10
  "pages": [
11
    0
12
  ],
13
  "data": [
14
    {
15
      "question": "string",
16
      "answer": "string",
17
      "confidence": "high",
18
      "citations": [
19
        {
20
          "documentId": "string",
21
          "pages": [
22
            0
23
          ]
24
        }
25
      ]

200Successful Response

404Not Found

422Validation Error