Create Spread

const options = {
  method: "POST",
  headers: {
    "x-api-key": "<your-api-key>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    leadId: "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
  }),
};

fetch("https://api-v2.getomni.ai/api/v1/spreads", options)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

import requests

url = "https://api-v2.getomni.ai/api/v1/spreads"
headers = {
    "x-api-key": "<your-api-key>",
    "Content-Type": "application/json",
}
payload = {"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5"}

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())

curl --request POST \
  --url https://api-v2.getomni.ai/api/v1/spreads \
  --header 'x-api-key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5"
  }'

{
  "success": true,
  "spread": {
    "id": "9f1e2d3c-4b5a-6789-0abc-def012345678",
    "status": "IN_PROGRESS",
    "error": null,
    "leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
    "documents": [
      {
        "id": "doc-a",
        "filename": "2023-tax-return.pdf",
        "status": "PROCESSING",
        "error": null
      },
      {
        "id": "doc-b",
        "filename": "2023-financials.pdf",
        "status": "PROCESSING",
        "error": null
      }
    ],
    "artifacts": [],
    "createdAt": "2026-07-23T18:04:00.000Z",
    "updatedAt": "2026-07-23T18:04:00.000Z"
  }
}

POST

api

spreads

const options = {
  method: "POST",
  headers: {
    "x-api-key": "<your-api-key>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    leadId: "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
  }),
};

fetch("https://api-v2.getomni.ai/api/v1/spreads", options)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

import requests

url = "https://api-v2.getomni.ai/api/v1/spreads"
headers = {
    "x-api-key": "<your-api-key>",
    "Content-Type": "application/json",
}
payload = {"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5"}

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())

curl --request POST \
  --url https://api-v2.getomni.ai/api/v1/spreads \
  --header 'x-api-key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5"
  }'

{
  "success": true,
  "spread": {
    "id": "9f1e2d3c-4b5a-6789-0abc-def012345678",
    "status": "IN_PROGRESS",
    "error": null,
    "leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
    "documents": [
      {
        "id": "doc-a",
        "filename": "2023-tax-return.pdf",
        "status": "PROCESSING",
        "error": null
      },
      {
        "id": "doc-b",
        "filename": "2023-financials.pdf",
        "status": "PROCESSING",
        "error": null
      }
    ],
    "artifacts": [],
    "createdAt": "2026-07-23T18:04:00.000Z",
    "updatedAt": "2026-07-23T18:04:00.000Z"
  }
}

Start a financial spreading run for a lead. Omni classifies and extracts the lead’s PDF financial documents (tax returns, income statements, balance sheets), consolidates them onto a standardized multi-period template, and produces a report and an Excel workbook. The run happens in the background and takes a few minutes; this endpoint returns immediately with the new run’s id. Track it with Get Spread or the spread webhooks.

Authentication

Requires the x-api-key header with a valid workspace API key.

Request Body

string

required

The lead whose documents to spread.

string[]

Spread only these documents, a subset of the lead’s documents. Every id must resolve to a document on the lead. Omit to spread all of the lead’s PDF documents.

Response

boolean

Whether the request succeeded.

object

The created run, in the same shape as Get Spread. status is always IN_PROGRESS, and artifacts is empty until the run completes.

Errors

error

No leadId; a documentIds value doesn’t resolve to a document on the lead; or the resolved documents contain no PDFs.

error

The leadId isn’t a lead in your workspace.

error

The lead already has a spread IN_PROGRESS. Wait for it to reach COMPLETE or FAILED before starting another.

const options = {
  method: "POST",
  headers: {
    "x-api-key": "<your-api-key>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    leadId: "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
  }),
};

fetch("https://api-v2.getomni.ai/api/v1/spreads", options)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

import requests

url = "https://api-v2.getomni.ai/api/v1/spreads"
headers = {
    "x-api-key": "<your-api-key>",
    "Content-Type": "application/json",
}
payload = {"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5"}

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())

curl --request POST \
  --url https://api-v2.getomni.ai/api/v1/spreads \
  --header 'x-api-key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5"
  }'

{
  "success": true,
  "spread": {
    "id": "9f1e2d3c-4b5a-6789-0abc-def012345678",
    "status": "IN_PROGRESS",
    "error": null,
    "leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
    "documents": [
      {
        "id": "doc-a",
        "filename": "2023-tax-return.pdf",
        "status": "PROCESSING",
        "error": null
      },
      {
        "id": "doc-b",
        "filename": "2023-financials.pdf",
        "status": "PROCESSING",
        "error": null
      }
    ],
    "artifacts": [],
    "createdAt": "2026-07-23T18:04:00.000Z",
    "updatedAt": "2026-07-23T18:04:00.000Z"
  }
}

Upload Documents Get Spread

Getting Started

Leads

Documents

Spreads

Artifacts

Analytics

Webhooks

Authentication

Request Body

Response

Errors

​Authentication

​Request Body

​Response

​Errors

Authentication

Request Body

Response

Errors