AYaymara-ai
Files

Upload File Multipart

Changed on

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

Request

Query parameters

workspace_uuidstring nullable

Request body multipart/form-data

filestring binary required

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

  • 9b529d67a7d0Revision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      added the new optional query request parameter workspace_uuid

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1a765a4c3f3bRevision changes
    • info

      endpoint added