Scopes

A permission an API key may hold. transcripts:read, model_io:read, recordings:read and, from 1.57.0, tool_payloads:read read content, and every such read is audited; from 1.57.0 a Member puts one on a key only when its own visibility cell for the class is allowed.

Each operation needs one scope, and some include values need another; the operation pages name both.

Operations by scope

agents:read

• GET /v1/agents: List Agents
• GET /v1/agents/{agent_id}: Read an Agent draft
• GET /v1/agents/{agent_id}/decision-cases: List the cases of every decision corpus of an Agent
• GET /v1/agents/{agent_id}/decision-corpora: List the decision corpora of an Agent
• GET /v1/agents/{agent_id}/decision-corpora/{corpus_id}: Read a decision corpus
• GET /v1/agents/{agent_id}/decision-corpora/{corpus_id}/cases: List the cases of a decision corpus
• GET /v1/agents/{agent_id}/decision-corpora/{corpus_id}/cases/{case_id}: Read a case of a decision corpus
• GET /v1/agents/{agent_id}/decision-corpora/{corpus_id}/runs: List the runs of a decision corpus
• GET /v1/agents/{agent_id}/decision-corpora/{corpus_id}/runs/{run_id}: Read a run of a decision corpus
• GET /v1/agents/{agent_id}/experiments: List an Agent's experiments
• GET /v1/agents/{agent_id}/experiments/{experiment_id}: Read an experiment
• GET /v1/agents/{agent_id}/experiments/{experiment_id}/results: Read an experiment's results
• GET /v1/agents/{agent_id}/settings: Read every layer of the Agent draft's settings and the resolved block
• GET /v1/agents/{agent_id}/versions/{version}: Read one published Agent version
• GET /v1/agents/{agent_id}/versions/{version}/evaluation-gate: Read what an Agent version's activation would meet at the publish gate
• GET /v1/organization/agent-defaults: Read the Organization agent defaults
• GET /v1/platform/inventory: List the models and voices of the Provider inventory
• GET /v1/platform/prices: Read the price list
• GET /v1/providers: List the Provider descriptors

agents:write

• POST /v1/agents: Create an Agent draft
• PATCH /v1/agents/{agent_id}: Update the Agent draft
• GET /v1/agents/{agent_id}/capture-windows: List the capture windows of an Agent
• POST /v1/agents/{agent_id}/capture-windows: Open a verbose capture window on an Agent
• GET /v1/agents/{agent_id}/capture-windows/{capture_window_id}: Read a capture window with its reason
• POST /v1/agents/{agent_id}/capture-windows/{capture_window_id}/close: Close a capture window now
• POST /v1/agents/{agent_id}/decision-corpora: Create a decision corpus of a question set
• PATCH /v1/agents/{agent_id}/decision-corpora/{corpus_id}: Rename or describe a decision corpus
• DELETE /v1/agents/{agent_id}/decision-corpora/{corpus_id}: Archive a decision corpus
• POST /v1/agents/{agent_id}/decision-corpora/{corpus_id}/cases: Add a labeled case to a decision corpus
• DELETE /v1/agents/{agent_id}/decision-corpora/{corpus_id}/cases/{case_id}: Delete a case of a decision corpus
• POST /v1/agents/{agent_id}/decision-corpora/{corpus_id}/runs: Run a decision corpus against the pinned Provider
• POST /v1/agents/{agent_id}/experiments: Create an experiment on an Agent
• POST /v1/agents/{agent_id}/experiments/{experiment_id}/promote: Promote a candidate of an experiment
• POST /v1/agents/{agent_id}/experiments/{experiment_id}/start: Start an experiment
• POST /v1/agents/{agent_id}/experiments/{experiment_id}/stop: Stop an experiment
• POST /v1/agents/{agent_id}/publish-check: Check what publishing the Agent draft would answer
• POST /v1/agents/{agent_id}/versions: Publish the Agent draft as a new version
• POST /v1/agents/{agent_id}/versions/{version}/activate: Activate a published Agent version
• POST /v1/agents/{agent_id}/versions/{version}/machine/dry-run: Dry-run an Agent version's machine over scripted events
• PATCH /v1/organization/agent-defaults: Replace the Organization agent defaults

calls:read

• GET /v1/analytics/latency: Stage percentiles and ended reasons over the Calls of a window
• GET /v1/calls: List the Calls of the key's environment
• GET /v1/calls/{call_id}: Read a Call with its Turn metrics
• GET /v1/calls/{call_id}/analyses: List the analyses of a Call
• GET /v1/calls/{call_id}/analyses/{analysis_id}: Read one analysis of a Call
• GET /v1/calls/{call_id}/compare: Compare a Call with another Call or with its baseline
• GET /v1/calls/{call_id}/content-access: Read which content classes of a Call the caller may see
• GET /v1/calls/{call_id}/events: List the events of a Call
• GET /v1/calls/{call_id}/judgments: List a Call's judgments
• GET /v1/calls/{call_id}/outcomes: Read the Outcome of a Call
• GET /v1/calls/{call_id}/trace: Read the trace of a finalized Call
• GET /v1/calls/{call_id}/trace/otlp: Read the trace of a finalized Call as OTLP JSON

calls:write

• POST /v1/calls: Start a web Call or an outbound phone Call
• POST /v1/calls/{call_id}/analyses: Run analyzers again over a Call
• POST /v1/calls/{call_id}/answering-machine-label: Label what answered an outbound Call
• POST /v1/calls/{call_id}/control: Send a control command to the live Session of a Call
• POST /v1/calls/{call_id}/end: End a Call
• GET /v1/calls/{call_id}/stream: Open the events channel of a Call

transcripts:read

• GET /v1/calls/{call_id}/transcript: Read the transcript of a Call
• GET /v1/calls/{call_id}/transfers/{transfer_id}: Read one transfer of a Call with its context note

model_io:read

No public operation names this scope as the one it needs.

platform:read

• GET /v1/platform/credentials: List the platform credential versions, masked
• GET /v1/platform/flags: Read the platform flags
• GET /v1/platform/providers: Read the Provider registry
• GET /v1/platform/settings: Read the platform settings entries
• GET /v1/platform/vendor-prices: List the vendor price rows, current, upcoming and history
• GET /v1/platform/vendor-prices/gaps: Read the references without a vendor price in force

platform:write

• POST /v1/platform/credentials/{provider}: Add a member to a Provider's platform key pool
• PUT /v1/platform/credentials/{provider}: Enter or rotate the platform credential of a Provider
• DELETE /v1/platform/credentials/{provider}: Revoke the active platform credential of a Provider
• PATCH /v1/platform/credentials/{provider}/{key_id}: Enable, disable, cap or label one member of a platform key pool
• POST /v1/platform/credentials/{provider}/{key_id}/verify: Check one member of a platform key pool with the vendor
• PATCH /v1/platform/flags: Replace the platform flags
• POST /v1/platform/inventory/sync: Pull the Provider inventory from the vendors
• PATCH /v1/platform/providers: Replace the Provider registry
• PATCH /v1/platform/settings: Replace the platform settings entries
• POST /v1/platform/vendor-prices: Add one key's vendor price, now or from a later instant

members:read

• GET /v1/members: List the Members of the Organization
• GET /v1/members/sign-in-attempts: List the sign-ins refused for want of a Member
• GET /v1/members/{member_id}: Read a Member

members:write

• POST /v1/members: Invite a Member
• POST /v1/members/sign-in-attempts/approve: Approve a refused sign-in by creating its Member
• PATCH /v1/members/{member_id}: Change the role or status of a Member
• DELETE /v1/members/{member_id}: Remove a Member

recordings:read

• GET /v1/calls/{call_id}/recordings: List the recordings of a Call
• GET /v1/recordings/{recording_id}: Read a recording
• GET /v1/recordings/{recording_id}/audio: Stream the audio of a recording

api_keys:write

• POST /v1/api-keys: Create an API key
• POST /v1/api-keys/{key_id}/revoke: Revoke an API key

api_keys:read

• GET /v1/api-keys: List the API keys of the Organization
• GET /v1/api-keys/{key_id}: Read an API key

organization:read

• GET /v1/compliance-profile: Read the Organization's Compliance profile
• GET /v1/members/me: Read the signed-in Member
• GET /v1/organization: Read the caller's Organization

organization:write

• PATCH /v1/organization: Change the Organization's name or Call duration ceiling

telephony:read

• GET /v1/phone-numbers: List the Phone numbers of the Organization
• GET /v1/phone-numbers/{phone_number_id}: Read a Phone number and its routing

telephony:write

• PATCH /v1/phone-numbers/{phone_number_id}: Route a Phone number to an Agent

usage:read

• GET /v1/analytics/cost: The estimated cost of the Calls of a window
• GET /v1/analytics/forecast: Forecast the month's usage against the spend cap
• GET /v1/analytics/usage-rates: Measured usage per minute of Call, for a cost estimate before a Call
• POST /v1/analytics/what-if: Estimate a Provider swap over measured usage
• GET /v1/calls/{call_id}/usage: Read the Usage events of a Call and their rated total
• GET /v1/usage/evaluation-quota: Read the Organization's evaluation quota
• GET /v1/usage/events: List the Usage events of the Organization
• GET /v1/usage/spend: Read the Organization's spend this month against its spend cap

credentials:read

• GET /v1/provider-credentials: List the Organization's Provider credentials, masked

credentials:write

• PUT /v1/provider-credentials/{provider}: Enter or rotate the Organization's credential for a Provider
• DELETE /v1/provider-credentials/{provider}: Revoke the Organization's credential for a Provider
• POST /v1/provider-credentials/{provider}/verify: Check the Organization's credential for a Provider with the vendor

compliance:write

• PATCH /v1/compliance-profile: Change the Organization's Compliance profile

policies:read

• GET /v1/policies: List Policies
• GET /v1/policies/{policy_id}: Read a Policy draft
• GET /v1/policies/{policy_id}/versions: List a Policy's versions
• GET /v1/policies/{policy_id}/versions/{version}: Read a Policy version

policies:write

• POST /v1/agents/{agent_id}/versions/{version}/evaluate-policies: Dry-run the Policies of an Agent version at one hook
• POST /v1/policies: Create a Policy draft
• PATCH /v1/policies/{policy_id}: Update the Policy draft
• DELETE /v1/policies/{policy_id}: Archive a Policy
• POST /v1/policies/{policy_id}/evaluate: Dry-run a Policy against a synthetic context
• POST /v1/policies/{policy_id}/versions: Publish the Policy draft as a new version
• POST /v1/policies/{policy_id}/versions/{version}/activate: Activate a Policy version

policies:admin

No public operation names this scope as the one it needs.

tools:read

• GET /v1/tool-signing-secret: Read the state of the Organization's tool signing secret
• GET /v1/tools: List Tools
• GET /v1/tools/{tool_id}: Read a Tool

tools:write

• POST /v1/tool-signing-secret/rotate: Rotate the Organization's tool signing secret
• POST /v1/tools: Create a Tool
• PATCH /v1/tools/{tool_id}: Update a Tool
• DELETE /v1/tools/{tool_id}: Archive a Tool
• POST /v1/tools/{tool_id}/test: Send one real request of an http Tool

webhooks:read

• GET /v1/event-filters: List event filters
• GET /v1/event-filters/{filter_id}: Read an event filter
• GET /v1/event-types: List the event catalog
• GET /v1/webhooks: List Webhook subscriptions
• GET /v1/webhooks/{webhook_id}: Read a Webhook subscription
• GET /v1/webhooks/{webhook_id}/deliveries: List a Webhook subscription's deliveries

events:read

• GET /v1/events: List the event log
• GET /v1/events/stream: Stream the Organization events
• GET /v1/events/{event_id}: Read an event

webhooks:write

• POST /v1/event-filters: Create an event filter
• PATCH /v1/event-filters/{filter_id}: Update an event filter
• DELETE /v1/event-filters/{filter_id}: Delete an event filter
• POST /v1/webhooks: Create a Webhook subscription
• PATCH /v1/webhooks/{webhook_id}: Update a Webhook subscription
• DELETE /v1/webhooks/{webhook_id}: Delete a Webhook subscription
• POST /v1/webhooks/{webhook_id}/enable: Enable a disabled Webhook subscription
• POST /v1/webhooks/{webhook_id}/replay: Replay the events of a time window to a Webhook subscription
• POST /v1/webhooks/{webhook_id}/rotate-secret: Rotate a Webhook subscription's secret
• POST /v1/webhooks/{webhook_id}/test: Send a test event to a Webhook subscription

jobs:read

• GET /v1/jobs: List jobs
• GET /v1/jobs/{job_id}: Read a job
• POST /v1/jobs/{job_id}/result-url: Issue a URL of a job's result file

jobs:write

• POST /v1/jobs/{job_id}/cancel: Cancel a job

hooks:read

• GET /v1/pre-call-hooks: List pre-call hooks
• GET /v1/pre-call-hooks/{hook_id}: Read a pre-call hook

hooks:write

• POST /v1/pre-call-hooks: Create a pre-call hook
• PATCH /v1/pre-call-hooks/{hook_id}: Update a pre-call hook
• DELETE /v1/pre-call-hooks/{hook_id}: Delete a pre-call hook
• POST /v1/pre-call-hooks/{hook_id}/attest-phi: Attest a pre-call hook for PHI
• POST /v1/pre-call-hooks/{hook_id}/rotate-secret: Rotate the secret of a pre-call hook
• POST /v1/pre-call-hooks/{hook_id}/test: Send a synthetic request to a pre-call hook

knowledge:read

• GET /v1/knowledge-bases: List Knowledge bases
• GET /v1/knowledge-bases/{knowledge_base_id}: Read a Knowledge base
• GET /v1/knowledge-bases/{knowledge_base_id}/documents: List a Knowledge base's Documents
• GET /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}: Read a Document
• GET /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}/content: Read a Document's content
• GET /v1/knowledge-bases/{knowledge_base_id}/eval-queries: List a Knowledge base's corpus
• GET /v1/knowledge-bases/{knowledge_base_id}/eval-queries/{eval_query_id}: Read a corpus query
• GET /v1/knowledge-bases/{knowledge_base_id}/evaluations/{evaluation_id}: Read an Evaluation
• GET /v1/knowledge-bases/{knowledge_base_id}/ingestion-runs: List a Knowledge base's Ingestion runs
• GET /v1/knowledge-bases/{knowledge_base_id}/ingestion-runs/{run_id}: Read an Ingestion run
• POST /v1/knowledge-bases/{knowledge_base_id}/query: Query a Knowledge base
• GET /v1/knowledge-bases/{knowledge_base_id}/sources: List a Knowledge base's Sources
• GET /v1/knowledge-bases/{knowledge_base_id}/sources/{source_id}: Read a Source
• GET /v1/knowledge-bases/{knowledge_base_id}/versions: List a Knowledge base's versions
• GET /v1/knowledge-bases/{knowledge_base_id}/versions/{version}: Read a Knowledge base version

knowledge:write

• POST /v1/knowledge-bases: Create a Knowledge base
• PATCH /v1/knowledge-bases/{knowledge_base_id}: Update the Knowledge base draft
• DELETE /v1/knowledge-bases/{knowledge_base_id}: Archive a Knowledge base
• POST /v1/knowledge-bases/{knowledge_base_id}/documents: Upload a Document
• DELETE /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}: Delete a Document
• POST /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}/purge: Purge a Document from every version
• POST /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}/review: Review a quarantined Document
• POST /v1/knowledge-bases/{knowledge_base_id}/eval-queries: Add a query to the retrieval-quality corpus
• PATCH /v1/knowledge-bases/{knowledge_base_id}/eval-queries/{eval_query_id}: Update a corpus query
• DELETE /v1/knowledge-bases/{knowledge_base_id}/eval-queries/{eval_query_id}: Delete a corpus query
• POST /v1/knowledge-bases/{knowledge_base_id}/evaluations: Evaluate a version or the working set
• POST /v1/knowledge-bases/{knowledge_base_id}/sources: Add a Source to a Knowledge base
• PATCH /v1/knowledge-bases/{knowledge_base_id}/sources/{source_id}: Update a Source
• DELETE /v1/knowledge-bases/{knowledge_base_id}/sources/{source_id}: Delete a Source
• POST /v1/knowledge-bases/{knowledge_base_id}/sources/{source_id}/sync: Sync a Source now
• POST /v1/knowledge-bases/{knowledge_base_id}/versions: Publish the working set as a new version
• POST /v1/knowledge-bases/{knowledge_base_id}/versions/{version}/activate: Activate a Knowledge base version
• POST /v1/knowledge-bases/{knowledge_base_id}/versions/{version}/retire: Retire a Knowledge base version

prompts:read

• POST /v1/agents/{agent_id}/versions/{version}/render: Dry-run the composed request of an Agent version
• GET /v1/agents/{agent_id}/versions/{version}/tests: List an Agent version's conversation test runs
• GET /v1/agents/{agent_id}/versions/{version}/tests/{run_id}: Read a conversation test run
• GET /v1/prompt-bases: List the platform bases
• GET /v1/prompt-bases/{version}: Read a platform base
• GET /v1/prompt-eval-suites: List evaluation suites
• GET /v1/prompt-eval-suites/{prompt_eval_suite_id}: Read an evaluation suite
• GET /v1/prompt-eval-suites/{prompt_eval_suite_id}/calibrations: List a suite's calibrations
• GET /v1/prompt-eval-suites/{prompt_eval_suite_id}/calibrations/{calibration_id}: Read a calibration
• GET /v1/prompt-eval-suites/{prompt_eval_suite_id}/labels: List a suite's labels
• GET /v1/prompt-eval-suites/{prompt_eval_suite_id}/labels/{label_id}: Read a label
• GET /v1/prompt-eval-suites/{prompt_eval_suite_id}/runs: List a suite's runs
• GET /v1/prompt-eval-suites/{prompt_eval_suite_id}/runs/{run_id}: Read an evaluation run
• GET /v1/prompt-eval-suites/{prompt_eval_suite_id}/runs/{run_id}/calls/{call_id}: Read an evaluation Call of a run
• GET /v1/prompt-eval-suites/{prompt_eval_suite_id}/runs/{run_id}/verdicts: List a run's verdicts
• GET /v1/prompt-eval-suites/{prompt_eval_suite_id}/scenarios: List a suite's scenarios
• GET /v1/prompt-eval-suites/{prompt_eval_suite_id}/scenarios/{scenario_id}: Read a scenario
• GET /v1/prompt-library: List the template library
• GET /v1/prompt-library/{slug}: Read a library template
• GET /v1/prompt-templates: List Prompt templates
• GET /v1/prompt-templates/{prompt_template_id}: Read a Prompt template
• GET /v1/prompt-templates/{prompt_template_id}/diff: Compare two versions of a Prompt template, or a version and the draft
• GET /v1/prompt-templates/{prompt_template_id}/pins: List the Agent versions that use a Prompt template
• POST /v1/prompt-templates/{prompt_template_id}/render: Dry-run render a Prompt template
• GET /v1/prompt-templates/{prompt_template_id}/versions: List a Prompt template's versions
• GET /v1/prompt-templates/{prompt_template_id}/versions/{version}: Read a Prompt template version

prompts:write

• POST /v1/agents/{agent_id}/versions/{version}/tests: Run conversation tests against an Agent version
• POST /v1/prompt-eval-suites: Create an evaluation suite
• PATCH /v1/prompt-eval-suites/{prompt_eval_suite_id}: Update an evaluation suite
• DELETE /v1/prompt-eval-suites/{prompt_eval_suite_id}: Archive an evaluation suite
• POST /v1/prompt-eval-suites/{prompt_eval_suite_id}/calibrations: Calibrate a suite's judge
• POST /v1/prompt-eval-suites/{prompt_eval_suite_id}/labels: Label a sampled verdict
• POST /v1/prompt-eval-suites/{prompt_eval_suite_id}/runs: Run an evaluation suite
• POST /v1/prompt-eval-suites/{prompt_eval_suite_id}/scenarios: Add a scenario to an evaluation suite
• PATCH /v1/prompt-eval-suites/{prompt_eval_suite_id}/scenarios/{scenario_id}: Update a scenario
• DELETE /v1/prompt-eval-suites/{prompt_eval_suite_id}/scenarios/{scenario_id}: Delete a scenario
• POST /v1/prompt-templates: Create a Prompt template
• PATCH /v1/prompt-templates/{prompt_template_id}: Update the Prompt template draft
• DELETE /v1/prompt-templates/{prompt_template_id}: Archive a Prompt template
• POST /v1/prompt-templates/{prompt_template_id}/versions: Publish the Prompt template draft as a new version
• POST /v1/prompt-templates/{prompt_template_id}/versions/{version}/activate: Activate a Prompt template version

prompts:admin

No public operation names this scope as the one it needs.

tool_payloads:read

No public operation names this scope as the one it needs.

analytics:read

• GET /v1/analytics/alert-settings: Read the analytics alert settings
• GET /v1/analytics/alerts: List the built-in analytics alerts
• GET /v1/analytics/calls: Calls, minutes, ended reasons, Outcomes and transfers over a window

analytics:write

• PATCH /v1/analytics/alert-settings: Change the analytics alert settings

reveal_grants:read

• GET /v1/reveal-grants: List reveal grants
• GET /v1/reveal-grants/{reveal_grant_id}: Read a reveal grant with its reason

reveal_grants:write

• POST /v1/reveal-grants: Request a reveal grant
• POST /v1/reveal-grants/{reveal_grant_id}/approve: Approve a pending reveal grant
• POST /v1/reveal-grants/{reveal_grant_id}/decline: Decline a pending reveal grant
• POST /v1/reveal-grants/{reveal_grant_id}/revoke: Revoke a reveal grant

workflows:read

• GET /v1/workflows: List Workflows
• GET /v1/workflows/{workflow_id}: Read a Workflow draft
• GET /v1/workflows/{workflow_id}/versions: List a Workflow's versions
• GET /v1/workflows/{workflow_id}/versions/{version}: Read a Workflow version

workflows:write

• POST /v1/workflows: Create a Workflow draft
• PATCH /v1/workflows/{workflow_id}: Update the Workflow draft
• DELETE /v1/workflows/{workflow_id}: Archive a Workflow
• POST /v1/workflows/{workflow_id}/test: Test a Workflow over scripted events
• POST /v1/workflows/{workflow_id}/versions: Publish the Workflow draft as a new version
• POST /v1/workflows/{workflow_id}/versions/{version}/activate: Activate a Workflow version
• POST /v1/workflows/{workflow_id}/versions/{version}/nodes/{node_id}/evaluate: Dry-run one node of a Workflow version

integrations:read

• GET /v1/connections: List Connections
• GET /v1/connections/{connection_id}: Read a Connection
• GET /v1/connectors: List the Connector catalog
• GET /v1/connectors/{connector_id}: Read a Connector
• GET /v1/runs: List Runs
• GET /v1/runs/{run_id}: Read a Run
• GET /v1/tool-bindings: List Tool bindings
• GET /v1/tool-bindings/{tool_binding_id}: Read a Tool binding
• GET /v1/trigger-events: List Trigger events
• GET /v1/trigger-events/{trigger_event_id}: Read a Trigger event
• GET /v1/trigger-subscriptions: List Trigger subscriptions
• GET /v1/trigger-subscriptions/{subscription_id}: Read a Trigger subscription

integrations:write

• POST /v1/connections: Create a Connection
• PATCH /v1/connections/{connection_id}: Update a Connection
• DELETE /v1/connections/{connection_id}: Revoke a Connection
• POST /v1/connections/{connection_id}/attest-phi: Attest a Connection for PHI
• POST /v1/connections/{connection_id}/authorize: Start the authorization of a Connection
• PUT /v1/connections/{connection_id}/credentials: Enter a secret of a Connection
• POST /v1/tool-bindings: Bind tools of a Connection to an Agent
• PATCH /v1/tool-bindings/{tool_binding_id}: Update a Tool binding
• DELETE /v1/tool-bindings/{tool_binding_id}: Delete a Tool binding
• POST /v1/trigger-events/{trigger_event_id}/replay: Replay a Trigger event's action
• POST /v1/trigger-subscriptions: Subscribe to a Trigger of a Connection
• PATCH /v1/trigger-subscriptions/{subscription_id}: Update a Trigger subscription
• DELETE /v1/trigger-subscriptions/{subscription_id}: Delete a Trigger subscription
• POST /v1/trigger-subscriptions/{subscription_id}/rotate-token: Rotate a Trigger subscription's token

mcp:read

• GET /v1/mcp-servers: List MCP server registrations
• GET /v1/mcp-servers/{mcp_server_id}: Read an MCP server registration
• GET /v1/mcp-servers/{mcp_server_id}/tools: List an MCP server's tools with their drift

mcp:write

• POST /v1/mcp-servers: Register an MCP server
• PATCH /v1/mcp-servers/{mcp_server_id}: Update an MCP server registration
• DELETE /v1/mcp-servers/{mcp_server_id}: Delete an MCP server registration
• POST /v1/mcp-servers/{mcp_server_id}/refresh: List an MCP server's tools now
• POST /v1/mcp-servers/{mcp_server_id}/tools/{tool_name}/accept: Accept an MCP tool's new definition

messages:read

• GET /v1/messages: List Messages
• GET /v1/messages/{message_id}: Read a Message with its content
• GET /v1/notification-rules: List notification rules
• GET /v1/notification-rules/{notification_rule_id}: Read a notification rule

messages:write

• POST /v1/messages: Send a message
• POST /v1/notification-rules: Create a notification rule
• PATCH /v1/notification-rules/{notification_rule_id}: Update a notification rule
• DELETE /v1/notification-rules/{notification_rule_id}: Delete a notification rule

contacts:read

• GET /v1/consent-records/{consent_record_id}: Read a consent record
• POST /v1/consent/check: Check whether an address may be contacted
• GET /v1/contacts: List Contacts
• GET /v1/contacts/imports: List imports
• GET /v1/contacts/imports/{import_id}: Read an import
• POST /v1/contacts/lookup: Find Contacts by an identity or an external id
• GET /v1/contacts/{contact_id}: Read a Contact
• GET /v1/contacts/{contact_id}/consent: List a Contact's consent states

contacts:content

No public operation names this scope as the one it needs.

contacts:write

• POST /v1/contacts: Create a Contact
• POST /v1/contacts/imports: Import Contacts
• POST /v1/contacts/upsert: Create or update Contacts in a batch
• PATCH /v1/contacts/{contact_id}: Update a Contact
• DELETE /v1/contacts/{contact_id}: Delete a Contact
• POST /v1/contacts/{contact_id}/merge: Merge a Contact into another
• POST /v1/contacts/{contact_id}/purge: Purge a Contact's data

consent:write

• POST /v1/consent-records: Record a consent event
• POST /v1/consent-records/imports: Import a suppression list

processes:read

• GET /v1/human-tasks: List human tasks
• GET /v1/human-tasks/{human_task_id}: Read a human task
• GET /v1/processes: List Process instances
• GET /v1/processes/{process_id}: Read a Process instance
• GET /v1/processes/{process_id}/steps: List a Process instance's steps

processes:content

No public operation names this scope as the one it needs.

processes:write

• POST /v1/human-tasks/{human_task_id}/claim: Claim a human task
• POST /v1/human-tasks/{human_task_id}/complete: Complete a human task
• POST /v1/processes: Start a Process instance
• POST /v1/processes/{process_id}/cancel: Cancel a Process instance
• POST /v1/processes/{process_id}/events: Deliver an event to a Process instance

events:write

• POST /v1/events: Emit a customer event
• POST /v1/process-events: Deliver a customer event to a Process

campaigns:read

• GET /v1/campaigns: List Campaigns
• GET /v1/campaigns/{campaign_id}: Read a Campaign
• GET /v1/campaigns/{campaign_id}/contacts: List a Campaign's enrollments
• GET /v1/campaigns/{campaign_id}/contacts/{enrollment_id}: Read an enrollment
• POST /v1/campaigns/{campaign_id}/exports: Export a Campaign's enrollments
• GET /v1/campaigns/{campaign_id}/numbers: List a Campaign's numbers
• GET /v1/campaigns/{campaign_id}/progress: Read a Campaign's progress
• GET /v1/campaigns/{campaign_id}/revisions: List a Campaign's revisions

campaigns:content

No public operation names this scope as the one it needs.

campaigns:write

• POST /v1/campaigns: Create a Campaign
• PATCH /v1/campaigns/{campaign_id}: Update a Campaign draft
• DELETE /v1/campaigns/{campaign_id}: Delete or archive a Campaign
• POST /v1/campaigns/{campaign_id}/attestation: Record the attestation of a Campaign
• POST /v1/campaigns/{campaign_id}/cancel: Cancel a Campaign
• POST /v1/campaigns/{campaign_id}/contacts: Enroll Contacts in a Campaign
• POST /v1/campaigns/{campaign_id}/contacts/{enrollment_id}/remove: Remove an enrollment
• POST /v1/campaigns/{campaign_id}/dry-run: Dry-run a Campaign
• POST /v1/campaigns/{campaign_id}/pause: Pause a Campaign
• POST /v1/campaigns/{campaign_id}/resume: Resume a Campaign
• POST /v1/campaigns/{campaign_id}/revisions: Publish a revision of a Campaign

campaigns:launch

• POST /v1/campaigns/{campaign_id}/launch: Launch a Campaign