API overview
Base URL, request conventions, and response formats for the Pipevideo API.
Base URL
https://api.pipevideo.co/v1All paths below are relative to this base.
Content type
Send Content-Type: application/json on POST requests. Responses are JSON.
Authentication
Public endpoints (GET /v1/engines) require no credentials. All other endpoints require a Bearer API key. See Authentication.
Request shape
Video generation uses the OpenAI Responses format with Pipevideo extensions:
{
"model": "moonshotai/kimi-k2.5",
"input": "A cat walking on a beach at sunset",
"instructions": "You are a motion designer.",
"width": 1080,
"height": 1920,
"provider": { "order": ["framerate"] }
}The model field is an orchestration LLM id, not an engine slug. List available models via GET /v1/engines.
Response shape
Successful responses return JSON objects. Failed requests return an error envelope:
{
"message": "Human readable error description"
}See Errors for status codes and handling.
Async generations
POST /v1/responses returns immediately with status: "queued". Poll GET /v1/responses/{id} or configure webhooks for completion notifications.
Optional headers
| Header | Description |
|---|---|
HTTP-Referer | App URL for attribution |
X-Pipevideo-Title | App name for attribution |
X-Application-Name | Alternative app identifier |
See App attribution.