1. Before you start
Confirm service availability, API base URL, supported contract revision, approved identity flow, tenant/workspace scope and the relevant operational owner.
DOCUMENTATION OVERVIEW
Integrate with explicit contracts.
This page provides the integration checklist and documentation map. Exact endpoint schemas and authentication settings must be taken from the supported API revision for your target environment; do not infer production endpoints from examples.
2. Request and response handling
Validate request schemas; bound payload sizes; handle rate limits, timeouts, validation errors and service failures. Do not treat an accepted request as proof that a job completed.
3. Run lifecycle
Track the server-reported job identifier and state. Retry only when the contract makes the operation safe; use idempotency keys where supported and distinguish cancellation requested from cancellation completed.
4. Evidence and exports
Preserve the returned source URL, retrieval metadata, integrity fields and content hash where supplied. Validate export schema and hash before storage or downstream processing.
5. Error and recovery design
Make failures visible, avoid unbounded polling, apply bounded exponential backoff where appropriate, and do not retry unsafe operations across providers or systems without a defined idempotency contract.
6. Agent and MCP consumers
Tool registration, operation-level policy, approvals and audit remain Platform-owned. Pin immutable consumer revisions and verify TSIC conformance for the exact deployed versions.
Live API reference
A verified public API reference and production base URL are not established in this repository. This overview is not a substitute for a versioned OpenAPI contract or an enabled service. Contact the integration owner before implementing against a live endpoint.
Developer requirements