Skip to main content
POST
/
api
/
public
/
v1
/
forms
/
{codeOrId}
/
uploads
Error
A valid request URL is required to generate request examples
{
  "file_id": "01935-ffff-0000-1111-222222222222",
  "url": "https://flow.example.com/uploads/…",
  "name": "receipt.pdf",
  "mime": "application/pdf",
  "size": 84213
}

Authorizations

​
publicKey
string
query
required

Public widget/form key (pk_live_…). Exchanged for a session token by POST /api/public/v1/chat/sessions. Public Forms operations accept the same key directly, supplied via this publicKey query param, the X-Comerix-Public-Key header (publicFormKey scheme), or in the JSON body.

Path Parameters

​
codeOrId
string
required

The form's stable code or its UUID.

Query Parameters

​
field
string
required

The file field's name on the form.

​
publicKey
string

Body

multipart/form-data
​
file
file
required

The file to upload.

Response

File stored

​
file_id
string
required
​
url
string
required
​
name
string
required
​
mime
string
required
​
size
integer
required