Skip to main content
POST
Complete a file upload

Authorizations

Authorization
string
header
required

An API key from Settings > API & MCP.

Path Parameters

id
string<uuid>
required

The id of the idea, input, post or agent run.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

workspace_id
string<uuid>

The workspace to act in. Optional when the key has a default or a lock, or you belong to one workspace.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
as_user
string<uuid>

API keys of owners and admins only (not OAuth apps): act as this member of the workspace (like View As). Every use is audited.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

The body is of type object.

Response

OK

object
string
required
Allowed value: "input_upload"
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
workspace_id
string<uuid>
required

Pass it on later calls if you work in several workspaces.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status
enum<string>
required
Available options:
pending,
completing,
completed,
failed,
expired
media_type
enum<string>
required
Available options:
video,
audio,
pdf,
image
size_bytes
number
required
expires_at
string
required

Complete the upload before this time.

uploaded
boolean | null
required

While pending: whether the file has arrived (then call complete).

upload
object | null
required
input
object | null
required
error
object | null
required