Skip to main content

Module api

Module api 

Source
Expand description

One module per OpenAPI tag, each with its own *Api accessor on Client.

Modules§

a2a
Agent-to-Agent protocol: discovery and task execution
acp
Agent Communication Protocol bridge sessions
admin
Platform admin: tenants, audit, reconciliation, DLQ, analytics
admin_config
Platform configuration: pricing, plans, feature flags, rate limits, runtime
agents
Agent CRUD and versioning
analytics
Tenant-scoped usage analytics
auth
User registration and OTP authentication
billing
Usage tracking, quota management, and Stripe webhooks
bootstrap
First-time platform setup
bridge
Local agent bridge for Snaga desktop connections
canvas
Canvas documents attached to a session
companies
Company management
data_explorer
KV data explorer for admin diagnostics
evaluations
Agent evaluation datasets and runs
feed
Activity feed and real-time event streaming
feedback
Error reports from any tenant; the inbox is super-admin only
files
File upload for multimodal content
gdpr
Data subject access and erasure requests
governance
Agent governance: constitution, voting, permissions, emergency protocols
guardrails
Guardrail policies
health
Health checks, readiness, and metrics
integrations
OAuth integrations and connector management
knowledge
Knowledge base management
llm_credentials
LLM provider API key management
marketplace
Agent marketplace: publish, search, rate
mcp
Model Context Protocol server endpoints
me
The calling identity: profile, tenants, head agent
memory
Agent memory management
meta
API metadata
missions
Mission Execution Framework: goal → objectives → authorization gate → execution → after-action review
notifications
User notifications
open_ai_compat
OpenAI-compatible ChatCompletion endpoint
playground
Visual builder and agent playground
programs
Program (curriculum) management
projects
Projects — a workspace grouping agents, sessions and files
providers
LLM provider discovery and model listing
public
Unauthenticated public-facing endpoints
registry
Spec registry — publish, search, yank, share spec artifacts
reports
Content reports — abuse/moderation reporting for authenticated users and anonymous public-chat visitors, plus the operator inbox
runs
Agent execution runs, SSE streaming, HITL, continuation
scheduler
Cron-based scheduling
sessions
Conversation sessions
squads
Squads — multi-agent groups that run a shared brief
teams
Team management and team chat
tenants
Tenant management and API keys
users
User management, invites, roles
webhooks
Webhook subscriptions
workspaces
Workspace management, file storage, and sharing

Structs§

A2AApi
Agent-to-Agent protocol: discovery and task execution
ACPApi
Agent Communication Protocol bridge sessions
AdminAnalyticsAgentsParams
Query and header parameters for adminAnalyticsAgents.
AdminAnalyticsEventsParams
Query and header parameters for adminAnalyticsEvents.
AdminAnalyticsOverviewParams
Query and header parameters for adminAnalyticsOverview.
AdminApi
Platform admin: tenants, audit, reconciliation, DLQ, analytics
AdminConfigApi
Platform configuration: pricing, plans, feature flags, rate limits, runtime
AdminDataExplorerRawKeysParams
Query and header parameters for adminDataExplorerRawKeys.
AgentsApi
Agent CRUD and versioning
AnalyticsApi
Tenant-scoped usage analytics
AuthApi
User registration and OTP authentication
BillingApi
Usage tracking, quota management, and Stripe webhooks
BootstrapApi
First-time platform setup
BridgeApi
Local agent bridge for Snaga desktop connections
BridgePollParams
Query and header parameters for bridgePoll.
BulkDeleteNotificationsParams
Query and header parameters for bulkDeleteNotifications.
CanvasApi
Canvas documents attached to a session
CompaniesApi
Company management
CompleteOAuthLoginParams
Query and header parameters for completeOAuthLogin.
DataExplorerApi
KV data explorer for admin diagnostics
DeleteCustomPlanParams
Query and header parameters for deleteCustomPlan.
DeleteDataExplorerValueParams
Query and header parameters for deleteDataExplorerValue.
DeleteWorkspaceFileParams
Query and header parameters for deleteWorkspaceFile.
DownloadWorkspaceFileParams
Query and header parameters for downloadWorkspaceFile.
EvaluationsApi
Agent evaluation datasets and runs
ExportMyAccountParams
Query and header parameters for exportMyAccount.
ExportSessionParams
Query and header parameters for exportSession.
FeedApi
Activity feed and real-time event streaming
FeedbackApi
Error reports from any tenant; the inbox is super-admin only
FilesApi
File upload for multimodal content
GDPRApi
Data subject access and erasure requests
GetActivityFeedParams
Query and header parameters for getActivityFeed.
GetAgentActivityStatsParams
Query and header parameters for getAgentActivityStats.
GetAgentCardParams
Query and header parameters for getAgentCard.
GetAgentSystemCardParams
Query and header parameters for getAgentSystemCard.
GetAgentVersionDiffParams
Query and header parameters for getAgentVersionDiff.
GetAndroidTestingStatusParams
Query and header parameters for getAndroidTestingStatus.
GetAuditForTargetParams
Query and header parameters for getAuditForTarget.
GetBridgeTaskApprovalParams
Query and header parameters for getBridgeTaskApproval.
GetDataExplorerValueParams
Query and header parameters for getDataExplorerValue.
GetGovernanceLedgerParams
Query and header parameters for getGovernanceLedger.
GetImmutableAuditParams
Query and header parameters for getImmutableAudit.
GetLinkPreviewImageParams
Query and header parameters for getLinkPreviewImage.
GetLinkPreviewParams
Query and header parameters for getLinkPreview.
GetListingReviewsParams
Query and header parameters for getListingReviews.
GetPlatformEconomicsParams
Query and header parameters for getPlatformEconomics.
GetPublicChatAnalyticsParams
Query and header parameters for getPublicChatAnalytics.
GetRunFeedbackParams
Query and header parameters for getRunFeedback.
GetRunParams
Query and header parameters for getRun.
GetSessionRunFeedbackParams
Query and header parameters for getSessionRunFeedback.
GetSquadChatHistoryParams
Query and header parameters for getSquadChatHistory.
GetTeamChatHistoryParams
Query and header parameters for getTeamChatHistory.
GetTenantInboxParams
Query and header parameters for getTenantInbox.
GetTenantOverviewParams
Query and header parameters for getTenantOverview.
GetTenantUsageParams
Query and header parameters for getTenantUsage.
GetUsageParams
Query and header parameters for getUsage.
GetUsageTimeseriesParams
Query and header parameters for getUsageTimeseries.
GetWorkspaceFileHistoryContentParams
Query and header parameters for getWorkspaceFileHistoryContent.
GovernanceApi
Agent governance: constitution, voting, permissions, emergency protocols
GuardrailsApi
Guardrail policies
HandleStripeWebhookParams
Query and header parameters for handleStripeWebhook.
HealthApi
Health checks, readiness, and metrics
IntegrationsApi
OAuth integrations and connector management
KnowledgeApi
Knowledge base management
LLMCredentialsApi
LLM provider API key management
ListA2ATasksParams
Query and header parameters for listA2ATasks.
ListAgentMailParams
Query and header parameters for listAgentMail.
ListAgentWorkspaceFilesParams
Query and header parameters for listAgentWorkspaceFiles.
ListAgentsParams
Query and header parameters for listAgents.
ListAllContentReportsParams
Query and header parameters for listAllContentReports.
ListAmbassadorRequestsParams
Query and header parameters for listAmbassadorRequests.
ListAndroidTestersParams
Query and header parameters for listAndroidTesters.
ListContentReportsParams
Query and header parameters for listContentReports.
ListDataExplorerKeysParams
Query and header parameters for listDataExplorerKeys.
ListFeedbackParams
Query and header parameters for listFeedback.
ListFilesParams
Query and header parameters for listFiles.
ListGoalsParams
Query and header parameters for listGoals.
ListMemoriesParams
Query and header parameters for listMemories.
ListMissionsParams
Query and header parameters for listMissions.
ListNotificationsParams
Query and header parameters for listNotifications.
ListProjectsParams
Query and header parameters for listProjects.
ListPublicBlogPostsParams
Query and header parameters for listPublicBlogPosts.
ListPublicTenantsParams
Query and header parameters for listPublicTenants.
ListRunsParams
Query and header parameters for listRuns.
ListSessionTodosParams
Query and header parameters for listSessionTodos.
ListSessionsParams
Query and header parameters for listSessions.
ListTeamRunsParams
Query and header parameters for listTeamRuns.
ListWorkspaceFileHistoryParams
Query and header parameters for listWorkspaceFileHistory.
ListWorkspaceFilesParams
Query and header parameters for listWorkspaceFiles.
MCPApi
Model Context Protocol server endpoints
MCPJSONRpcParams
Query and header parameters for mcpJsonRpc.
MarketplaceApi
Agent marketplace: publish, search, rate
MeApi
The calling identity: profile, tenants, head agent
MemoryApi
Agent memory management
MetaApi
API metadata
MissionsApi
Mission Execution Framework: goal → objectives → authorization gate → execution → after-action review
NotificationsApi
User notifications
OauthCallbackParams
Query and header parameters for oauthCallback.
OpenAiCompatApi
OpenAI-compatible ChatCompletion endpoint
PlaygroundApi
Visual builder and agent playground
ProgramsApi
Program (curriculum) management
ProjectsApi
Projects — a workspace grouping agents, sessions and files
ProvidersApi
LLM provider discovery and model listing
PublicApi
Unauthenticated public-facing endpoints
PublicDomainLookupParams
Query and header parameters for publicDomainLookup.
QueryAuditLogParams
Query and header parameters for queryAuditLog.
RegistryAdminListSpecsParams
Query and header parameters for registryAdminListSpecs.
RegistryApi
Spec registry — publish, search, yank, share spec artifacts
RegistryGetFileParams
Query and header parameters for registryGetFile.
RegistrySearchParams
Query and header parameters for registrySearch.
ReportsApi
Content reports — abuse/moderation reporting for authenticated users and anonymous public-chat visitors, plus the operator inbox
RunsApi
Agent execution runs, SSE streaming, HITL, continuation
SchedulerApi
Cron-based scheduling
SearchMarketplaceParams
Query and header parameters for searchMarketplace.
SearchParams
Query and header parameters for search.
SearchWorkspaceFilesParams
Query and header parameters for searchWorkspaceFiles.
SensorWebhookParams
Query and header parameters for sensorWebhook.
SessionsApi
Conversation sessions
SquadsApi
Squads — multi-agent groups that run a shared brief
StartOAuthLoginParams
Query and header parameters for startOAuthLogin.
StreamActivityFeedParams
Query and header parameters for streamActivityFeed.
StreamNotificationsParams
Query and header parameters for streamNotifications.
StreamRunEventsParams
Query and header parameters for streamRunEvents.
StreamSessionEventsParams
Query and header parameters for streamSessionEvents.
StreamSquadChatEventsParams
Query and header parameters for streamSquadChatEvents.
StreamTeamChatEventsParams
Query and header parameters for streamTeamChatEvents.
TeamsApi
Team management and team chat
TenantAnalyticsAgentsParams
Query and header parameters for tenantAnalyticsAgents.
TenantsApi
Tenant management and API keys
UpdateAdminSpecPackagesParams
Query and header parameters for updateAdminSpecPackages.
UploadWorkspaceFileParams
Query and header parameters for uploadWorkspaceFile.
UsersApi
User management, invites, roles
VerifyGovernanceLedgerParams
Query and header parameters for verifyGovernanceLedger.
WaitRunParams
Query and header parameters for waitRun.
WebhooksApi
Webhook subscriptions
WorkspacesApi
Workspace management, file storage, and sharing