Skip to main content
POST
Create a document (file) and get a presigned upload URL

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Body

application/json
file_name
string
required
category
string

Folder category (default 'general').

mime_type
string

Optional; inferred from file_name when omitted.

source_type
string

Linked resource type (e.g. order, vendor_bill).

source_id
string<uuid>

Linked resource id.

source_label
string
description
string
tags
string[]
backfill_source_key
string

Durable idempotency provenance key for migration loaders.

Response

Idempotent hit (backfill_source_key already present); the existing row is returned with a null upload_url.

data
object
upload_url
string | null
idempotent
boolean
Example:

true