Reference
Generated Atlas contract registry
This page renders from the generated contract registry. Developer Console and public Atlas endpoints share one source of truth, so the reference stays aligned with the runtime.
/operator/developers/overviewimplementeddeveloper_consoleRead Developer Console counts and granted permissions
Returns the owner-scoped Developer Console summary for the current Mirai organization.
Required permissions
- developer_console.read
Required scopes
- none
/operator/developers/appsimplementeddeveloper_consoleList org-owned Atlas apps
Lists Atlas apps and registered redirect URIs for the active workspace.
Required permissions
- atlas_api.apps.read
Required scopes
- none
/operator/developers/appsimplementeddeveloper_consoleCreate an org-owned Atlas app
Creates a Developer Console app asset owned by the current organization.
Required permissions
- atlas_api.apps.write
Required scopes
- none
/operator/developers/apps/{appId}/redirect-urisimplementeddeveloper_consoleRegister an OAuth redirect URI
Adds a redirect URI to an existing org-owned Atlas app.
Required permissions
- atlas_api.oauth.manage
Required scopes
- none
/operator/developers/apps/{appId}/grantsimplementeddeveloper_consoleMint an app access grant
Creates an org-owned app bearer token for Atlas API access and returns the plaintext secret once.
Required permissions
- atlas_api.oauth.manage
Required scopes
- none
/operator/developers/service-accountsimplementeddeveloper_consoleList service accounts and key metadata
Lists org-owned service accounts together with key prefixes and granted scope metadata.
Required permissions
- atlas_api.service_accounts.manage
Required scopes
- none
/operator/developers/service-accountsimplementeddeveloper_consoleCreate a service account
Creates an org-owned machine principal for Atlas API access.
Required permissions
- atlas_api.service_accounts.manage
Required scopes
- none
/operator/developers/service-accounts/{serviceAccountId}/keysimplementeddeveloper_consoleMint a service-account key
Creates a new scoped key and returns the plaintext secret exactly once.
Required permissions
- atlas_api.keys.manage
Required scopes
- none
/operator/developers/webhooksimplementeddeveloper_consoleList webhook endpoints
Lists outbound webhook endpoints and subscribed event families.
Required permissions
- atlas_api.webhooks.manage
Required scopes
- none
/operator/developers/webhooksimplementeddeveloper_consoleCreate a webhook endpoint
Registers an outbound webhook endpoint and returns the signing secret once.
Required permissions
- atlas_api.webhooks.manage
Required scopes
- none
/operator/developers/audit-eventsimplementeddeveloper_consoleList recent audit events
Returns the most recent Atlas developer asset lifecycle events for the org.
Required permissions
- atlas_api.audit.read
Required scopes
- none
/v1/atlas/channelsimplementedpublic_apiList connected Atlas channels
Returns connected business channels and health metadata for the active Atlas principal organization.
Required permissions
- none
Required scopes
- atlas.channels.read
/v1/atlas/knowledgeimplementedpublic_apiList Atlas Knowledge documents
Lists knowledge documents available to the active Atlas principal for shared RAG grounding.
Required permissions
- none
Required scopes
- atlas.knowledge.read
/v1/atlas/knowledgeimplementedpublic_apiCreate Atlas Knowledge content
Creates a knowledge document through the canonical queued ingest path so status remains truthful until worker indexing completes.
Required permissions
- none
Required scopes
- atlas.knowledge.write
/v1/atlas/agentsimplementedpublic_apiList Atlas agents
Lists Atlas-hosted and external-agent records for the active organization.
Required permissions
- none
Required scopes
- atlas.agents.read
/v1/atlas/agentsimplementedpublic_apiCreate an Atlas agent
Creates an agent and optionally links existing knowledge sources.
Required permissions
- none
Required scopes
- atlas.agents.write
/v1/atlas/sessionsimplementedpublic_apiList test sessions
Lists Atlas preview sessions for sandbox evaluation.
Required permissions
- none
Required scopes
- atlas.sessions.read
/v1/atlas/sessionsimplementedpublic_apiCreate a test session
Creates a sandbox Atlas session tied to an optional agent.
Required permissions
- none
Required scopes
- atlas.sessions.write
/v1/atlas/sessions/{sessionId}/messagesimplementedpublic_apiList session messages
Returns the preview message transcript for a sandbox session.
Required permissions
- none
Required scopes
- atlas.sessions.read
/v1/atlas/sessions/{sessionId}/messagesimplementedpublic_apiQuery a sandbox session
Adds a user message, runs keyword-backed Atlas Knowledge search, and returns a grounded preview reply.
Required permissions
- none
Required scopes
- atlas.sessions.write
/v1/atlas/conversationsimplementedpublic_apiList live conversations
Returns normalized omnichannel conversation summaries for the active organization.
Required permissions
- none
Required scopes
- atlas.conversations.read
/v1/atlas/eventsimplementedpublic_apiReceive inbound external-agent events
Accepts normalized inbound channel events, creates or updates the Mirai conversation, and emits signed outbound Atlas webhooks.
Required permissions
- none
Required scopes
- atlas.events.write
/v1/atlas/context/{conversationId}implementedpublic_apiFetch customer, conversation, and knowledge context
Returns normalized conversation state, customer profile, recent messages, and grounded Atlas Knowledge search results.
Required permissions
- none
Required scopes
- atlas.context.read
/v1/atlas/actionsimplementedpublic_apiSubmit an external-agent reply or action
Accepts replies, drafts, and handoff decisions, then routes reply delivery through Mirai-managed channels.
Required permissions
- none
Required scopes
- atlas.actions.execute
/v1/atlas/runsimplementedpublic_apiList Atlas runtime runs
Lists event and action runs recorded through the public Atlas API surface.
Required permissions
- none
Required scopes
- atlas.runs.read
/v1/atlas/webhooksimplementedpublic_apiList outbound Atlas webhook subscriptions
Lists webhook endpoints owned by the active app or service account principal.
Required permissions
- none
Required scopes
- atlas.events.read
/v1/atlas/webhooksimplementedpublic_apiRegister outbound Atlas event delivery
Registers a signed outbound webhook endpoint for the active app or service account principal.
Required permissions
- none
Required scopes
- atlas.events.read