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.

GET/operator/developers/overviewimplementeddeveloper_console

Read 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
GET/operator/developers/appsimplementeddeveloper_console

List org-owned Atlas apps

Lists Atlas apps and registered redirect URIs for the active workspace.

Required permissions

  • atlas_api.apps.read

Required scopes

  • none
POST/operator/developers/appsimplementeddeveloper_console

Create 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
POST/operator/developers/apps/{appId}/redirect-urisimplementeddeveloper_console

Register an OAuth redirect URI

Adds a redirect URI to an existing org-owned Atlas app.

Required permissions

  • atlas_api.oauth.manage

Required scopes

  • none
POST/operator/developers/apps/{appId}/grantsimplementeddeveloper_console

Mint 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
GET/operator/developers/service-accountsimplementeddeveloper_console

List 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
POST/operator/developers/service-accountsimplementeddeveloper_console

Create a service account

Creates an org-owned machine principal for Atlas API access.

Required permissions

  • atlas_api.service_accounts.manage

Required scopes

  • none
POST/operator/developers/service-accounts/{serviceAccountId}/keysimplementeddeveloper_console

Mint 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
GET/operator/developers/webhooksimplementeddeveloper_console

List webhook endpoints

Lists outbound webhook endpoints and subscribed event families.

Required permissions

  • atlas_api.webhooks.manage

Required scopes

  • none
POST/operator/developers/webhooksimplementeddeveloper_console

Create a webhook endpoint

Registers an outbound webhook endpoint and returns the signing secret once.

Required permissions

  • atlas_api.webhooks.manage

Required scopes

  • none
GET/operator/developers/audit-eventsimplementeddeveloper_console

List recent audit events

Returns the most recent Atlas developer asset lifecycle events for the org.

Required permissions

  • atlas_api.audit.read

Required scopes

  • none
GET/v1/atlas/channelsimplementedpublic_api

List connected Atlas channels

Returns connected business channels and health metadata for the active Atlas principal organization.

Required permissions

  • none

Required scopes

  • atlas.channels.read
GET/v1/atlas/knowledgeimplementedpublic_api

List Atlas Knowledge documents

Lists knowledge documents available to the active Atlas principal for shared RAG grounding.

Required permissions

  • none

Required scopes

  • atlas.knowledge.read
POST/v1/atlas/knowledgeimplementedpublic_api

Create 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
GET/v1/atlas/agentsimplementedpublic_api

List Atlas agents

Lists Atlas-hosted and external-agent records for the active organization.

Required permissions

  • none

Required scopes

  • atlas.agents.read
POST/v1/atlas/agentsimplementedpublic_api

Create an Atlas agent

Creates an agent and optionally links existing knowledge sources.

Required permissions

  • none

Required scopes

  • atlas.agents.write
POST/v1/atlas/agents/:agentId/publishimplementedpublic_api

Publish an Atlas agent to the public directory

Updates listing metadata for an agent. Set is_listed to true to publish. Only the organization that owns the agent can update its listing.

Required permissions

  • none

Required scopes

  • atlas.agents.publish
GET/v1/atlas/agents/directoryimplementedpublic_api

List published agents in the Atlas directory

Returns all published agents from all organizations. No authentication required. Optionally filter by category.

Required permissions

  • none

Required scopes

  • none
GET/v1/atlas/sessionsimplementedpublic_api

List test sessions

Lists Atlas preview sessions for sandbox evaluation.

Required permissions

  • none

Required scopes

  • atlas.sessions.read
POST/v1/atlas/sessionsimplementedpublic_api

Create a test session

Creates a sandbox Atlas session tied to an optional agent.

Required permissions

  • none

Required scopes

  • atlas.sessions.write
GET/v1/atlas/sessions/{sessionId}/messagesimplementedpublic_api

List session messages

Returns the preview message transcript for a sandbox session.

Required permissions

  • none

Required scopes

  • atlas.sessions.read
POST/v1/atlas/sessions/{sessionId}/messagesimplementedpublic_api

Query 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
GET/v1/atlas/conversationsimplementedpublic_api

List live conversations

Returns normalized omnichannel conversation summaries for the active organization.

Required permissions

  • none

Required scopes

  • atlas.conversations.read
POST/v1/atlas/eventsimplementedpublic_api

Receive 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
GET/v1/atlas/context/{conversationId}implementedpublic_api

Fetch 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
POST/v1/atlas/actionsimplementedpublic_api

Submit 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
POST/v1/atlas/messagesimplementedpublic_api

Send a WhatsApp message to a phone number

Sends an outbound WhatsApp message, creating or reusing the customer and conversation for the active organization.

Required permissions

  • none

Required scopes

  • atlas.messages.send
GET/v1/atlas/runsimplementedpublic_api

List Atlas runtime runs

Lists event and action runs recorded through the public Atlas API surface.

Required permissions

  • none

Required scopes

  • atlas.runs.read
GET/v1/atlas/webhooksimplementedpublic_api

List outbound Atlas webhook subscriptions

Lists webhook endpoints owned by the active app or service account principal.

Required permissions

  • none

Required scopes

  • atlas.events.read
POST/v1/atlas/webhooksimplementedpublic_api

Register 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
GET/v1/atlas/tools/manifestimplementedpublic_api

Discover available Atlas tools

Returns tool definitions filtered by the caller's granted scopes. Use this to understand which tools the authenticated principal can call.

Required permissions

  • none

Required scopes

  • atlas.tools.manifest
GET/atlas/v1/docsimplementedpublic_api

Read machine-readable Atlas agent docs

Returns public machine-readable Atlas agent documentation, route families, error guidance, and flagship flow notes before authentication.

Required permissions

  • none

Required scopes

  • none
GET/atlas/v1/tools/manifestimplementedpublic_api

Discover Atlas agent tools

Returns agent tool definitions filtered by the caller's granted scopes. This is the canonical Atlas agent-tool manifest route for new integrations.

Required permissions

  • none

Required scopes

  • atlas.actions.execute
POST/atlas/v1/tools/send_messageimplementedpublic_api

Send a message in an existing conversation

Executes the canonical Atlas tool route for replying in an existing conversation through the execution gateway.

Required permissions

  • none

Required scopes

  • atlas.actions.execute
POST/atlas/v1/tools/send_message_to_phoneimplementedpublic_api

Send a message to a phone number

Executes the canonical Atlas tool route for sending to an E.164 phone number while creating or reusing the customer and conversation for the authenticated organization.

Required permissions

  • none

Required scopes

  • atlas.actions.execute
GET/atlas/v1/tools/messages/{providerMessageId}/statusimplementedpublic_api

Read Atlas message delivery status

Polls provider delivery status for a sent message. Webhooks remain the preferred real-time path.

Required permissions

  • none

Required scopes

  • atlas.actions.execute
GET/atlas/v1/knowledge/searchimplementedpublic_api

Search Atlas knowledge

Searches org-owned Atlas Knowledge for grounded answers and citations through the canonical agent runtime route.

Required permissions

  • none

Required scopes

  • atlas.knowledge.read
POST/atlas/v1/mcpimplementedpublic_api

Call Atlas MCP over streamable HTTP

Handles JSON-RPC MCP initialize, tools/list, and tools/call requests over the canonical Atlas MCP transport.

Required permissions

  • none

Required scopes

  • atlas.actions.execute
GET/atlas/v1/pricingimplementedpublic_api

Read public Atlas pricing catalogue

Returns the public agent-readable pricing catalogue, operation policy metadata, effective date, and pricing version.

Required permissions

  • none

Required scopes

  • none
POST/atlas/v1/billing/upgradeimplementedpublic_api

Start Atlas developer billing checkout

Starts a Stripe checkout session for the authenticated developer organization. Public billing claims remain staged until reconciliation evidence promotes them.

Required permissions

  • none

Required scopes

  • atlas.billing.manage
GET/atlas/v1/billing/eventsimplementedpublic_api

List Atlas billing usage events

Returns the developer billing usage-event audit trail for debugging, reconciliation, and spend review.

Required permissions

  • none

Required scopes

  • atlas.billing.read
GET/operator/developers/billing/summaryimplementeddeveloper_console

Read billing summary

Returns the current plan, current-calendar-month API usage broken down by event type, and the spending ledger for the billing period.

Required permissions

  • none

Required scopes

  • atlas.billing.read
POST/operator/developers/billing/planimplementeddeveloper_console

Change billing plan

Upgrades or downgrades the organization billing plan. Idempotent: calling with the same plan_type twice is safe. pay_as_you_go triggers a Stripe metered subscription; other plans cancel it.

Required permissions

  • none

Required scopes

  • atlas.billing.manage
POST/operator/developers/billing/spending-limitimplementeddeveloper_console

Set monthly spending limit

Sets or clears the monthly spending limit in cents. Requires atlas.billing.manage scope.

Required permissions

  • none

Required scopes

  • atlas.billing.manage