Skip to main content
Read configuration.operational_profile to discover the effective limits for your workspace and environment. The response includes a profile ID and version, supported file types, request budgets and resource lifetimes. Use these values when configuring uploads, polling and recovery. GETs use the reads budget, uploadDocument uses uploads, and other POST/PATCH requests use commands. A 429 carries Retry-After in whole seconds, which overrides local polling schedules. A 503 may include it as well. Caller timeouts do not cancel accepted work. Keep total waiting bounded in your application and hand unresolved requests to durable background reconciliation. The example profile provides synthetic values for local tests. Use the profile returned by your environment for its effective limits. Source freshness and coverage remain provider-specific; polling frequency does not make sources refresh faster.

​
Changes and expiration

Profiles apply prospectively. Existing issued capabilities and cursors keep their disclosed expiry unless authorization is revoked or the workspace closes. Save the profile ID/version with integration diagnostics. Key revocation and consent withdrawal take priority over unexpired links or retained snapshots. Snapshots bind workspace, environment, caller authorization and filters. Cursor chains cannot change filters. Empty change/event batches still return a resumable cursor and expiry. On 410, establish a new checkpoint and reconcile a fresh complete snapshot, including deletions; never silently discard the gap.

​
Upload inspection

The example profile accepts PDF, PNG, JPEG and WebP. Check allowed_document_mime_types for the types supported by your environment. Password-protected/encrypted files and archives are not accepted by this contract. Detected type mismatch returns 415 unsupported_media_type. If discovered after asynchronous acceptance, the document becomes rejected with failure.code document_rejected and a safe explanation. Infected, corrupt, empty or unreadable files never become available. Re-upload a corrected file as a new immutable record. Client-side checks improve feedback; AMLOK validates size, content type and authorization for every upload. Uploads are not fetched from arbitrary customer URLs. Downloads use short-lived HTTPS capabilities with MIME type and SHA-256; verify integrity after transfer and avoid logging URLs.