Skip to main content
POST
Create a document upload URL
Requires Editor, Admin, or Owner. Supply the file name and MIME type. The response includes document_uuid, s3_key, and an upload URL valid for 30 minutes. Upload the file bytes with PUT to that URL, using the same content type. The upload limit is 100,000,000 bytes. Do not send your Agent Builder API key to the upload host. After upload, call Process a document. Requesting a URL alone does not process or index the file. The schema accepts custom_metadata, but this upload operation does not persist it.

Authorizations

Authorization
string
header
required

Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs super_user role.

Headers

X-VOAI-ORGANIZATION-ID
string | null

Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace ID to access. The key owner must be a current member. Missing or invalid IDs return 400; non-member workspaces return 403. Not required for bearer authentication, which uses the user's selected workspace.

Body

application/json
filename
string
required
mime_type
string
required
custom_metadata
Custom Metadata · object | null

Response

Successful Response

document_uuid
string
required
s3_key
string
required
upload_url
string
required