Skip to main content
POST
Create Input

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

OnDeck-Project
string

Project ID for the input. If not provided, the input will be created in the default project.

Body

application/json
file_name
string
required

Name of the input file (video or image) to upload. File names are unique within a project. Uploading a file to an existing input will overwrite the existing file, and add it to any new Collections if specified. Membership to previously added Collections will not be removed.

Maximum string length: 255
Pattern: ^[a-zA-Z0-9!\-_.()*]+\.([a-zA-Z]+)$
Example:

"video.mp4"

collection_ids
string<uuid>[]

IDs of the Collections the Input belongs to. The Collections must belong to the same project as the Input. If not provided, the file will not be added to a Collection. You can still query on the Input individually.

details
object

Response

Input created successfully

input_id
string<uuid>
Example:

"123e4567-e89b-12d3-a456-426614174000"

signed_url
string<uri>
file_name
string
mime_type
string
status
enum<string>
Available options:
processing,
valid,
invalid,
unknown
project_id
string<uuid>
Example:

"9121f30d-af29-46ab-a7be-11c9a072ee16"

collection_ids
string<uuid>[]

IDs of the Collections the Input belongs to.

details
object | null
indexed
boolean

Whether the video has completed indexing for enhanced querying.

created_at
string<date-time>
Example:

"2026-04-20T12:34:56.000Z"