cURL
curl --request POST \
--url http://localhost:4000/pipelines/{pipelineId}/trigger \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file'import requests
url = "http://localhost:4000/pipelines/{pipelineId}/trigger"
files = { "file": ("example-file", open("example-file", "rb")) }
response = requests.post(url, files=files)
print(response.text)const form = new FormData();
form.append('file', '<string>');
const options = {method: 'POST'};
options.body = form;
fetch('http://localhost:4000/pipelines/{pipelineId}/trigger', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "4000",
CURLOPT_URL => "http://localhost:4000/pipelines/{pipelineId}/trigger",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:4000/pipelines/{pipelineId}/trigger"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:4000/pipelines/{pipelineId}/trigger")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:4000/pipelines/{pipelineId}/trigger")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>"
}{
"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": {}
}Endpoints
Trigger pipeline via webhook
POST
/
pipelines
/
{pipelineId}
/
trigger
cURL
curl --request POST \
--url http://localhost:4000/pipelines/{pipelineId}/trigger \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file'import requests
url = "http://localhost:4000/pipelines/{pipelineId}/trigger"
files = { "file": ("example-file", open("example-file", "rb")) }
response = requests.post(url, files=files)
print(response.text)const form = new FormData();
form.append('file', '<string>');
const options = {method: 'POST'};
options.body = form;
fetch('http://localhost:4000/pipelines/{pipelineId}/trigger', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "4000",
CURLOPT_URL => "http://localhost:4000/pipelines/{pipelineId}/trigger",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:4000/pipelines/{pipelineId}/trigger"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:4000/pipelines/{pipelineId}/trigger")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:4000/pipelines/{pipelineId}/trigger")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"documentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>"
}{
"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": {}
}Idempotency
Send an optionalIdempotency-Key request header to make a trigger safe to retry. The value must be a GUID.
- A request whose key is missing or is not a valid GUID is processed normally, with no idempotency protection.
- While a request with a given key is in flight, or after it has completed, a second request with the same key returns 409 Conflict.
- If the request fails, its pending marker is released automatically, so you can safely retry the same key.
curl -X POST "https://api.ingestly.ai/pipelines/{pipelineId}/trigger" \
-H "X-Api-Key: ing_your_api_key_here" \
-H "Idempotency-Key: 3f2504e0-4f89-41d3-9a0c-0305e82c3301" \
-F "file=@document.pdf"
Correlation ID
Every response includes anX-Correlation-ID header, a server-generated identifier for the request. Include it when contacting support so a specific request can be traced.
Any
X-Correlation-ID you send on the request is ignored at the public edge; the platform always mints a fresh id and returns it on the response.Headers
Optional GUID that makes the request idempotent. A duplicate request with the same key returns 409 while the first is in flight or after it completed.
Path Parameters
Body
multipart/form-data
⌘I