// API

Publish a Pipeline as a REST API

Every pipeline you build can be published. Publishing creates an API key and an execute URL; you POST inputs and get outputs back. Long jobs can run asynchronously and report to a callback URL.

Nodes used

INPUT__IMAGE

Accepts an image_url string.

OUTPUT__

Collects and returns all upstream results.

How to set it up

  1. 01Build and run the pipeline in the workspace.
  2. 02Click Publish to get the execute URL for that session.
  3. 03POST JSON with an inputs object to the execute endpoint.
  4. 04For long jobs set async to true, pass callbackUrl and an optional _jobId; you get an accepted response and the result is delivered to your callback.
curl -X POST https://azakros.net/api/node/api/{apiKey}/execute \
  -H "Content-Type: application/json" \
  -d '{ "inputs": { "image_url": "https://example.com/image.jpg" } }'

Status codes

200 means the pipeline completed. 202 means an async job was queued. 400 and 422 mean missing or invalid inputs, 404 means the key is unknown or the session is not published, 429 means you are rate limited, and 500 means processing failed and may be retried.

Keep keys secret

The key is part of the URL, so call the endpoint from your server, not from public client code. Full request and response details are in the API docs.

API DOCSSTART FREE

Related guides