Poll Extract - OmniAI Docs

GET

extract

const jobId = "<job-id>";
const options = {
  method: "GET",
  headers: {
    "x-api-key": "<your-api-key>",
  },
};

fetch(`https://api.getomni.ai/extract?jobId=${jobId}`, options)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

{
  "jobId": "087d73cc-e88a-43be-8bbb-5fcb932e7ef1",
  "result": {
    "ocr": {
      "pages": [
        {
          "page": 1,
          "content": "# Invoice ...",
          "contentLength": 698
        }
      ],
      "fileName": "7faf9e7fd6cb4b3dbb4accca979023bb",
      "inputTokens": 931,
      "outputTokens": 220,
      "completionTime": 8593
    },
    "extracted": {
      "file_type": "invoice"
    },
    "inputTokens": 292,
    "outputTokens": 7
  },
  "status": "COMPLETE",
  "timeElapsed": 1852
}

Query Parameters

jobId

string

required

The job ID of the extraction request

Response

jobId

string

Job ID of the extraction request

result

object

Response object containing OCR results and extracted data

Show result

ocr

object

OCR results from document processing

Show ocr

pages

array

Array of processed pages

Show pages

page

number

Page number

content

string

Raw text content extracted from the page

contentLength

number

Length of the extracted content

fileName

string

Name of the processed file

inputTokens

number

Number of input tokens processed

outputTokens

number

Number of output tokens generated

completionTime

number

Processing time in milliseconds

extracted

object

Structured data extracted according to the provided schema

inputTokens

number

Total number of input tokens

outputTokens

number

Total number of output tokens

confidence

object

Confidence intervals for OCR and extracted values

Show confidence

ocr

array

Confidence intervals per OCR page

Show ocr

page

number

Page number

value

number

Confidence interval for the page

extracted

object

Confidence intervals for extracted structured data

metadata

object

Custom JSON from the request, returned in the response

status

string

Current state of the job, which can be PENDING | IN_PROGRESS | ERROR | COMPLETE

timeElapsed

number

Time taken to process in milliseconds

const jobId = "<job-id>";
const options = {
  method: "GET",
  headers: {
    "x-api-key": "<your-api-key>",
  },
};

fetch(`https://api.getomni.ai/extract?jobId=${jobId}`, options)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

{
  "jobId": "087d73cc-e88a-43be-8bbb-5fcb932e7ef1",
  "result": {
    "ocr": {
      "pages": [
        {
          "page": 1,
          "content": "# Invoice ...",
          "contentLength": 698
        }
      ],
      "fileName": "7faf9e7fd6cb4b3dbb4accca979023bb",
      "inputTokens": 931,
      "outputTokens": 220,
      "completionTime": 8593
    },
    "extracted": {
      "file_type": "invoice"
    },
    "inputTokens": 292,
    "outputTokens": 7
  },
  "status": "COMPLETE",
  "timeElapsed": 1852
}

const jobId = "<job-id>";
const options = {
  method: "GET",
  headers: {
    "x-api-key": "<your-api-key>",
  },
};

fetch(`https://api.getomni.ai/extract?jobId=${jobId}`, options)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

{
  "jobId": "087d73cc-e88a-43be-8bbb-5fcb932e7ef1",
  "result": {
    "ocr": {
      "pages": [
        {
          "page": 1,
          "content": "# Invoice ...",
          "contentLength": 698
        }
      ],
      "fileName": "7faf9e7fd6cb4b3dbb4accca979023bb",
      "inputTokens": 931,
      "outputTokens": 220,
      "completionTime": 8593
    },
    "extracted": {
      "file_type": "invoice"
    },
    "inputTokens": 292,
    "outputTokens": 7
  },
  "status": "COMPLETE",
  "timeElapsed": 1852
}

GET

extract

const jobId = "<job-id>";
const options = {
  method: "GET",
  headers: {
    "x-api-key": "<your-api-key>",
  },
};

fetch(`https://api.getomni.ai/extract?jobId=${jobId}`, options)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

{
  "jobId": "087d73cc-e88a-43be-8bbb-5fcb932e7ef1",
  "result": {
    "ocr": {
      "pages": [
        {
          "page": 1,
          "content": "# Invoice ...",
          "contentLength": 698
        }
      ],
      "fileName": "7faf9e7fd6cb4b3dbb4accca979023bb",
      "inputTokens": 931,
      "outputTokens": 220,
      "completionTime": 8593
    },
    "extracted": {
      "file_type": "invoice"
    },
    "inputTokens": 292,
    "outputTokens": 7
  },
  "status": "COMPLETE",
  "timeElapsed": 1852
}

Query Parameters

jobId

string

required

The job ID of the extraction request

Response

jobId

string

Job ID of the extraction request

result

object

Response object containing OCR results and extracted data

Show result

ocr

object

OCR results from document processing

Show ocr

pages

array

Array of processed pages

Show pages

page

number

Page number

content

string

Raw text content extracted from the page

contentLength

number

Length of the extracted content

fileName

string

Name of the processed file

inputTokens

number

Number of input tokens processed

outputTokens

number

Number of output tokens generated

completionTime

number

Processing time in milliseconds

extracted

object

Structured data extracted according to the provided schema

inputTokens

number

Total number of input tokens

outputTokens

number

Total number of output tokens

confidence

object

Confidence intervals for OCR and extracted values

Show confidence

ocr

array

Confidence intervals per OCR page

Show ocr

page

number

Page number

value

number

Confidence interval for the page

extracted

object

Confidence intervals for extracted structured data

metadata

object

Custom JSON from the request, returned in the response

status

string

Current state of the job, which can be PENDING | IN_PROGRESS | ERROR | COMPLETE

timeElapsed

number

Time taken to process in milliseconds

const jobId = "<job-id>";
const options = {
  method: "GET",
  headers: {
    "x-api-key": "<your-api-key>",
  },
};

fetch(`https://api.getomni.ai/extract?jobId=${jobId}`, options)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

{
  "jobId": "087d73cc-e88a-43be-8bbb-5fcb932e7ef1",
  "result": {
    "ocr": {
      "pages": [
        {
          "page": 1,
          "content": "# Invoice ...",
          "contentLength": 698
        }
      ],
      "fileName": "7faf9e7fd6cb4b3dbb4accca979023bb",
      "inputTokens": 931,
      "outputTokens": 220,
      "completionTime": 8593
    },
    "extracted": {
      "file_type": "invoice"
    },
    "inputTokens": 292,
    "outputTokens": 7
  },
  "status": "COMPLETE",
  "timeElapsed": 1852
}

const jobId = "<job-id>";
const options = {
  method: "GET",
  headers: {
    "x-api-key": "<your-api-key>",
  },
};

fetch(`https://api.getomni.ai/extract?jobId=${jobId}`, options)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

{
  "jobId": "087d73cc-e88a-43be-8bbb-5fcb932e7ef1",
  "result": {
    "ocr": {
      "pages": [
        {
          "page": 1,
          "content": "# Invoice ...",
          "contentLength": 698
        }
      ],
      "fileName": "7faf9e7fd6cb4b3dbb4accca979023bb",
      "inputTokens": 931,
      "outputTokens": 220,
      "completionTime": 8593
    },
    "extracted": {
      "file_type": "invoice"
    },
    "inputTokens": 292,
    "outputTokens": 7
  },
  "status": "COMPLETE",
  "timeElapsed": 1852
}

​Query Parameters

​Response

​Query Parameters

​Response

Query Parameters

Response

Query Parameters

Response