Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Chain up to five chat, image, and video steps into one durable async job — billed once, polled once.
{{stepId.field}}, for example to write a scene, illustrate it, then animate the image.
curl https://www.ninjachat.ai/api/v1/pipelines \
-H "Authorization: Bearer $NINJACHAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"steps": [
{
"id": "script",
"type": "chat",
"model": "claude-sonnet-4.6",
"params": { "input": "Describe a lighthouse at dawn in one vivid sentence." }
},
{
"id": "still",
"type": "image",
"model": "flux-2-pro",
"params": { "prompt": "{{script.output}}", "aspect_ratio": "16:9" }
},
{
"id": "clip",
"type": "video",
"model": "veo-3.1-fast",
"params": { "prompt": "{{script.output}}", "image_url": "{{still.url}}" }
}
]
}'
id and its initial state. Poll it:
curl https://www.ninjachat.ai/api/v1/pipelines/$PIPELINE_ID \
-H "Authorization: Bearer $NINJACHAT_API_KEY"
pipeline.completed when the job finishes.
| Field | Notes |
|---|---|
id | Your name for the step. Referenced by later steps. |
type | chat, image, or video. |
model | Any model ID servable for that type — see Models. |
params.input / params.system | Chat steps. |
params.prompt | Image and video steps. |
params.aspect_ratio, params.image_url | Image and video steps. |
| Template | Produced by |
|---|---|
{{stepId.output}} | chat steps — the completion text |
{{stepId.url}} | image and video steps — the asset URL |
{{x.output}} on an image step
is rejected at validation time with a message naming the offending step, before
anything is billed.