Skip to main content
Version: 2025-08-07
API docs by Redocly

RikAI-Extract

Download OpenAPI specification:Download

Lazarus IT: support@lazarusai.com URL: https://lazarus-ai.atlassian.net/servicedesk/customer/portal/8 License: Get Lazarus Terms of Service

Requests

Requests for the Lazarus API

Bulk file upload

Upload 1 or more files to RikAI2-Extract for asynchronous processing. To receive the model output, use either a webhook or an outputURL:

  • webhook (Recommended): Receives a JSON response by default.
  • outputURL: Receives a ZIP file for each document in the request. If the returnJSON parameter is set to true, a JSON file will be provided instead.

File upload options

We only support requests with Content-Type application/json at this endpoint.

  • [application/json] inputURL link to file
  • [application/json] base64 base64 encoded file data
header Parameters
orgId
required
string (orgId) non-empty ^[a-zA-Z0-9\-_]+$

Organization ID

authKey
required
string (authKey) non-empty ^[a-zA-Z0-9\-_]+$

Authentication key

apiVersion
string (apiVersion)

API version used for the request. Defaults to the latest production version. To pin to a specific API version, please contact your Lazarus representative to receive the appropriate version header.

Request Body schema: application/json
required
One of
required
Array of strings or string

URL for the file to extract data from: Must be a PDF, JPEG, JPG, PNG, HEIC, SVG, TIFF, TIF, TXT, or GIF.

required
object or string
Examples: "{\"PatientInfo\": {\"FirstName\": {\"data\": \"Patient first name\", \"page_number\": 0}, \"LastName\": {\"data\": \"Patient last name\", \"page_number\": 0}}}"

A JSON string or a dictionary containing the question(s) to be asked.

webhook
required
string https?://(?:www\\.)?[a-zA-Z0-9./:]+

Webhook URL to which status updates and JSON response will be sent. This is where you will receive the model output. Click here for an example of a webhook URL response.

object (Settings)

Optional user settings.

object

Request headers to include in the POST requests to the webhook.

webhookSendFull
boolean
Default: true

Receive the full JSON response at the webhook URL upon request completion. Set to false to only receive request status.

Array of strings or string
Default: "UUID"
Examples: "file1.pdf"

Custom ID for uploaded file, returned as documentId in the response. Requests with multiple files accept unique fileIds for each file. FileIds can be used to facilitate tracking, referencing, and managing input and output files efficiently.

forceBase64
boolean
Default: false

Setting this parameter to true converts files to Base64 format before sending them on to the model.

forceOCR
boolean
Default: false

Will rasterize a pdf. Set this parameter to true only if the input file is a fillable pdf.

language
string

A language code (e.g. 'EN') or the name of the language you wish to translate answers and explainability into. List of supported codes.

object

Custom JSON to be included in the returned response.

outputURL
string (https?|s?ftp)://(?:www\\.)?[a-zA-Z0-9./:]+

URL where resulting ZIP file or JSON can be sent. Must be open to PUT requests.

object

Request headers to include in the PUT request to the output URL.

returnJSON
boolean
Default: true

Specifies the format of the response sent to outputURL. When set to true, a JSON response is sent to the outputURL. Set to false to send a ZIP file instead.

SFTP (object) or InputOutputSFTP (object)

SFTP authentication details. Required for SFTP URLs in inputURL or outputURL. Option to provide separate server authentication info for inputURL and outputURL.

staticIP
boolean
Default: false

Set to true for static IP for webhook and outputURL if they exist

Responses

Request samples

Content type
application/json
Example
{}

Response samples

Content type
application/json
{
  • "message": "string",
  • "model": "string",
  • "statusId": { },
  • "apiVersion": "string",
  • "endTime": 0,
  • "failedRequests": [
    ],
  • "id": "string",
  • "metadata": { },
  • "startTime": 0,
  • "status": "SUCCESS",
  • "warning": [
    ]
}

Get async request status

Retrieves the status of an asynchronous request to /rikai/zip/rikai2-extract?async=True or /rikai/bulk/rikai2-extract. Identifiable by statusId.

path Parameters
statusId
required
string (statusId)

Status ID

header Parameters
orgId
required
string (orgId) non-empty ^[a-zA-Z0-9\-_]+$

Organization ID

authKey
required
string (authKey) non-empty ^[a-zA-Z0-9\-_]+$

Authentication key

apiVersion
string (apiVersion)

API version used for the request. Defaults to the latest production version. To pin to a specific API version, please contact your Lazarus representative to receive the appropriate version header.

Responses

Response samples

Content type
application/json
{
  • "model": "string",
  • "status": "SUCCESS",
  • "documentId": "string",
  • "error": { },
  • "apiVersion": "string",
  • "code": 0,
  • "id": "string",
  • "message": "string",
  • "startTime": 0,
  • "endTime": 0
}

Webhook Responses

Responses from the Lazarus API

Async Request Submitted Webhook

When an asynchronous request is submitted at a /bulk endpoint, we'll send a POST request for each individual request in the submission with this data to the webhook provided in your request body.

Request Body schema: application/json
required
status
string

Status of the request.

statusId
string

A list of document IDs, each representing an uploaded file. Each ID is a randomly generated UUID. These IDs serve as input for retrieving the status of an asynchronous request via the /rikai/zip/async/{statusId} endpoint.

documentId
string

The unique identifier for the document. If fileId is supplied in the request, it is used as the documentId; otherwise, a random UUID is generated.

id
string

Response ID

model
string

Model used to process the document.

apiVersion
string

API version used for the request. Defaults to the latest production version. To pin to a specific API version, please contact your Lazarus representative to receive the appropriate version header.

metadata
object

JSON from the request metadata field.

organization
string

Organization ID.

provider
string
Default: "lazarus"

lazarus

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "statusId": "string",
  • "documentId": "string",
  • "id": "string",
  • "model": "string",
  • "apiVersion": "string",
  • "metadata": { },
  • "organization": "string",
  • "provider": "lazarus"
}

Async Request Running Webhook

When an asynchronous request begins processing, we'll send a POST request with this data to the webhook provided in your request body.

Request Body schema: application/json
required
status
string

Status of the request.

statusId
string

A list of document IDs, each representing an uploaded file. Each ID is a randomly generated UUID. These IDs serve as input for retrieving the status of an asynchronous request via the /rikai/zip/async/{statusId} endpoint.

documentId
string

The unique identifier for the document. If fileId is supplied in the request, it is used as the documentId; otherwise, a random UUID is generated.

id
string

Response ID

model
string

Model used to process the document.

apiVersion
string

API version used for the request. Defaults to the latest production version. To pin to a specific API version, please contact your Lazarus representative to receive the appropriate version header.

metadata
object

JSON from the request metadata field.

organization
string

Organization ID.

provider
string
Default: "lazarus"

lazarus

startTime
integer

Request start time recorded in epoch (Unix timestamp) format.

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "statusId": "string",
  • "documentId": "string",
  • "id": "string",
  • "model": "string",
  • "apiVersion": "string",
  • "metadata": { },
  • "organization": "string",
  • "provider": "lazarus",
  • "startTime": 0
}

Async Request Failed Webhook

When an asynchronous request fails during processing, we'll send a POST request with this data, including an error message, to the webhook provided in your request body.

Request Body schema: application/json
required
status
string

Status of the request.

code
integer

Response code.

message
string

Status message.

error
object

Present only when the request fails. Contains details about the error.

statusId
string

A list of document IDs, each representing an uploaded file. Each ID is a randomly generated UUID. These IDs serve as input for retrieving the status of an asynchronous request via the /rikai/zip/async/{statusId} endpoint.

documentId
string

The unique identifier for the document. If fileId is supplied in the request, it is used as the documentId; otherwise, a random UUID is generated.

id
string

Response ID

model
string

Model used to process the document.

apiVersion
string

API version used for the request. Defaults to the latest production version. To pin to a specific API version, please contact your Lazarus representative to receive the appropriate version header.

metadata
object

JSON from the request metadata field.

organization
string

Organization ID.

provider
string
Default: "lazarus"

lazarus

startTime
integer

Request start time recorded in epoch (Unix timestamp) format.

endTime
integer

Request end time recorded in epoch (Unix timestamp) format.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "code": 0,
  • "message": "string",
  • "error": { },
  • "statusId": "string",
  • "documentId": "string",
  • "id": "string",
  • "model": "string",
  • "apiVersion": "string",
  • "metadata": { },
  • "organization": "string",
  • "provider": "lazarus",
  • "startTime": 0,
  • "endTime": 0
}

Async Request OutputURL Failure Warning Webhook

When our PUT request to your outputURL fails, we'll send a POST request with this warning message to the webhook provided in your request body. Results will be posted to this webhook in a separate request.

Request Body schema: application/json
required
required
object (OutputURLFailureWarning)

Warnings such as outputURL failure.

statusId
string

A list of document IDs, each representing an uploaded file. Each ID is a randomly generated UUID. These IDs serve as input for retrieving the status of an asynchronous request via the /rikai/zip/async/{statusId} endpoint.

documentId
string

The unique identifier for the document. If fileId is supplied in the request, it is used as the documentId; otherwise, a random UUID is generated.

id
string

Response ID

model
string

Model used to process the document.

apiVersion
string

API version used for the request. Defaults to the latest production version. To pin to a specific API version, please contact your Lazarus representative to receive the appropriate version header.

metadata
object

JSON from the request metadata field.

Responses

Request samples

Content type
application/json
{
  • "warning": {
    },
  • "statusId": "string",
  • "documentId": "string",
  • "id": "string",
  • "model": "string",
  • "apiVersion": "string",
  • "metadata": { }
}

Request Succeeded Webhook

When a request completes successfully, we'll send a POST request with full response data to the webhook provided in your request body.

Request Body schema: application/json
required
required
Array of objects (Answer)

Question and answer data for each question asked in the request.

status
string

Status of the request.

code
integer

Response code.

statusId
string

A list of document IDs, each representing an uploaded file. Each ID is a randomly generated UUID. These IDs serve as input for retrieving the status of an asynchronous request via the /rikai/zip/async/{statusId} endpoint.

documentId
string

The unique identifier for the document. If fileId is supplied in the request, it is used as the documentId; otherwise, a random UUID is generated.

id
string

Response ID

model
string

Model used to process the document.

apiVersion
string

API version used for the request. Defaults to the latest production version. To pin to a specific API version, please contact your Lazarus representative to receive the appropriate version header.

metadata
object

JSON from the request metadata field.

baseModel
string

Base model used during data extraction.

questions
integer

Number of questions asked.

pages
integer

Number of pages in the document.

settings
object

JSON containing any custom user settings specified in the request.

language
string

Language results are translated into.

organization
string

Organization ID.

provider
string
Default: "lazarus"

lazarus

startTime
integer

Request start time recorded in epoch (Unix timestamp) format.

endTime
integer

Request end time recorded in epoch (Unix timestamp) format.

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "code": 0,
  • "data": [
    ],
  • "statusId": "string",
  • "documentId": "string",
  • "id": "string",
  • "model": "string",
  • "apiVersion": "string",
  • "metadata": { },
  • "baseModel": "string",
  • "questions": 0,
  • "pages": 0,
  • "settings": { },
  • "language": "string",
  • "organization": "string",
  • "provider": "lazarus",
  • "startTime": 0,
  • "endTime": 0
}

Request Succeeded Truncated Webhook

When a request completes successfully and your request body includes webhookSendFull: False, we'll send a POST request with truncated response data to the webhook provided in your request body.

Request Body schema: application/json
required
status
string

Status of the request.

code
integer

Response code.

statusId
string

A list of document IDs, each representing an uploaded file. Each ID is a randomly generated UUID. These IDs serve as input for retrieving the status of an asynchronous request via the /rikai/zip/async/{statusId} endpoint.

documentId
string

The unique identifier for the document. If fileId is supplied in the request, it is used as the documentId; otherwise, a random UUID is generated.

id
string

Response ID

model
string

Model used to process the document.

apiVersion
string

API version used for the request. Defaults to the latest production version. To pin to a specific API version, please contact your Lazarus representative to receive the appropriate version header.

metadata
object

JSON from the request metadata field.

organization
string

Organization ID.

provider
string
Default: "lazarus"

lazarus

startTime
integer

Request start time recorded in epoch (Unix timestamp) format.

endTime
integer

Request end time recorded in epoch (Unix timestamp) format.

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "code": 0,
  • "statusId": "string",
  • "documentId": "string",
  • "id": "string",
  • "model": "string",
  • "apiVersion": "string",
  • "metadata": { },
  • "organization": "string",
  • "provider": "lazarus",
  • "startTime": 0,
  • "endTime": 0
}