Comment on page

Static API Guide

Use the Static API to submit data to your pipeline
The static API for Pipelines is currently in beta.


Deployment pipelines support a low-latency streaming pipeline that can accept input through a static API endpoint. The data is then processed through the pipeline and resulting output is returned.


Adding a Static API Endpoint input source to your deployment will generate an API URL. To add this input source, see here:
Copy the API URL from the Connected Inputs table.


Admins or Project Managers can generate an API Key in Settings to use for authentication. See the "Authorization" header below for details on using this key as a token.
Expand POST /process below to see details about the API parameters and responses:
Process input through the pipeline

Usage examples

Sending a JPEG with cURL:
curl -X POST https://<HOSTNAME>/v1/deployments/<deploymentID>/inputs/<ID>/process \
--header 'Authorization: Bearer <APIKEY>' \
--header 'Content-Type: image/jpeg' \
--data-binary '@image.jpg'