{
  "openapi": "3.1.0",
  "info": {
    "title": "Developer"
  },
  "paths": {
    "/developer/api-version": {
      "get": {
        "summary": "Get API version",
        "description": "Validate credentials and API version. If the api version isn't supported, the default api version will be returned.",
        "operationId": "get_developer_api_version",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VersionResponse"
                }
              }
            }
          },
          "500": {
            "description": "Unsuccessful Response",
            "content": {
              "application/json": {
              }
            }
          }
        },
        "parameters": [
          {
            "name": "orgId",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "pattern": "^[a-zA-Z0-9\\-_]+$",
              "title": "orgId",
              "description": "Organization ID"
            },
            "description": "Organization ID"
          },
          {
            "name": "authKey",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "pattern": "^[a-zA-Z0-9\\-_]+$",
              "title": "authKey",
              "description": "Authentication key"
            },
            "description": "Authentication key"
          },
          {
            "name": "apiVersion",
            "in": "header",
            "required": false,
            "schema": {
              "type": "string",
              "title": "apiVersion",
              "description": "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."
            },
            "description": "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."
          }
        ]
      }
    },
    "/developer/webhook": {
      "post": {
        "summary": "Post webhook test",
        "description": "Developer test for configuring a webhook to receive model responses",
        "operationId": "post_webhook_test",
        "parameters": [
          {
            "name": "orgId",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "pattern": "^[a-zA-Z0-9\\-_]+$",
              "title": "orgId",
              "description": "Organization ID"
            },
            "description": "Organization ID"
          },
          {
            "name": "authKey",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "pattern": "^[a-zA-Z0-9\\-_]+$",
              "title": "authKey",
              "description": "Authentication key"
            },
            "description": "Authentication key"
          },
          {
            "name": "apiVersion",
            "in": "header",
            "required": false,
            "schema": {
              "type": "string",
              "title": "apiVersion",
              "description": "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."
            },
            "description": "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."
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookCheckRequestBody"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookTestResponse"
                }
              }
            }
          },
          "500": {
            "description": "Validation Error",
            "content": {
              "application/json": {
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "SFTP": {
        "properties": {
          "user": {
            "type": "string",
            "title": "user",
            "description": "SFTP username."
          },
          "password": {
            "type": "string",
            "title": "Password",
            "description": "SFTP password. Either `password` or `privateKey` are required."
          },
          "privateKey": {
            "type": "string",
            "title": "Privatekey",
            "description": "Base64 encoded SFTP private key. Either `password` or `privateKey` are required."
          },
          "privateKeyPassphrase": {
            "type": "string",
            "title": "Privatekeypassphrase",
            "description": "Optional passphrase to use if private key is protected."
          }
        },
        "type": "object",
        "required": [
          "user"
        ],
        "title": "SFTP",
        "description": "SFTP authentication model, request body"
      },
      "Settings": {
        "properties": {
          "verbose": {
            "type": "boolean",
            "title": "Verbose",
            "description": "When set to true, enables verbose mode, more detailed and complex responses",
            "forceExclude": true
          },
          "temperature": {
            "type": "number",
            "title": "Temperature",
            "description": "Adjusts the verbosity level of responses, with higher float values increasing the detail of the output",
            "forceExclude": true
          },
          "safety": {
            "type": "boolean",
            "title": "Safety",
            "forceExclude": true
          },
          "version": {
            "type": "string",
            "title": "Version",
            "forceExclude": true
          },
          "sendFile": {
            "type": "boolean",
            "title": "Sendfile",
            "forceExclude": true
          },
          "msOCR": {
            "type": "boolean",
            "title": "Msocr",
            "description": "Set to true if OCR passed is Microsoft's OCR.",
            "forceExclude": true
          },
          "advancedVision": {
            "type": "boolean",
            "title": "Advancedvision",
            "description": "Set to `true` to enable advanced features such as checkboxes and tables.",
            "models": {
              "RikAI2-Extract": {
                "forceExclude": true
              }
            },
            "setDefault": false
          },
          "advancedExplainability": {
            "type": "boolean",
            "title": "Advancedexplainability",
            "description": "When set to `false`, the model processes requests faster but does not return the full explainability. Set to `true` to include full explainability.",
            "models": {
              "RikAI2-Extract": {
                "forceExclude": true
              }
            },
            "setDefault": false
          },
          "returnConfidence": {
            "type": "boolean",
            "title": "Returnconfidence",
            "description": "Set to true to include bounding boxes and confidence score in response. Click [here](/../../models/Rikai/rikai2-extract/overview#returning-confidence-scores-and-bounding-boxes) for prompting guidelines to ensure optimal results when using this field.",
            "models": {
              "RikAI2": {
                "forceExclude": true
              }
            }
          }
        },
        "type": "object",
        "title": "Settings",
        "description": "Settings model, request body"
      },
      "StatusEnum": {
        "type": "string",
        "enum": [
          "SUCCESS",
          "SUBMITTED",
          "FAILURE",
          "AUTH_FAILURE",
          "RUNNING"
        ],
        "title": "StatusEnum",
        "description": "Status enum for responses"
      },
      "ValidationError": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "WebhookCheckRequest": {
        "properties": {
          "webhook": {
            "type": "string",
            "pattern": "https?://(?:www\\\\.)?[a-zA-Z0-9./:]+",
            "title": "Webhook",
            "description": "Webhook URL to which status updates and JSON response will be sent. This is where you will receive the model output. \n[Click here](/../../models/rikai/webhook-examples) for an example of a webhook URL response.",
            "mostUsed": true
          },
          "webhookHeaders": {
            "type": "object",
            "title": "Webhookheaders",
            "description": "Request headers to include in the POST requests to the webhook.",
            "mostUsed": true
          }
        },
        "examples": [
          {
              "webhook": "https://httpstat.us/403",
              "webhookHeaders": {}
          },
          {
              "webhook": "https://httpstat.us/200",
              "webhookHeaders": {}
          }
        ],
        "type": "object",
        "required": [
          "webhook"
        ],
        "title": "WebhookCheckRequest",
        "description": "Potential fields for Webhook Check"
      },
      "WebhookCheckRequestBody": {
        "allOf": [
          {
            "$ref": "#/components/schemas/WebhookCheckRequest"
          }
        ],
        "title": "WebhookCheckRequestBody",
        "description": "/developer/webhook url request"
      },
      "DeveloperResponse": {
        "properties": {
          "apiVersion": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Apiversion",
            "description": "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.",
            "forceType": "string"
          },
          "id": {
            "type": "string",
            "title": "Id",
            "description": "Response ID"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/StatusEnum"
              }
            ],
            "description": "Status of the request."
          }
        },
        "type": "object",
        "required": [
          "status"
        ],
        "examples": [
          {
            "apiVersion": "2025-05-22",
            "id": "cf0b39c8",
            "status": "SUCCESS"
          }
        ],
        "title": "DeveloperResponse",
        "description": "/developer response"
      },
      "VersionResponse": {
        "properties": {
          "apiVersion": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Apiversion",
            "description": "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.",
            "forceType": "string"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/StatusEnum"
              }
            ],
            "description": "Status of the request."
          }
        },
        "type": "object",
        "required": [
          "status"
        ],
        "examples": [
          {
            "apiVersion": "2025-05-22",
            "status": "SUCCESS"
          }
        ],
        "title": "VersionResponse",
        "description": "/developer/api-version response"
      },
      "WebhookTestResponse": {
        "properties": {
          "apiVersion": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Apiversion",
            "description": "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.",
            "forceType": "string"
          },
          "id": {
            "type": "string",
            "title": "Id",
            "description": "Response ID"
          },
          "webhookStatusCode": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ],
            "description": "Status code returned by your webhook"
          },
          "webhookError": {
            "anyOf": [
              {
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "Error returned from a failed request to your webhook"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/StatusEnum"
              }
            ],
            "description": "Status of the request."
          }
        },
        "type": "object",
        "required": [
          "status"
        ],
        "examples": [
          {
              "webhookStatusCode": 403,
              "webhookError": {
                  "message": "Webhook failed. The webhook URL may not be valid.",
                  "field": "webhook",
                  "url": "https://httpstat.us/403",
                  "code": 403,
                  "error": "403 Forbidden"
              },
              "status": "FAILURE",
              "apiVersion": "2025-05-19",
              "id": "64222cbe"
          },
          {
              "webhookStatusCode": 200,
              "status": "SUCCESS",
              "apiVersion": "2025-05-19",
              "id": "64222cbe"
          }
        ],
        "title": "WebhookTestResponse",
        "description": "/developer/webhook response"
      }
    }
  },
    "servers": [
    {
      "url": "https://api.lazarusai.com",
      "description": ""
    }
  ]
}