Class AgentControllerApi

Atomically leases a conversation to one worker. A conflict means another unexpired worker owns it. Use expectedVersion to reject work selected from stale context. Acquire a renewable conversation claim

Atomically leases a conversation to one worker. A conflict means another unexpired worker owns it. Use expectedVersion to reject work selected from stale context. Acquire a renewable conversation claim

Adds agent/operator collaboration context without sending any email to the customer. Add an internal conversation note

Adds agent/operator collaboration context without sending any email to the customer. Add an internal conversation note

Add an internal SMS conversation note

Add an internal SMS conversation note

Evaluates effective inbox and account sending rules before an agent creates a send action. A blocked result includes the operator recovery route. Check whether sending rules allow recipients

Evaluates effective inbox and account sending rules before an agent creates a send action. A blocked result includes the operator recovery route. Check whether sending rules allow recipients

Acquire an SMS conversation claim

Acquire an SMS conversation claim

Revalidates conversation freshness, sends one threaded reply with an idempotency key, and releases the supplied claim only after the send succeeds. Complete a work item with an idempotent reply

Revalidates conversation freshness, sends one threaded reply with an idempotency key, and releases the supplied claim only after the send succeeds. Complete a work item with an idempotent reply

Creates a saved draft in the path inbox using the same SendEmailOptions shape as sending, without sending the email. Create a scoped email draft for an agent

Creates a saved draft in the path inbox using the same SendEmailOptions shape as sending, without sending the email. Create a scoped email draft for an agent

Creates an inbox without changing this agent connection's scopes. Account-wide scope is required so the new inbox is already covered. Create an inbox with an account-wide inbox-manager connection

Creates an inbox without changing this agent connection's scopes. Account-wide scope is required so the new inbox is already covered. Create an inbox with an account-wide inbox-manager connection

Builds the same recipients and RFC In-Reply-To/References headers as immediate reply, saves them as a draft, and preserves the required threading headers across later agent draft updates. Create a correctly threaded reply draft

Builds the same recipients and RFC In-Reply-To/References headers as immediate reply, saves them as a draft, and preserves the required threading headers across later agent draft updates. Create a correctly threaded reply draft

Create an agent-managed TOTP device from a base32 secret key

Create an agent-managed TOTP device from a base32 secret key

Create an agent-managed TOTP device from custom options

Create an agent-managed TOTP device from custom options

Create an agent-managed TOTP device from an OTP Auth URL

Create an agent-managed TOTP device from an OTP Auth URL

Creates or returns the active review handoff and releases the supplied claim after the handoff is durable. Deferral is a normal workflow result rather than an operational failure. Defer a work item to human review

Creates or returns the active review handoff and releases the supplied claim after the handoff is durable. Deferral is a normal workflow result rather than an operational failure. Defer a work item to human review

Deletes a saved draft without sending it. Delete a scoped email draft for an agent

Deletes a saved draft without sending it. Delete a scoped email draft for an agent

Delete an agent-managed TOTP device

Delete an agent-managed TOTP device

Extracts bounded text only after verifying both the email scope and that the attachment belongs to that email. List attachments first instead of guessing IDs. Extract text from a scoped email attachment for an agent

Extracts bounded text only after verifying both the email scope and that the attachment belongs to that email. List attachments first instead of guessing IDs. Extract text from a scoped email attachment for an agent

Generate a code for an agent-managed TOTP device

Generate a code for an agent-managed TOTP device

Returns the connection identity, role, effective permission names, declared resource scope, feature availability, and server-enforced limits. Call this once during worker startup instead of hard-coding role behavior. Discover this agent connection's capabilities

Returns the connection identity, role, effective permission names, declared resource scope, feature availability, and server-enforced limits. Call this once during worker startup instead of hard-coding role behavior. Discover this agent connection's capabilities

Returns the projected conversation plus this connection's bounded activity timeline, internal notes, and active human-review handoff. Get one scoped conversation

Returns the projected conversation plus this connection's bounded activity timeline, internal notes, and active human-review handoff. Get one scoped conversation

Returns parsed email content after resolving the message inbox and checking agent scope. Get scoped hydrated email for an agent

Returns a saved draft including the full SendEmailOptions payload. Get a scoped email draft for an agent

Returns a saved draft including the full SendEmailOptions payload. Get a scoped email draft for an agent

Returns parsed email content after resolving the message inbox and checking agent scope. Get scoped hydrated email for an agent

Returns lightweight metadata and headers for an email after resolving its inbox and checking the agent key scope. Get scoped email summary for an agent

Returns lightweight metadata and headers for an email after resolving its inbox and checking the agent key scope. Get scoped email summary for an agent

Returns thread metadata and ordered messages using an email ID as the authorization anchor. Arbitrary thread-ID probing is not allowed. Get a scoped email thread for an agent

Returns thread metadata and ordered messages using an email ID as the authorization anchor. Arbitrary thread-ID probing is not allowed. Get a scoped email thread for an agent

Waits for and returns the latest email in one scoped inbox. This is the agent-shaped equivalent of latest-message polling. Get latest scoped inbox email for an agent

Waits for and returns the latest email in one scoped inbox. This is the agent-shaped equivalent of latest-message polling. Get latest scoped inbox email for an agent

Selects the oldest available scoped conversation and atomically claims it for one worker. This combines queue selection and claim acquisition so concurrent workers do not need to coordinate those steps themselves. Claim the next conversation work item

Selects the oldest available scoped conversation and atomically claims it for one worker. This combines queue selection and claim acquisition so concurrent workers do not need to coordinate those steps themselves. Claim the next conversation work item

List SMS thread messages

List SMS thread messages

List SMS threads

List SMS threads

Get an assigned phone number

Get an assigned phone number

Returns only active phone numbers explicitly assigned to this agent connection. List assigned phone numbers

Returns only active phone numbers explicitly assigned to this agent connection. List assigned phone numbers

Get received SMS

Get received SMS

List received SMS for an assigned phone number

List received SMS for an assigned phone number

Get sent SMS

Get sent SMS

List sent SMS for an assigned phone number

List sent SMS for an assigned phone number

Get one SMS conversation

Get one SMS conversation

Get an agent-accessible TOTP device

Find an agent-accessible TOTP device by name, issuer, or username

Find an agent-accessible TOTP device by name, issuer, or username

Get an agent-accessible TOTP device

List agent-accessible TOTP devices

List agent-accessible TOTP devices

Returns the inbox IDs, addresses, names, and tags visible to this resource-scoped agent key. Agents should use this endpoint instead of guessing inbox IDs. List inboxes accessible to an agent

Returns the inbox IDs, addresses, names, and tags visible to this resource-scoped agent key. Agents should use this endpoint instead of guessing inbox IDs. List inboxes accessible to an agent

Returns an ordered at-least-once event batch. Persist nextCursor after processing and deduplicate by eventId. waitSeconds enables bounded long polling; production workers should not continuously call latest-email polling. Read durable scoped automation events

Returns an ordered at-least-once event batch. Persist nextCursor after processing and deduplicate by eventId. waitSeconds enables bounded long polling; production workers should not continuously call latest-email polling. Read durable scoped automation events

Reads the bounded mail-thread projection and applies current connection scope on every request. Persist nextCursor only after processing the returned page. Exact totals are intentionally omitted. List active conversations with an opaque keyset cursor

Reads the bounded mail-thread projection and applies current connection scope on every request. Persist nextCursor only after processing the returned page. Exact totals are intentionally omitted. List active conversations with an opaque keyset cursor

Returns bounded attachment metadata only after verifying the email belongs to an inbox visible to the agent key. List attachments on a scoped email for an agent

Returns bounded attachment metadata only after verifying the email belongs to an inbox visible to the agent key. List attachments on a scoped email for an agent

Lists draft previews for one scoped inbox. List scoped email drafts for an agent

Lists draft previews for one scoped inbox. List scoped email drafts for an agent

Returns paginated email previews for one inbox after checking the agent key has AGENT_READ_EMAIL and is scoped to the inbox. List scoped inbox emails for an agent

Returns paginated email previews for one inbox after checking the agent key has AGENT_READ_EMAIL and is scoped to the inbox. List scoped inbox emails for an agent

Lists conversation threads for one scoped inbox, including unread state, attachment presence, message count, and latest-message excerpts. List scoped inbox threads for an agent

Lists conversation threads for one scoped inbox, including unread state, attachment presence, message count, and latest-message excerpts. List scoped inbox threads for an agent

List active SMS conversations

List active SMS conversations

Checks that the selected conversation and latest inbound email are still current, then creates a correctly threaded reply draft. An optional internal note records context for human review without sending email. Prepare a guarded reply draft

Checks that the selected conversation and latest inbound email are still current, then creates a correctly threaded reply draft. An optional internal note records context for human review without sending email. Prepare a guarded reply draft

Release is idempotent; repeating it does not fail. Release a conversation claim

Release is idempotent; repeating it does not fail. Release a conversation claim

Release an SMS conversation claim

Release an SMS conversation claim

Renew a conversation claim

Renew a conversation claim

Renew an SMS conversation claim

Renew an SMS conversation claim

Sends a reply using the original conversation context after checking AGENT_REPLY_EMAIL and inbox scope. Reply to a scoped email as an agent

Sends a reply using the original conversation context after checking AGENT_REPLY_EMAIL and inbox scope. Reply to a scoped email as an agent

Reply to received SMS

Reply to received SMS

Records one running worker instance and its deployed release for owner-side health monitoring. Send this during startup and periodically while the process can accept work; it does not claim or mutate a conversation. Report a worker heartbeat

Records one running worker instance and its deployed release for owner-side health monitoring. Send this during startup and periodically while the process can accept work; it does not claim or mutate a conversation. Report a worker heartbeat

Creates or returns the active handoff and moves the shared workflow state into REVIEW without classifying the request as an operational failure. Request human review for a conversation

Creates or returns the active handoff and moves the shared workflow state into REVIEW without classifying the request as an operational failure. Request human review for a conversation

Request human review for an SMS conversation

Request human review for an SMS conversation

Searches one scoped inbox using explicit field matches and attachment conditions. Use this for deterministic automation recovery instead of repeatedly fetching the latest message. Search scoped inbox emails for an agent

Searches one scoped inbox using explicit field matches and attachment conditions. Use this for deterministic automation recovery instead of repeatedly fetching the latest message. Search scoped inbox emails for an agent

Sends a saved draft through the existing inbox send pipeline and deletes it only after send success. Send a scoped email draft for an agent

Sends a saved draft through the existing inbox send pipeline and deletes it only after send success. Send a scoped email draft for an agent

Send SMS from an assigned phone number

Send SMS from an assigned phone number

Replaces the SendEmailOptions stored for a draft. The draft remains attached to its original inbox. Update a scoped email draft for an agent

Replaces the SendEmailOptions stored for a draft. The draft remains attached to its original inbox. Update a scoped email draft for an agent

Update an inbox visible to an inbox-manager connection

Update an inbox visible to an inbox-manager connection

Update an agent-managed TOTP device

Update an agent-managed TOTP device