Skip to main content
POST
Upload a file

Authorizations

Authorization
string
header
default:${YOUR_API_KEY}
required

Neural4D API key using the Bearer scheme.

Body

multipart/form-data
file
file
required

File to upload. Supported image formats: JPG, JPEG, PNG, GIF, WEBP, BMP, HEIC, and HEIF. Supported video formats: MP4, MOV, WEBM, M4V, OGG, and OGV. Supported audio formats: MP3 and WAV.

Response

File uploaded

id
string
required

File ID used by generation requests.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
Example:

"550e8400-e29b-41d4-a716-446655440000"

filename
string
required

Original name of the uploaded file.

Example:

"first-frame.png"

bytes
integer<int64>
required

Uploaded file size in bytes.

Required range: x >= 0
Example:

245760

mime_type
string
required

Media type detected for the uploaded file.

Example:

"image/png"

created_at
integer<int64>
required

Unix timestamp in seconds when the file was created.