Get a document
curl --request GET \
--url https://api.ingestly.ai/documents/{documentId} \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.ingestly.ai/documents/{documentId}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.ingestly.ai/documents/{documentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ingestly.ai/documents/{documentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ingestly.ai/documents/{documentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ingestly.ai/documents/{documentId}")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ingestly.ai/documents/{documentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "0199a6c2-3f1e-7b2a-9c4d-5e6f7a8b9c0d",
"contentType": "application/pdf",
"size": 184320,
"pageCount": 2,
"status": "completed",
"createdOn": "2026-10-02T14:03:09+00:00",
"workflowId": "0199a6c1-9e2f-7c3d-8a4b-1c2d3e4f5a6b",
"name": "po-1182.pdf",
"reference": "PO-1182",
"metadata": {}
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"instance": "<string>",
"traceId": "<string>",
"detail": "<string>",
"errors": {}
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"instance": "<string>",
"traceId": "<string>",
"detail": "<string>",
"errors": {}
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"instance": "<string>",
"traceId": "<string>",
"detail": "<string>",
"errors": {}
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"instance": "<string>",
"traceId": "<string>",
"detail": "<string>",
"errors": {}
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"instance": "<string>",
"traceId": "<string>",
"detail": "<string>",
"errors": {}
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"instance": "<string>",
"traceId": "<string>",
"detail": "<string>",
"errors": {}
}Documents
Get a document
Returns a document’s file details, its status, and the reference and metadata the trigger stored with it. status is held while the document waits for a person to run it.
GET
/
documents
/
{documentId}
Get a document
curl --request GET \
--url https://api.ingestly.ai/documents/{documentId} \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.ingestly.ai/documents/{documentId}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.ingestly.ai/documents/{documentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ingestly.ai/documents/{documentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ingestly.ai/documents/{documentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ingestly.ai/documents/{documentId}")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ingestly.ai/documents/{documentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "0199a6c2-3f1e-7b2a-9c4d-5e6f7a8b9c0d",
"contentType": "application/pdf",
"size": 184320,
"pageCount": 2,
"status": "completed",
"createdOn": "2026-10-02T14:03:09+00:00",
"workflowId": "0199a6c1-9e2f-7c3d-8a4b-1c2d3e4f5a6b",
"name": "po-1182.pdf",
"reference": "PO-1182",
"metadata": {}
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"instance": "<string>",
"traceId": "<string>",
"detail": "<string>",
"errors": {}
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"instance": "<string>",
"traceId": "<string>",
"detail": "<string>",
"errors": {}
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"instance": "<string>",
"traceId": "<string>",
"detail": "<string>",
"errors": {}
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"instance": "<string>",
"traceId": "<string>",
"detail": "<string>",
"errors": {}
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"instance": "<string>",
"traceId": "<string>",
"detail": "<string>",
"errors": {}
}{
"status": 123,
"title": "<string>",
"type": "<string>",
"instance": "<string>",
"traceId": "<string>",
"detail": "<string>",
"errors": {}
}Requires the
documents:read scope. Returns the reference and metadata sent with the trigger. When a run the trigger returned stays 404, the document’s status tells you why.Authorizations
Path Parameters
Response
OK
Example:
"0199a6c2-3f1e-7b2a-9c4d-5e6f7a8b9c0d"
Example:
"application/pdf"
Example:
184320
Example:
2
Available options:
pending, uploaded, processing, completed, failed, review, cancelled, held, unassigned, queued Example:
"completed"
Example:
"2026-10-02T14:03:09+00:00"
Example:
"0199a6c1-9e2f-7c3d-8a4b-1c2d3e4f5a6b"
Example:
"po-1182.pdf"
Example:
"PO-1182"