Upload a file

Upload a file into the session’s uploads directory. The file is stored under uploads/{filename} within the session scope and its relative path is returned as the file ID. Uploading a file with the same name overwrites the existing one.

Query parameters

scope_idstringRequired

Session / container identifier (matches the container field in chat requests).

Request

Request payload.
filefileRequired
file field.

Response

Successful Response
idstring

Relative path of the file within the session, e.g. ‘uploads/data.csv’ or ‘outputs/result.png’. Use this value as file_id in subsequent requests.

created_atdatetime

ISO-8601 timestamp when the file was created or last modified.

filenamestring
Filename derived from the path.
mime_typestring
MIME type detected from the file content.
size_bytesinteger
File size in bytes.
downloadableboolean

True for sandbox output files; False for uploaded input files.

scopeobject
Session scope this file belongs to.
type"file"Defaults to file
Object type discriminator, always 'file'.

Errors

401
Unauthorized Error
422
Unprocessable Entity Error