Skip to main content
POST
Upload a document to a project (REST multipart)

Authorizations

Authorization
string
header
required

A Personal Access Token issued from https://app.auditynow.com/dashboard/settings/api-tokens. Format: aky_<32 random chars>.

Headers

Content-Length
integer
required

Byte length of the multipart body. Validated before the body is parsed: missing or non-positive returns 411; a value over the absolute body cap (25MB + multipart overhead) returns 413.

Required range: x >= 1
Idempotency-Key
string

Optional client-supplied key for safe retries. A random UUID is generated server-side if omitted.

Path Parameters

id
string<uuid>
required

The project's UUID.

Body

multipart/form-data

multipart/form-data parts for POST /api/agent/projects/{id}/documents.

file
file
required

The file to upload. Allowed types: PDF, Word (.doc/.docx), plain text, Markdown, audio (.mp3/.wav/.m4a), images (.png/.jpg/.jpeg/.webp), spreadsheets (.csv/.xlsx/.xls), presentations (.pptx), XML, and email (.eml). Max 10MB per file, 25MB for .pptx.

category
enum<string>
default:audit

Document category. Defaults to audit if omitted.

Available options:
audit,
supporting
department
string

Optional free-text department label.

Response

Document uploaded and registered.

data
object
required

The registered document record returned by the agent upload endpoint.

nextStep
string
required

Guidance for what to call next.

Example:

"Call audity_enqueue_document_analysis (or POST .../audit-analysis/async) to analyze uploaded documents."