const options = {
method: "GET",
headers: { "x-api-key": "<your-api-key>" },
};
fetch("https://api-v2.getomni.ai/api/v1/artifacts/art-report", 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/artifacts/art-report"
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/artifacts/art-report \
--header 'x-api-key: <your-api-key>'
{
"success": true,
"artifact": {
"id": "art-report",
"type": "REPORT",
"title": "Financial Spread - Pacific Coast Container Haulers",
"summary": "Consolidated financial spread from 2 document(s).",
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"createdAt": "2026-07-23T18:08:38.000Z",
"contentType": "application/pdf",
"filename": "Financial Spread - Pacific Coast Container Haulers.pdf"
}
}
Artifacts
Get Artifact
Retrieve metadata for an artifact
GET
/
api
/
v1
/
artifacts
/
:artifactId
const options = {
method: "GET",
headers: { "x-api-key": "<your-api-key>" },
};
fetch("https://api-v2.getomni.ai/api/v1/artifacts/art-report", 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/artifacts/art-report"
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/artifacts/art-report \
--header 'x-api-key: <your-api-key>'
{
"success": true,
"artifact": {
"id": "art-report",
"type": "REPORT",
"title": "Financial Spread - Pacific Coast Container Haulers",
"summary": "Consolidated financial spread from 2 document(s).",
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"createdAt": "2026-07-23T18:08:38.000Z",
"contentType": "application/pdf",
"filename": "Financial Spread - Pacific Coast Container Haulers.pdf"
}
}
Retrieve metadata for an artifact, such as a financial spread’s report or spreadsheet. The response includes the download content type and a suggested filename; it does not include the file itself. Fetch the bytes with Download Artifact.
Authentication
Requires thex-api-key header with a valid workspace API key.
Path Parameters
string
required
The artifact id, from a spread’s
artifacts array or the spread.completed
webhook.Response
boolean
Whether the request succeeded.
object
The artifact metadata.
Show artifact
Show artifact
string
The artifact id.
string
REPORT or SPREADSHEET.string
Human-readable title.
string
Short description of the artifact.
string | null
The lead the artifact belongs to, if any.
string
When the artifact was created.
string
The MIME type served by
/content: application/pdf for a REPORT,
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for a
SPREADSHEET.string
A suggested download filename, including the extension.
Errors
error
No artifact 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/artifacts/art-report", 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/artifacts/art-report"
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/artifacts/art-report \
--header 'x-api-key: <your-api-key>'
{
"success": true,
"artifact": {
"id": "art-report",
"type": "REPORT",
"title": "Financial Spread - Pacific Coast Container Haulers",
"summary": "Consolidated financial spread from 2 document(s).",
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"createdAt": "2026-07-23T18:08:38.000Z",
"contentType": "application/pdf",
"filename": "Financial Spread - Pacific Coast Container Haulers.pdf"
}
}