Skip to main content
POST
Start an upload session

Authorizations

x-api-key
string
header
required

Body

application/json
filename
string
required

Client-provided file name (used for display only).

contentType
string

MIME type of the file (e.g., application/pdf). Optional; inferred if omitted.

sizeBytes
integer

Total file size in bytes. Used to determine single vs multipart upload.

ingestionMode
enum<string>
default:default

Controls how the uploaded file is ingested. Use policy when uploading a policy document that will generate compliance rules.

Available options:
default,
policy

Response

Upload session info

mode
enum<string>

Upload mode chosen by server based on size.

Available options:
single,
multipart
uploadId
string

Server-side upload session id.

key
string

S3 object key to use for subsequent requests.

putUrl
string

Pre-signed URL for single part upload (present when mode=single).

uploadIdS3
string

S3 UploadId for multipart uploads.