API reference
Create a video task
Endpoints, request fields and response schemas for calling NeonAPI.
POST /v1/videos
Authentication
Use your NeonAPI API key in Authorization: Bearer YOUR_API_KEY. Keep the key in a trusted application environment.
Availability and compatibility
Check the selected model’s protocol, permissions, price and supported parameters before calling. Unsupported parameters may be rejected. Request examples use placeholders.
Request fields
multipart/form-data
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
model | string | No | — | Exact published model ID. |
prompt | string | No | — | Instruction or generation prompt. |
seconds | string | No | — | — |
input_reference | string | No | binary | — |
Full field definitions, nested objects and referenced schemas are available in the downloadable specification.
Request example
export NEON_API_KEY="YOUR_API_KEY"
curl https://neon-api.com/v1/videos \
-H "Authorization: Bearer $NEON_API_KEY" \
-F "model=YOUR_MODEL_ID" \
-F "prompt=A slow journey through a constellation"Responses
Fields vary by model and protocol. The schema below describes the documented successful response; streams use protocol-specific events.
| Status | Meaning |
|---|---|
| 200 | Successful response |
| 400 | Invalid request |
Response schema
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
id | string | Yes | — | Identifier returned for this result or task. |
object | string | Yes | — | — |
model | string | Yes | — | Exact published model ID. |
status | string | Yes | — | Current asynchronous task state. |
progress | integer | Yes | — | — |
created_at | integer | Yes | — | — |
seconds | string | Yes | — | — |
completed_at | integer | No | — | — |
expires_at | integer | No | — | — |
size | string | No | — | — |
error | OpenAIVideoError | No | — | — |
metadata | object | No | — | — |
Download the user API OpenAPI specification
See errors and streaming & tasks.