Browse documentation
Agent-first documentation · 2026-11-14.1 · Updated 2026-11-14 View as Markdown

Use the Capability API and Assistant API

Create a scoped token in Agent Access. Send it in the Authorization bearer header over HTTPS. The Capability API accepts typed operation inputs. The Assistant API accepts conversational turns and retains their state.

Capability API

For a first read, send POST /api/v2/capabilities/status with {"version":"1.0","input":{"topic":"attention"}}. Use topic=setup to inspect the actual account permissions and settings links. The current connection's scope restricts each job. For a private write, send a caller-stable Idempotency-Key header. An identical retry recovers the receipt. A different intentional write needs a fresh key. OpenAPI schema

Return the summary, relevant facts, uncertainties and exact management link. Follow the returned cursor for additional pages. Use get with the detail arguments supplied by a result when more of a record is needed. Accepted processing has a separate readback. A failed or expired review requires the recovery step returned by Domino. Capability recipes

Assistant API

Send POST /api/v2/assistant/turns with message, a stable channel_identity for this conversation, and a new request_key for each intentional turn. An HTTP202 response means work is pending: poll the returned turn reference until it finishes. Keep the same request key when recovering a lost response. If the response requires a fresh conversation, repeat the intended new request with new_conversation=true; saved objects and completed receipts remain available. When this surface returns a prepared action, present the review, obtain approval and use POST /api/v2/assistant/prepared-actions/{action}/commit with the same channel identity and a new request key. The separate Capability API uses its confirm operation.

For an authentication error, resume in Agent Access. For an expired reference, reopen the current record. For partial calendar coverage or missing permission, return the exact setup link and explain what can already be answered.