Sign in
Files

Upload File Multipart

Upload a file directly in the request body. Use this for single file uploads from your application.

For video files, processing happens asynchronously - use GET /files/{file_uuid}/status to check processing status before accessing frames.

Args: file: The file to upload (multipart form data) workspace_uuid: Optional workspace to associate the file with

Returns: FileUploadResult with file_uuid for future reference and file_url for immediate access. For videos, check processing_status field - use status endpoint to poll until "completed".

post/v2/files/-/uploads

Query parameters

workspace_uuidstring nullable

Response

OK

local_file_pathstring nullable

Local file path of the uploaded file, if available.

remote_uristring nullable

Remote URI to fetch the file from, if available.

content_typestring nullable

MIME type of the file (e.g., 'video/mp4'). If not provided, will be inferred from file extension.

file_uuidstring nullable

Unique identifier for the uploaded file.

file_urlstring nullable

URL to access the uploaded file, if available.

remote_file_pathstring nullable

Remote file path of the uploaded file, if available.

processing_statusstring

Processing status: pending, processing, completed, or failed.

Changes

Changed in 2 of the 25 revisions of this API.95

  • 9b529d67a7d094See the full diff
    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 409

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 422

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the error/code response property for the response status 503

      response-property-enum-value-added

    • ○

      added the new optional query request parameter workspace_uuid

      new-optional-request-parameter

    • ○

      added the optional property content_type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property processing_status to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property remote_uri to the response with the 200 status

      response-optional-property-added

  • 1a765a4c3f3b1See the full diff
    • ○

      endpoint added

      endpoint-added