API & SDK

Use metadata and citations

Add request traceability and present public sources from a response.

Updated August 3, 2026 Β· 8 min

Add technical metadata

{"message":"Summarize the account","metadata":{"source":"crm","tenant_id":"org_123","request_id":"req_456"}}

Use stable technical data, never secrets or unnecessary personal information. external_reference can associate an invocation with an external identifier up to 255 characters.

Present citations

When enabled, responses may include document, knowledge base, excerpt, section, page, and public availability. Place citations near the supported statement and do not build links for unavailable documents.

The public API and SDKs expose only channel-authorized citations, never internal retrieval sources.