Skip to main content
Import Documents to an agreement

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

idempotency-key
string
required

Required protection for safely retrying this request. Choose a unique value for each import and reuse it with the same agreement and input when retrying.

Required string length: 1 - 200
Pattern: ^[\x21-\x7e]+$

Path Parameters

id
string<uuid>
required

Body

application/json
documents
object[]
required
Required array length: 1 - 100 elements
mode
enum<string>
default:auto
Available options:
auto,
review

Response

Idempotent replay.

workflow_run_id
string<uuid>
required
documents
object[]
required