• Requests
  • postBulk file upload
  • getGet async request status
• Webhook Responses
  • EventAsync Request Submitted
  • EventAsync Request Running
  • EventAsync Request Failed
  • EventAsync Request OutputURL Failure Warning
  • EventRequest Succeeded

API docs by Redocly

Applied Intelligence Engine

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 the Applied Intelligence Engine for asynchronous processing.

Input

Each request requires a prompt and a file. The following file upload options are supported (Content-Type application/json only):

• file.url — link to file
• file.base64 — base64 encoded file data

Output

To receive results at a URL, define an output config. The output config supports parameters to define the type of output request, including:

• contentType — the content type of the response delivered to your URL (defaults to application/json)
• method — the HTTP method used when sending results to your URL (defaults to POST)

Status updates

Opt in to the statusWebhook to receive updates as asynchronous requests process. The statusWebhook URL can be the same URL as the output URL.

Model settings

Use modelSettings to optionally configure the backend processing components:

• capability — selects the processing capability
• tier — selects the performance tier

To access additional capabilities and tiers beyond standard, contact your Lazarus representative.

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

required	object (EngineBulkInput) Model input.
required	object (EngineOutputParameters) Output URL and HTTP request parameters to receive results asynchronously.
	object (EngineSettings) Optional user settings.
	Array of strings or null Examples: ["file1.pdf","file2.pdf"] Custom ID(s) for uploaded file(s), returned as inputId in the response. Requests with multiple files accept unique inputIds for each file. InputIds can be used to facilitate tracking, referencing, and managing input and output files efficiently.
	string or null A language code (e.g. 'EN') or the name of the language you wish to translate answers and explainability into. List of supported codes.
metadata	object Custom JSON to be included in the returned response.
rasterize	boolean Default: false Will rasterize a pdf. Set this parameter to true only if the input file is a fillable pdf.
staticIP	boolean Default: false Set to true for status URL and output URL if they exist.
	StatusURL (object) or null Status URL to send status updates for the request.

Responses

https://api.lazarusai.com/api/engine/bulk

Request samples

• Payload

Content type

application/json

{

• "input": {

  • "file": [

    • {

      • "url": "string",
      • "sftp": {

        • "user": "string",
        • "password": "string",
        • "privateKey": "string",
        • "privateKeyPassphrase": "string"

        }

      }

    ],
  • "prompt": "string"

  },
• "output": {

  • "url": "string",
  • "contentType": "application/json",
  • "headers": { },
  • "method": "POST",
  • "sftp": {

    • "user": "string",
    • "password": "string",
    • "privateKey": "string",
    • "privateKeyPassphrase": "string"

    }

  },
• "settings": {

  • "advancedExplainability": false,
  • "modelSettings": {

    • "capability": "standard",
    • "tier": "premium"

    }

  },
• "inputId": {

  • "0": "file1.pdf",
  • "1": "file2.pdf"

  },
• "language": "string",
• "metadata": { },
• "rasterize": false,
• "staticIP": false,
• "statusWebhook": {

  • "url": "http://example.com",
  • "headers": { }

  }

}

Response samples

• 200
• 207
• 400
• 403
• 404
• 413
• 429

Content type

application/json

{

• "apiVersion": "YYYY-MM-DD",
• "id": "string",
• "jobIds": {

  • "property1": "string",
  • "property2": "string"

  },
• "message": "string",
• "status": "SUCCESS",
• "endTime": 0,
• "failedRequests": [

  • null

  ],
• "language": "string",
• "metadata": { },
• "startTime": 0,
• "warning": [

  • { }

  ]

}

Get async request status

Retrieves the status of an asynchronous request to /engine/bulk. Identifiable by jobId.

path Parameters

jobId required

string (jobId) Job ID to track the bulk request progress

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

https://api.lazarusai.com/api/engine/jobs/{jobId}/status

Response samples

• 200
• 400
• 403
• 404
• 429
• 521

Content type

application/json

{

• "apiVersion": "YYYY-MM-DD",
• "id": "string",
• "model": "string",
• "status": "SUCCESS",
• "code": 0,
• "endTime": 0,
• "error": { },
• "inputId": "string",
• "message": "string",
• "startTime": 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 status webhook provided in your request body.

Request Body schema: application/json

required

apiVersion required	string Example: "YYYY-MM-DD" 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.
id required	string Response ID
required	string or null Custom ID(s) for uploaded file(s), returned as inputId in the response. Requests with multiple files accept unique inputIds for each file. InputIds can be used to facilitate tracking, referencing, and managing input and output files efficiently.
status required	string (StatusEnum) Enum: "SUCCESS" "SUBMITTED" "FAILURE" "AUTH_FAILURE" "RUNNING" Status of the request.
jobId	string Job ID to track the bulk request progress
metadata	object JSON from the request metadata field.

Responses

Request samples

• Payload

Content type

application/json

{

• "apiVersion": "YYYY-MM-DD",
• "id": "string",
• "inputId": "string",
• "status": "SUCCESS",
• "jobId": "string",
• "metadata": { }

}

Async Request Running Webhook

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

Request Body schema: application/json

required

apiVersion required	string Example: "YYYY-MM-DD" 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.
id required	string Response ID
required	string or null Custom ID(s) for uploaded file(s), returned as inputId in the response. Requests with multiple files accept unique inputIds for each file. InputIds can be used to facilitate tracking, referencing, and managing input and output files efficiently.
status required	string (StatusEnum) Enum: "SUCCESS" "SUBMITTED" "FAILURE" "AUTH_FAILURE" "RUNNING" Status of the request.
startTime required	integer Request start time recorded in epoch (Unix timestamp) format.
jobId	string Job ID to track the bulk request progress
metadata	object JSON from the request metadata field.

Responses

Request samples

• Payload

Content type

application/json

{

• "apiVersion": "YYYY-MM-DD",
• "id": "string",
• "inputId": "string",
• "startTime": 0,
• "status": "SUCCESS",
• "jobId": "string",
• "metadata": { }

}

Async Request Failed Webhook

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

Request Body schema: application/json

required

apiVersion required	string Example: "YYYY-MM-DD" 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.
id required	string Response ID
required	string or null Custom ID(s) for uploaded file(s), returned as inputId in the response. Requests with multiple files accept unique inputIds for each file. InputIds can be used to facilitate tracking, referencing, and managing input and output files efficiently.
status required	string (StatusEnum) Enum: "SUCCESS" "SUBMITTED" "FAILURE" "AUTH_FAILURE" "RUNNING" Status of the request.
code required	integer Response code. The possible error codes you may receive at your webhook upon failure are 400, 401, 403, 404, 413, 521, and 522. See this guide for descriptions of all the error codes.
endTime required	integer Request end time recorded in epoch (Unix timestamp) format.
message required	string Status message.
startTime required	integer Request start time recorded in epoch (Unix timestamp) format.
	object or null Present only when the request fails. Contains details about the error.
jobId	string Job ID to track the bulk request progress
metadata	object JSON from the request metadata field.

Responses

Request samples

• Payload

Content type

application/json

{

• "apiVersion": "YYYY-MM-DD",
• "code": 0,
• "endTime": 0,
• "id": "string",
• "inputId": "string",
• "message": "string",
• "startTime": 0,
• "status": "SUCCESS",
• "error": { },
• "jobId": "string",
• "metadata": { }

}

Async Request OutputURL Failure Warning Webhook

If our request to your output URL fails, we'll send a POST request with this warning message to the status webhook provided in your request body.

Request Body schema: application/json

required

apiVersion required	string Example: "YYYY-MM-DD" 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.
id required	string Response ID
inputId required	string Custom ID(s) for uploaded file(s), returned as inputId in the response. Requests with multiple files accept unique inputIds for each file. InputIds can be used to facilitate tracking, referencing, and managing input and output files efficiently.
required	object (models__aie__aie_webhook__OutputURLFailureWarning) Warnings such as webhook failure.
jobId	string Job ID to track the bulk request progress
metadata	object JSON from the request metadata field.

Responses

Request samples

• Payload

Content type

application/json

{

• "apiVersion": "YYYY-MM-DD",
• "id": "string",
• "inputId": "string",
• "warning": {

  • "message": "string",
  • "code": 0,
  • "error": { },
  • "field": "output.url",
  • "url": "string"

  },
• "jobId": "string",
• "metadata": { }

}

Request Succeeded Webhook

When an async request completes successfully, we'll send a POST request with status: SUCCESS to the status webhook provided in your request body. Full API results will be posted to the output URL provided in the request body.

Request Body schema: application/json

required

apiVersion required	string Example: "YYYY-MM-DD" 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.
id required	string Response ID
required	string or null Custom ID(s) for uploaded file(s), returned as inputId in the response. Requests with multiple files accept unique inputIds for each file. InputIds can be used to facilitate tracking, referencing, and managing input and output files efficiently.
status required	string (StatusEnum) Enum: "SUCCESS" "SUBMITTED" "FAILURE" "AUTH_FAILURE" "RUNNING" Status of the request.
code required	integer Response code. Possible values are 200, 400, 401, 403, 404, 413, 521, and 522.
endTime required	integer Request end time recorded in epoch (Unix timestamp) format.
startTime required	integer Request start time recorded in epoch (Unix timestamp) format.
jobId	string Job ID to track the bulk request progress
metadata	object JSON from the request metadata field.

Responses

Request samples

• Payload

Content type

application/json

{

• "apiVersion": "YYYY-MM-DD",
• "code": 0,
• "endTime": 0,
• "id": "string",
• "inputId": "string",
• "startTime": 0,
• "status": "SUCCESS",
• "jobId": "string",
• "metadata": { }

}