const options = {
method: "GET",
headers: { "x-api-key": "<your-api-key>" },
};
fetch(
"https://api-v2.getomni.ai/api/v1/spreads/9f1e2d3c-4b5a-6789-0abc-def012345678",
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/9f1e2d3c-4b5a-6789-0abc-def012345678"
headers = {"x-api-key": "<your-api-key>"}
response = requests.request("GET", url, headers=headers)
print(response.json())
curl --request GET \
--url https://api-v2.getomni.ai/api/v1/spreads/9f1e2d3c-4b5a-6789-0abc-def012345678 \
--header 'x-api-key: <your-api-key>'
{
"success": true,
"spread": {
"id": "9f1e2d3c-4b5a-6789-0abc-def012345678",
"status": "COMPLETE",
"error": null,
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"documents": [
{ "id": "doc-a", "filename": "2023-tax-return.pdf", "status": "EXTRACTED", "error": null },
{ "id": "doc-b", "filename": "2023-financials.pdf", "status": "EXTRACTED", "error": null }
],
"artifacts": [
{ "id": "art-report", "type": "REPORT", "title": "Financial Spread - Pacific Coast Container Haulers" },
{ "id": "art-sheet", "type": "SPREADSHEET", "title": "Financial Spread - Pacific Coast Container Haulers (Excel)" }
],
"createdAt": "2026-07-23T18:04:00.000Z",
"updatedAt": "2026-07-23T18:08:40.000Z"
}
}
Spreads
Get Spread
Poll a financial spreading run’s status and artifacts
GET
/
api
/
v1
/
spreads
/
:spreadId
const options = {
method: "GET",
headers: { "x-api-key": "<your-api-key>" },
};
fetch(
"https://api-v2.getomni.ai/api/v1/spreads/9f1e2d3c-4b5a-6789-0abc-def012345678",
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/9f1e2d3c-4b5a-6789-0abc-def012345678"
headers = {"x-api-key": "<your-api-key>"}
response = requests.request("GET", url, headers=headers)
print(response.json())
curl --request GET \
--url https://api-v2.getomni.ai/api/v1/spreads/9f1e2d3c-4b5a-6789-0abc-def012345678 \
--header 'x-api-key: <your-api-key>'
{
"success": true,
"spread": {
"id": "9f1e2d3c-4b5a-6789-0abc-def012345678",
"status": "COMPLETE",
"error": null,
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"documents": [
{ "id": "doc-a", "filename": "2023-tax-return.pdf", "status": "EXTRACTED", "error": null },
{ "id": "doc-b", "filename": "2023-financials.pdf", "status": "EXTRACTED", "error": null }
],
"artifacts": [
{ "id": "art-report", "type": "REPORT", "title": "Financial Spread - Pacific Coast Container Haulers" },
{ "id": "art-sheet", "type": "SPREADSHEET", "title": "Financial Spread - Pacific Coast Container Haulers (Excel)" }
],
"createdAt": "2026-07-23T18:04:00.000Z",
"updatedAt": "2026-07-23T18:08:40.000Z"
}
}
Retrieve a spreading run: its lifecycle status, per-document progress, and — once complete — its report and spreadsheet artifacts. Poll this endpoint while a run is in flight, or subscribe to the spread webhooks instead.
Authentication
Requires thex-api-key header with a valid workspace API key.
Path Parameters
string
required
The run id returned by Create Spread.
Response
boolean
Whether the request succeeded.
object
The run.
Show spread
Show spread
string
The run id.
string
The lifecycle status:
IN_PROGRESS, COMPLETE, or FAILED.string | null
The failure message when
status is FAILED, otherwise null.string | null
The lead the run belongs to.
array
The input documents, each with
id, filename, status (PROCESSING,
EXTRACTED, SKIPPED, or FAILED), and
error. id is the document’s id in your workspace — the same id the
document endpoints use — or
null if the document has since been deleted.array
The report and spreadsheet, each with
id, type
(REPORT or SPREADSHEET), and title. Populated whenever status is
COMPLETE. A regenerating run keeps its previous artifacts until the new
ones replace them on completion.string
When the run was created.
string
When the run last changed.
Errors
error
No spread with this id exists in your workspace.
const options = {
method: "GET",
headers: { "x-api-key": "<your-api-key>" },
};
fetch(
"https://api-v2.getomni.ai/api/v1/spreads/9f1e2d3c-4b5a-6789-0abc-def012345678",
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/9f1e2d3c-4b5a-6789-0abc-def012345678"
headers = {"x-api-key": "<your-api-key>"}
response = requests.request("GET", url, headers=headers)
print(response.json())
curl --request GET \
--url https://api-v2.getomni.ai/api/v1/spreads/9f1e2d3c-4b5a-6789-0abc-def012345678 \
--header 'x-api-key: <your-api-key>'
{
"success": true,
"spread": {
"id": "9f1e2d3c-4b5a-6789-0abc-def012345678",
"status": "COMPLETE",
"error": null,
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"documents": [
{ "id": "doc-a", "filename": "2023-tax-return.pdf", "status": "EXTRACTED", "error": null },
{ "id": "doc-b", "filename": "2023-financials.pdf", "status": "EXTRACTED", "error": null }
],
"artifacts": [
{ "id": "art-report", "type": "REPORT", "title": "Financial Spread - Pacific Coast Container Haulers" },
{ "id": "art-sheet", "type": "SPREADSHEET", "title": "Financial Spread - Pacific Coast Container Haulers (Excel)" }
],
"createdAt": "2026-07-23T18:04:00.000Z",
"updatedAt": "2026-07-23T18:08:40.000Z"
}
}
⌘I