Skip to content

API Reference

Every operation in the Colony Cloud Service API, with its request and response schemas.

Most of these operations take a dashboard session. Only /api/cli/* and /mcp accept a connection; see API Tokens & REST API.

VerbPathSummaryRequest SchemaResponse Schema
GET/api/account/notification-logList the notification pointers recorded for the current user in the session org—NotificationLogResponse
GET/api/account/notification-routingDerive what reaches the current user and why: stewardship, bundles and reports—NotificationRoutingResponse
PUT/api/account/passwordChange the current user passwordChangePasswordRequestMutationSuccessResponse
GET/api/account/profileGet the current user profile—ProfileResponse
PUT/api/account/profileUpdate the current user profileUpdateProfileRequestProfileResponse
GET/api/account/vcs-connectionsList VCS connections for the current user—VcsConnectionsResponse
GET/api/autonomy/{owner}/{repo}Get a repository’s autonomy grant (the default grant when none is set)—RepoAutonomyResponse
PUT/api/autonomy/{owner}/{repo}Set a repository’s autonomy grantRepoAutonomyUpdateRequestRepoAutonomyUpdateResponse
GET/api/bootstrapShell bootstrap: session, orgs, tenants, onboarding, repos and workflows in one response—BootstrapResponse
GET/api/cli/bootstrapReturn org, enabled repos, and the pipeline store mode and minimum version for the CLI—CliBootstrapResponse
GET/api/cli/issuesList pipeline issues for a repo, optionally filtered by state—CliIssueListResponse
GET/api/cli/issues/{number}/whyReturn detailed status and recent transition history for a specific issue—CliIssueWhy
GET/api/cli/pipeline/overviewReturn a full pipeline health snapshot including queue depth, workers, and costs—CliPipelineOverview
GET/api/config/modelsReturn the list of available LLM models and their capability tiers—ModelsResponse
GET/api/draftsList issue drafts for the org—DraftsListResponse
POST/api/draftsCreate a new issue draftCreateDraftRequestCreateDraftResponse
DELETE/api/drafts/{id}Delete a draft—MutationSuccessResponse
GET/api/drafts/{id}Get a draft by ID—DraftResponse
PATCH/api/drafts/{id}Update draft fieldsDraftUpdateRequestDraftResponse
POST/api/drafts/{id}/import-planMaterialize a plan_import draft by importing its stored plan—PlanImportResult
POST/api/drafts/{id}/publishPublish a draft as one item, as its declared cardinality—DraftPublishResponse
POST/api/drafts/assistRun an LLM-powered authoring assist action on a draft bodyDraftAssistRequestDraftAssistResponse
POST/api/drafts/plan-importCreate a plan_import draft holding a parsed plan (materializes nothing)CreatePlanImportDraftRequestCreatePlanImportDraftResponse
GET/api/email/unsubscribePreview what a signed unsubscribe token will stop; never mutates—UnsubscribePreview
POST/api/email/unsubscribeRFC 8058 one-click unsubscribe; stops the emails the signed token names—UnsubscribeResult
GET/api/orgsList organizations the current user belongs to—OrgsListResponse
POST/api/orgsCreate a new organization (Colony staff only)CreateOrgRequestCreateOrgResponse
DELETE/api/orgs/{orgId}Delete an organization—MutationSuccessResponse
GET/api/orgs/{orgId}Get organization details—OrgDetailResponse
PUT/api/orgs/{orgId}Update organization name or slugUpdateOrgRequestOrgDetailResponse
POST/api/orgs/{orgId}/assistant/chatRun an operator assistant turn in a server-held conversation (SSE stream; first event is conversation, except a stream of only an error event when the tools could not be loaded; conversation_title follows when the first exchange is titled)AssistantChatRequesttext/event-stream
DELETE/api/orgs/{orgId}/assistant/conversationsDelete all of the caller’s Mayor conversations——
GET/api/orgs/{orgId}/assistant/conversationsList the caller’s own Mayor conversations, newest last message first—AssistantConversationsResponse
DELETE/api/orgs/{orgId}/assistant/conversations/{id}Delete one of the caller’s Mayor conversations——
GET/api/orgs/{orgId}/assistant/conversations/{id}Read one of the caller’s Mayor conversations, rendered for the panel—AssistantConversationDetail
PUT/api/orgs/{orgId}/assistant/messages/{messageId}/ratingRate one of the caller’s Mayor replies, with an optional note and share on a thumbs downAssistantRatingRequestAssistantRatingResponse
GET/api/orgs/{orgId}/assistant/usageMayor month-to-date use against the org cap and the caller’s use today against their daily limit—AssistantUsageResponse
GET/api/orgs/{orgId}/audit-logFetch the audit event log for an organization—OrgAuditLogResponse
GET/api/orgs/{orgId}/billingGet billing overview for an organization—BillingOverview
POST/api/orgs/{orgId}/billing/customerCreate a Stripe billing customer for an organization—CreateBillingCustomerResponse
GET/api/orgs/{orgId}/billing/invoicesList invoices for an organization—BillingInvoicesResponse
GET/api/orgs/{orgId}/billing/invoices/{invoiceId}Get a single invoice by ID—BillingInvoice
GET/api/orgs/{orgId}/billing/payment-methodGet the Stripe customer portal URL for managing payment methods—CustomerPortalResponse
GET/api/orgs/{orgId}/billing/tenantsList billing tenant subscriptions for an organization—BillingTenantsListResponse
GET/api/orgs/{orgId}/billing/tenants/{tenantId}Get subscription details for a billing tenant—TenantSubscription
POST/api/orgs/{orgId}/billing/tenants/{tenantId}/cancelCancel a tenant subscription at period end—CancelSubscriptionResponse
POST/api/orgs/{orgId}/billing/tenants/{tenantId}/checkoutCreate a Stripe checkout session for a tier upgradeTierTransitionRequestCheckoutSessionResponse
POST/api/orgs/{orgId}/billing/tenants/{tenantId}/reactivateReactivate a canceled tenant subscription—ReactivateSubscriptionResponse
POST/api/orgs/{orgId}/billing/tenants/{tenantId}/tierChange the subscription tier for a tenantTierTransitionRequestChangeTierResponse
POST/api/orgs/{orgId}/billing/tenants/{tenantId}/workersSet the billed worker count for a tenant subscriptionSetBillingWorkerCountRequestSetWorkerCountResponse
DELETE/api/orgs/{orgId}/chatDisconnect chat and remove every personal link (tenant administrators)—MutationSuccessResponse
GET/api/orgs/{orgId}/chatGet the chat connection, link counts and the caller’s own link—ChatStatusResponse
PUT/api/orgs/{orgId}/chat/channelChoose the org channel (tenant administrators)SetChatChannelRequestSetChatChannelResponse
GET/api/orgs/{orgId}/chat/channelsList channels the chat bot can post to (tenant administrators)—ChatChannelsResponse
DELETE/api/orgs/{orgId}/chat/linkRemove the caller’s own chat link—MutationSuccessResponse
POST/api/orgs/{orgId}/chat/linkStart linking the caller’s own chat account—ChatLinkResponse
POST/api/orgs/{orgId}/chat/remindEmail unlinked members a reminder to link, at most one per 7 days (tenant administrators)—ChatRemindResponse
POST/api/orgs/{orgId}/chat/slack/installStart the Slack install (tenant administrators)—ChatInstallResponse
POST/api/orgs/{orgId}/chat/teams/installStart the Microsoft Teams connect (tenant administrators)—ChatInstallResponse
GET/api/orgs/{orgId}/chat/unlinkedList members with no usable chat link (tenant administrators)—ChatUnlinkedResponse
GET/api/orgs/{orgId}/connection-healthGet connection health status for all org integrations—OrgConnectionHealthResponse
PUT/api/orgs/{orgId}/connection-policySet the absolute lifetime of MCP/CLI connections (tenant administrators)UpdateConnectionPolicyRequestUpdateConnectionPolicyResponse
GET/api/orgs/{orgId}/connectionsList live MCP/CLI connections (own, or all for tenant administrators; mine=true limits it to the caller’s own)—OrgConnectionsResponse
DELETE/api/orgs/{orgId}/connections/{connectionId}Revoke an MCP/CLI connection (every refresh and access token in its lineage)—MutationSuccessResponse
GET/api/orgs/{orgId}/faultsList the org’s open faults and when each connected tenant was last evaluated—FaultLedgerResponse
GET/api/orgs/{orgId}/faults/{faultId}Read one fault by id, open or resolved, with the viewer abilities for its tenant—FaultDetailResponse
POST/api/orgs/{orgId}/faults/{faultId}/acknowledgeClaim custody of a fault; refused with FAULT_TAKEN when another member holds it—Fault
POST/api/orgs/{orgId}/faults/{faultId}/hand-offThe custodian hands a fault to another member who can take custodyFaultHandOffRequestFault
DELETE/api/orgs/{orgId}/faults/{faultId}/muteRemove the mute on a fault’s condition; idempotent—Fault
PUT/api/orgs/{orgId}/faults/{faultId}/muteMute a fault’s condition with a reason; it leaves the owed set but stays detectedFaultMuteRequestFault
GET/api/orgs/{orgId}/faults/{faultId}/occurrencesList a fault’s occurrences open at any point in the last 7 days, newest first—FaultOccurrencesResponse
GET/api/orgs/{orgId}/faults/{faultId}/peopleMembers who can take custody of the fault and who can change its daily cost cap—FaultPeopleResponse
POST/api/orgs/{orgId}/faults/{faultId}/readingAsk for a fresh reading of a work-not-moving or dead-lettering fault’s evidence—Reading
POST/api/orgs/{orgId}/faults/{faultId}/releaseThe custodian lets a fault go, so it is owed again—Fault
POST/api/orgs/{orgId}/faults/{faultId}/retryRetry a fault’s stranded items, each through its own gate—FaultRetryResponse
GET/api/orgs/{orgId}/faults/{faultId}/timelineA fault’s timeline: raised, each audit row targeting it, then resolved—FaultTimelineResponse
GET/api/orgs/{orgId}/faults/{faultId}/toldWho has been told about the fault, by ladder rung—FaultToldResponse
GET/api/orgs/{orgId}/installationsList GitHub App installations for an organization—InstallationsResponse
DELETE/api/orgs/{orgId}/installations/{appType}Remove a GitHub App installation from an organization—MutationSuccessResponse
POST/api/orgs/{orgId}/installations/{appType}/connectGet the GitHub App installation connect URL—ConnectInstallationUrlResponse
GET/api/orgs/{orgId}/installations/connectablePre-flight: diff the orgs the caller administers on GitHub against orgs already connected—ConnectableOrgsResponse
POST/api/orgs/{orgId}/installations/refreshRefresh and reconcile GitHub App installations—RefreshInstallationsResponse
GET/api/orgs/{orgId}/invitationsList pending invitations for an organization—InvitationsResponse
POST/api/orgs/{orgId}/invitationsInvite a user to an organizationCreateInvitationRequestCreateInvitationResponse
DELETE/api/orgs/{orgId}/invitations/{id}Revoke an org invitation—MutationSuccessResponse
GET/api/orgs/{orgId}/mayor-model-routeWhether the Mayor runs on the tenant’s own model access: on or off, provider, the reason it is unavailable and the model it would request—MayorModelRouteState
PUT/api/orgs/{orgId}/mayor-model-routeTurn the Mayor’s tenant model route on or off; turning it on runs a live check through the routeUpdateMayorModelRouteRequestUpdateMayorModelRouteResponse
GET/api/orgs/{orgId}/membersList members of an organization—OrgMembersResponse
DELETE/api/orgs/{orgId}/members/{userId}Remove a member from an organization—MutationSuccessResponse
PUT/api/orgs/{orgId}/members/{userId}Update the role of an org memberUpdateMemberRoleRequestMutationSuccessResponse
POST/api/orgs/{orgId}/members/{userId}/reinstateReinstate a suspended member—MutationSuccessResponse
POST/api/orgs/{orgId}/members/{userId}/sign-outSign a member out of every session (bumps the member’s session epoch)—MutationSuccessResponse
POST/api/orgs/{orgId}/members/{userId}/suspendSuspend a member: refuse their access while keeping their grantsSuspendMemberRequestMutationSuccessResponse
GET/api/orgs/{orgId}/onboardingGet the onboarding checklist status for an organization—OnboardingStatusResponse
POST/api/orgs/{orgId}/onboarding/dismissDismiss the onboarding checklist for an organization—MutationSuccessResponse
GET/api/orgs/{orgId}/patienceThe patience numbers at the tenant or repository level, with their sources—PatienceResponse
PUT/api/orgs/{orgId}/patienceSet or clear patience numbers at the tenant or repository levelPatienceUpdateRequestPatienceResponse
POST/api/orgs/{orgId}/pipeline/adoptAdopt an existing Pipeline Store tenant into the organizationAdoptTenantRequestAdoptTenantResponse
GET/api/orgs/{orgId}/pipeline/configGet the pipeline configuration for an organization—PipelineConfigResponse
PUT/api/orgs/{orgId}/pipeline/configUpdate the pipeline configuration for an organizationUpdatePipelineConfigRequestPipelineConfigUpdateResponse
GET/api/orgs/{orgId}/pipeline/discoverDiscover existing tenants from the Pipeline Store—DiscoverTenantsResponse
GET/api/orgs/{orgId}/report-readersList the report readers of an organization—ReportReadersResponse
POST/api/orgs/{orgId}/report-readersInvite a report reader by emailInviteReportReaderRequestInviteReportReaderResponse
DELETE/api/orgs/{orgId}/report-readers/{userId}Remove a report reader and sign them out—MutationSuccessResponse
GET/api/orgs/{orgId}/report-readers/invitationsList pending report-reader invitations—PendingReportReaderInvitationsResponse
DELETE/api/orgs/{orgId}/report-readers/invitations/{id}Revoke a pending report-reader invitation—MutationSuccessResponse
GET/api/orgs/{orgId}/reposList repositories available to the organization—OrgReposResponse
PUT/api/orgs/{orgId}/repos/{externalRepoId}Enable or disable a repository for the pipelineEnableRepoRequestEnableRepoResponse
GET/api/orgs/{orgId}/secretsList configured secrets for an organization—OrgSecretsResponse
PUT/api/orgs/{orgId}/secretsSet or update an org secretSetSecretRequestMutationSuccessResponse
DELETE/api/orgs/{orgId}/secrets/{key}Delete an org secret—MutationSuccessResponse
POST/api/orgs/{orgId}/secrets/checkLive-check a model API key without storing it, or the stored key when value is omittedCheckSecretRequestCheckSecretResponse
GET/api/orgs/{orgId}/standards-setsList an organization’s standards sets, each with its latest published version—StandardsSetsResponse
POST/api/orgs/{orgId}/standards-setsCreate a named standards set with an initial draft versionCreateStandardsSetRequestStandardsSetDetail
GET/api/orgs/{orgId}/standards-sets/{setId}Get a standards set, its versions, and its draft (or latest published) standards—StandardsSetDetail
POST/api/orgs/{orgId}/standards-sets/{setId}/checks/{checkName}/promotePromote a check to blocking, publish, and sweep subscribed repos’ review checks—PromoteStandardsCheckResponse
GET/api/orgs/{orgId}/standards-sets/{setId}/exceptionsList every repo’s recorded exception against the set’s checks—StandardsExceptionsResponse
POST/api/orgs/{orgId}/standards-sets/{setId}/publishPublish the draft version as MAX(version)+1 and open a new draft cloned from it—StandardsSetDetail
POST/api/orgs/{orgId}/standards-sets/{setId}/standardsCreate a standard in the set’s current draft versionCreateStandardRequestStandard
PUT/api/orgs/{orgId}/standards-sets/{setId}/standards/{standardId}Update a standard in the set’s current draft versionUpdateStandardRequestStandard
GET/api/orgs/{orgId}/tenantsList GitHub org tenants associated with this organization—OrgTenantsResponse
GET/api/orgs/{orgId}/tenants/{externalOrgId}/daily-cost-capA tenant’s daily cost cap: the stored value, the effective value and any active raise—DailyCostCapState
PUT/api/orgs/{orgId}/tenants/{externalOrgId}/daily-cost-capSet a tenant’s standing daily cost cap, or raise it for today, with a recorded reasonDailyCostCapRequestDailyCostCapResponse
GET/api/orgs/{orgId}/tenants/{tenantId}/entitlementsGet feature entitlements for a tenant subscription tier—Entitlements
GET/api/orgs/{orgId}/webhooksList outbound webhooks for an organization—OrgWebhookListResponse
POST/api/orgs/{orgId}/webhooksCreate an outbound webhook for an organizationCreateWebhookRequestCreateWebhookResponse
DELETE/api/orgs/{orgId}/webhooks/{id}Delete an outbound webhook—MutationSuccessResponse
PATCH/api/orgs/{orgId}/webhooks/{id}Update an outbound webhookUpdateWebhookRequestUpdateWebhookResponse
GET/api/orgs/{orgId}/webhooks/{id}/deliveriesList delivery attempts for a webhook—WebhookDeliveriesResponse
POST/api/orgs/{orgId}/webhooks/{id}/deliveries/{deliveryId}/replayReplay a failed webhook delivery—WebhookDeliveryIdResponse
POST/api/orgs/{orgId}/webhooks/{id}/testSend a test delivery to a webhook—WebhookDeliveryIdResponse
GET/api/orgs/{orgId}/worker-poolGet the tenant-scoped worker pool config and live status—WorkerPoolResponse
PUT/api/orgs/{orgId}/worker-poolUpdate the tenant-scoped worker pool sizeWorkerPoolUpdateRequestWorkerPoolUpdateResponse
GET/api/orgs/{orgId}/worker-pool/summaryGet the org-wide running and intended worker counts—WorkerPoolSummaryResponse
GET/api/orgs/{orgId}/worker-tokensList worker registration tokens for an organization—WorkerTokensResponse
POST/api/orgs/{orgId}/worker-tokensCreate a worker registration tokenCreateWorkerTokenRequestCreateWorkerTokenResponse
DELETE/api/orgs/{orgId}/worker-tokens/{id}Revoke a worker registration token—MutationSuccessResponse
GET/api/orgs/{orgId}/workersList workers registered to an organization—OrgWorkersResponse
PATCH/api/orgs/{orgId}/workers/{id}Update worker display nameUpdateWorkerRequestMutationSuccessResponse
POST/api/orgs/{orgId}/workers/{workerId}/drainEnqueue a drain command for a worker—WorkerDrainResponse
POST/api/orgs/{orgId}/workers/{workerId}/reclaimReclaim an in-flight task from a worker—WorkerReclaimResponse
GET/api/orgs/{orgId}/workers/floorGet the worker floor view with heartbeat and queue data—WorkerFloorResponse
GET/api/orgs/{orgId}/workers/llm-healthGet LLM health status across all org workers—FleetLlmHealthResponse
GET/api/proposalsList proposals (authored, MCP, and plan-import drafts) for the org, with provenance—ProposalsListResponse
POST/api/proposals/authorizeAuthorize a selection of proposals sequentially; 201 when all are authorized, 207 otherwiseAuthorizeSelectionRequestAuthorizeSelectionResponse
GET/api/repo-groupsList a tenant’s repository groups in priority order with members—RepoGroupListResponse
POST/api/repo-groupsCreate a repository group at the lowest priorityRepoGroupCreateRequestRepoGroup
DELETE/api/repo-groups/{id}Delete a repository group and compact the remaining ranks—RepoGroupDeleteResponse
PUT/api/repo-groups/{id}Edit a repository group’s name and rulesRepoGroupUpdateRequestRepoGroup
PUT/api/repo-groups/orderRewrite the priority order of a tenant’s repository groupsRepoGroupOrderRequestRepoGroupOrderResponse
POST/api/repo-groups/previewPreview which repositories join and leave a group under proposed rulesRepoGroupPreviewRequestRepoGroupPreviewResponse
GET/api/reposList repos enabled for the org—ReposListResponse
GET/api/repos/{owner}/{repo}Get repo detail and settings—RepoDetailResponse
GET/api/repos/{owner}/{repo}/conventionsGet the .colony/conventions.md content for a repo—RepoConventionsResponse
POST/api/repos/{owner}/{repo}/conventions/exportRender the repo’s subscribed standards set to markdown and write it to .colony/conventions.md—RepoConventionsResponse
POST/api/repos/{owner}/{repo}/conventions/importParse the repo’s .colony/conventions.md into standards and import them into the subscribed set’s draft version—ImportConventionsResponse
GET/api/repos/{owner}/{repo}/credentialsList package-feed credentials for a repo—RepoCredentialsResponse
PUT/api/repos/{owner}/{repo}/credentialsUpsert a package-feed credential for a repoUpsertRepoCredentialRequestMutationSuccessResponse
DELETE/api/repos/{owner}/{repo}/credentials/{credentialType}Delete a package-feed credential for a repo—MutationSuccessResponse
GET/api/repos/{owner}/{repo}/credentials/{type}Get full credential detail for a repo (admin only)—RepoCredentialDetailResponse
PUT/api/repos/{owner}/{repo}/default-stewardSet the repository’s default stewards (an empty list clears them)UpdateRepoDefaultStewardRequestRepoDefaultStewardResponse
GET/api/repos/{owner}/{repo}/env-secretsList repository env secrets (metadata only, no values)—ListRepoEnvSecretsResponse
PUT/api/repos/{owner}/{repo}/env-secretsAdd or replace a repository env secretPutRepoEnvSecretBodyMutationSuccessResponse
DELETE/api/repos/{owner}/{repo}/env-secrets/{name}Delete a repository env secret—MutationSuccessResponse
PUT/api/repos/{owner}/{repo}/oauth-credentialsStore Claude.ai OAuth credentials for a repo (Colony’s own organization only; 403 CLAUDE_SUBSCRIPTION_NOT_PERMITTED elsewhere)UpsertRepoOAuthCredentialsRequestMutationSuccessResponse
GET/api/repos/{owner}/{repo}/oauth-statusGet Claude OAuth token status for a repo—OAuthStatusResponse
DELETE/api/repos/{owner}/{repo}/pinUnpin a repository for the signed-in person (idempotent)—RepoPinResponse
PUT/api/repos/{owner}/{repo}/pinPin a repository for the signed-in person (idempotent)—RepoPinResponse
GET/api/repos/{owner}/{repo}/secretsList configured repo secrets (metadata only, no values)—RepoSecretsStatusResponse
PUT/api/repos/{owner}/{repo}/secretsUpsert a named repo secret (Claude OAuth keys only, so Colony’s own organization only; 403 CLAUDE_SUBSCRIPTION_NOT_PERMITTED elsewhere)UpsertRepoSecretRequestMutationSuccessResponse
DELETE/api/repos/{owner}/{repo}/secrets/{key}Delete a named repo secret—MutationSuccessResponse
PUT/api/repos/{owner}/{repo}/settingsUpdate repo pipeline settings (authMode ‘oauth-token’ is Colony’s own organization only; 403 CLAUDE_SUBSCRIPTION_NOT_PERMITTED elsewhere)UpdateRepoSettingsRequestUpdateRepoSettingsResponse
POST/api/repos/{owner}/{repo}/settings/inheritClear a repository’s own value for a setting so it inherits againInheritSettingRequestInheritSettingResponse
GET/api/repos/{owner}/{repo}/si-portfolio/conformanceCompare what the repo’s tracks originated this week with the active portfolio version—PortfolioConformanceResponse
GET/api/repos/{owner}/{repo}/si-portfolio/versionsList the self-improvement portfolio versions of a repo—PortfolioVersionsResponse
POST/api/repos/{owner}/{repo}/si-portfolio/versionsCreate a portfolio draft from the active version or current track values—PortfolioVersionResponse
DELETE/api/repos/{owner}/{repo}/si-portfolio/versions/{version}Delete a portfolio draft—MutationSuccessResponse
GET/api/repos/{owner}/{repo}/si-portfolio/versions/{version}Get a portfolio version with its entries—PortfolioVersionResponse
POST/api/repos/{owner}/{repo}/si-portfolio/versions/{version}/activateActivate a published portfolio version—PortfolioVersionResponse
PUT/api/repos/{owner}/{repo}/si-portfolio/versions/{version}/entriesReplace the entries of a portfolio draftReplacePortfolioEntriesRequestPortfolioVersionResponse
POST/api/repos/{owner}/{repo}/si-portfolio/versions/{version}/publishPublish a portfolio draft (runs nothing until activated)—PortfolioVersionResponse
POST/api/repos/{owner}/{repo}/si-portfolio/versions/{version}/templateMark a published, active or superseded portfolio version as a reusable templateMarkPortfolioTemplateRequestPortfolioTemplate
POST/api/repos/{owner}/{repo}/si-tracksCreate a self-improvement track for a repoCreateSITrackRequestCreateSITrackResponse
DELETE/api/repos/{owner}/{repo}/si-tracks/{trackId}Delete a self-improvement track—MutationSuccessResponse
PATCH/api/repos/{owner}/{repo}/si-tracks/{trackId}Update a self-improvement trackUpdateSITrackRequestCreateSITrackResponse
PUT/api/repos/{owner}/{repo}/si-tracks/{trackId}/governanceDeclare a self-improvement track governed by the active portfolio or independentUpdateSITrackGovernanceRequestCreateSITrackResponse
GET/api/repos/{owner}/{repo}/si-tracks/{trackId}/promptsList prompt versions for a self-improvement track—SIPromptVersionsResponse
POST/api/repos/{owner}/{repo}/si-tracks/{trackId}/promptsCreate a new prompt version for a self-improvement trackCreateSIPromptVersionRequestCreateSIPromptVersionResponse
GET/api/repos/{owner}/{repo}/si-tracks/{trackId}/prompts/{version}Get a specific prompt version for a self-improvement track—SIPromptVersionResponse
POST/api/repos/{owner}/{repo}/si-tracks/{trackId}/prompts/{version}/activateActivate a prompt version for a self-improvement track—ActivateSIPromptVersionResponse
GET/api/repos/{owner}/{repo}/standardsList the standards from the repo’s subscribed standards set (latest published version)—StandardsResponse
GET/api/repos/{owner}/{repo}/standards/exceptionsList the exceptions recorded for the repo against its standards-set checks—StandardsExceptionsResponse
POST/api/repos/{owner}/{repo}/standards/exceptionsRecord a reasoned exception for an enforced check; the check becomes non-blockingRecordStandardsExceptionRequestRecordStandardsExceptionResponse
DELETE/api/repos/{owner}/{repo}/standards/exceptions/{id}Remove an exception and restore the check to the set’s blocking value—MutationSuccessResponse
GET/api/repos/{owner}/{repo}/standards/subscriptionGet the repo’s current standards-set subscription and the set it points to—RepoSubscriptionResponse
PUT/api/repos/{owner}/{repo}/standards/subscriptionSubscribe the repo to an org-level standards set (always-latest, no copy made)SubscribeRepoRequestRepoSubscriptionResponse
GET/api/repos/{owner}/{repo}/steward-candidatesList the org members’ linked logins who can steward the repository’s work—StewardCandidatesResponse
GET/api/repos/{owner}/{repo}/tracksList self-improvement tracks for a repo—RepoTracksResponse
PUT/api/repos/{owner}/{repo}/tracks/{name}Enable or disable a self-improvement trackUpdateSITrackEnabledRequestCreateSITrackResponse
POST/api/repos/{owner}/{repo}/validate-conventionsValidate a draft issue against the repo conventionsValidateConventionsRequestValidateConventionsResponse
GET/api/repos/yoursUp to 8 repositories for the header control: pinned first, then recent activity—YourReposResponse
GET/api/reviewsList issues awaiting human review—ReviewsListResponse
DELETE/api/settings/bindings/autonomyRemove a tenant or group value for a Autonomy Settings-tab fieldSettingBindingRemoveRequestSettingBindingRemoveResponse
PUT/api/settings/bindings/autonomySet a tenant or group value for a Autonomy Settings-tab fieldSettingBindingRequestSettingBindingSetResponse
DELETE/api/settings/bindings/operationsRemove a tenant or group value for a Operations Settings-tab fieldSettingBindingRemoveRequestSettingBindingRemoveResponse
PUT/api/settings/bindings/operationsSet a tenant or group value for a Operations Settings-tab fieldSettingBindingRequestSettingBindingSetResponse
DELETE/api/settings/bindings/standardsRemove a tenant or group value for a Standards Settings-tab fieldSettingBindingRemoveRequestSettingBindingRemoveResponse
PUT/api/settings/bindings/standardsSet a tenant or group value for a Standards Settings-tab fieldSettingBindingRequestSettingBindingSetResponse
GET/api/settings/inheritedGet a Settings tab’s values with their sources and how many repositories override them—InheritedSettingsResponse
GET/api/si-portfolio/templatesList the org’s portfolio templates—PortfolioTemplatesResponse
DELETE/api/si-portfolio/templates/{id}Unmark a portfolio template (seeded drafts and every repo portfolio stay as they are)—MutationSuccessResponse
POST/api/si-portfolio/templates/{id}/pushSeed one draft per repo from a template (up to 25; 201 all drafted, 207 otherwise)PushPortfolioTemplateRequestPushPortfolioTemplateResponse
GET/api/status/healthLiveness probe — always returns 200 ok with no DB dependency—StatusProbeResponse
GET/api/strategy/{owner}/{repo}/charterGet the active strategy charter for a repository—StrategyCharterResponse
PUT/api/strategy/{owner}/{repo}/charterCreate or replace the active strategy charter (ordered goals and guidance); 422 INVALID_GOAL, DUPLICATE_GOAL_ID, UNKNOWN_GOAL_ID or EMPTY_CHARTERStrategyCharterUpsertRequestStrategyCharterUpsertResponse
GET/api/strategy/{owner}/{repo}/overviewStrategy overview: goals in charter order with their last 5 assessments, the last outcome and the next run (goals paged)—StrategyOverviewResponse
GET/api/strategy/{owner}/{repo}/run-stateGet the strategist’s latest run and whether the repository has an active charter—RepoStrategistRunStateResponse
GET/api/strategy/{owner}/{repo}/settingsGet a repository’s strategy settings, next run and last outcome—StrategySettingsResponse
PUT/api/strategy/{owner}/{repo}/settingsUpdate a repository’s strategy settingsStrategySettingsUpdateRequestStrategySettingsUpdateResponse
GET/api/strategy/{owner}/{repo}/snapshotsList strategy snapshots for a repository, each with its trigger (default: proposed, active, rejected + invalid)—StrategySnapshotListResponse
GET/api/strategy/{owner}/{repo}/snapshots/{version}Get a single strategy snapshot by version—StrategySnapshotDetailResponse
POST/api/strategy/{owner}/{repo}/snapshots/{version}/approveApprove a proposed strategy snapshot and apply it, optionally with whole-array edits; refused edits return 422 with violationsStrategyApproveRequestStrategyApproveResponse
POST/api/strategy/{owner}/{repo}/snapshots/{version}/rejectDecline a proposed strategy snapshot (a reason is required)—StrategyRejectResponse
GET/api/strategy/{owner}/{repo}/snapshots/{version}/reviewReview a strategy snapshot: its per-track diff against the live strategy tracks, the operator tracks, the capacity split and the run’s collected inputs—StrategyReviewResponse
GET/api/strategy/{owner}/{repo}/snapshots/{version}/transcriptThe Strategist run’s transcript for a snapshot, read by the run’s task id—StrategyTranscriptResponse
POST/api/strategy/{owner}/{repo}/snapshots/generateRequest an on-demand Strategist run for a repository—GenerateStrategyProposalResponse
POST/api/strategy/{owner}/{repo}/snapshots/revertRe-apply the active strategy snapshot’s parent pool as a new version—StrategyRevertResponse
GET/api/strategy/pending-proposalsList repos with pending strategy proposals, their counts and the oldest wait per repo (paged by repo); total sums proposals across all repos—StrategyPendingProposalsResponse
GET/healthReturn API and database connectivity health status (session required)—HealthResponse
POST/mcpHandle MCP JSON-RPC 2.0 messages (initialize, tools/list, tools/call)—McpJsonRpcResponse
GET/pipeline/active-workflowsReturn the distinct set of active workflows (by workflowId+version) currently referenced by non-terminal issues—ActiveWorkflowsResponse
GET/pipeline/attentionReturn list of issues that need operator attention (paged)—NeedsAttentionResponse
GET/pipeline/attention-countReturn count of issues that need operator attention—AttentionCountResponse
GET/pipeline/attributionReturn cost and work attribution by contributor for a time window—PipelineAttributionResponse
GET/pipeline/autonomyReturn autonomy-rate metrics for a time window—AutonomyResponse
GET/pipeline/blocked-issuesReturn blocked issues with blocking reasons (paged); patterns cover every blocked issue—BlockedIssuesResponse
GET/pipeline/budget-overviewReturn budget burn rate and exhaustion against the tenant ceiling—BudgetOverviewResponse
GET/pipeline/cohort-funnelReturn cohort funnel drop-off analysis for a time window—CohortFunnelResponse
GET/pipeline/cost-by-modelReturn cost breakdown by LLM model for a time window—CostByModelResponse
GET/pipeline/cost-projectionProject monthly LLM spend from throughput and complexity-mix assumptions—CostProjectionResponse
GET/pipeline/cost-summaryReturn total LLM spend across 24h, 7d, 30d, and lifetime horizons—CostSummaryResponse
GET/pipeline/cost-timeseriesReturn LLM spend bucketed by hour/day/week/month for an operator-specified range—CostTimeseriesResponse
GET/pipeline/dead-lettersReturn dead-letter queue entries—DeadLettersResponse
POST/pipeline/dead-letters/{id}/resolveMark a dead-letter entry as manually resolved—MutationSuccessResponse
POST/pipeline/dead-letters/{id}/retryRe-enqueue a dead-letter entry for retry—MutationSuccessResponse
POST/pipeline/dead-letters/resolve-allMark every unresolved dead-letter entry for the tenant as resolved—DeadLetterResolveAllResponse
GET/pipeline/digestReturn the daily pipeline digest summary—DailyDigestResponse
GET/pipeline/eventsReturn paginated pipeline events with optional filters—PipelineEventsResponse
GET/pipeline/events/streamSSE stream of real-time pipeline state changes—text/event-stream
GET/pipeline/findingsReturn paginated pipeline findings with optional filters—FindingsResponse
GET/pipeline/intelligence/{id}Return a single intelligence item by ID—IntelligenceDetailResponse
PATCH/pipeline/intelligence/{id}Partial-update operator-editable fields on an intelligence itemUpdateIntelligenceRequestIntelligenceMutationResponse
POST/pipeline/intelligence/{id}/approveApprove a candidate/observed/proposed intelligence itemApproveIntelligenceRequestIntelligenceMutationResponse
POST/pipeline/intelligence/{id}/dismissDismiss an intelligence item with a required reasonDismissIntelligenceRequestIntelligenceMutationResponse
GET/pipeline/issuesList active pipeline issues for the org, newest update first, paged—PipelineIssuesResponse
GET/pipeline/issues/{issueId}/costsReturn cost breakdown for a pipeline issue—IssueCostBreakdownResponse
GET/pipeline/issues/{owner}/{repo}/{number}Return full detail for a single pipeline issue—IssueDetailResponse
GET/pipeline/issues/{owner}/{repo}/{number}/accountReturn a work item’s assembled account: station visits and their attempts—WorkItemAccountResponse
POST/pipeline/issues/{owner}/{repo}/{number}/actionsDispatch an operator action on a pipeline issueIssueActionRequestIssueActionResponse
GET/pipeline/issues/{owner}/{repo}/{number}/commentsReturn the comments on a work item’s thread (paged, oldest first)—IssueCommentsResponse
POST/pipeline/issues/{owner}/{repo}/{number}/commentsPost a reply on a work item’s thread with the caller’s own VCS credentialCreateIssueCommentRequestCreateIssueCommentResponse
GET/pipeline/issues/{owner}/{repo}/{number}/dependency-treeReturn dependency tree for a pipeline issue—IssueDependencyTreeResponse
GET/pipeline/issues/{owner}/{repo}/{number}/eventsReturn paginated timeline events for a pipeline issue—IssueEventsResponse
POST/pipeline/issues/{owner}/{repo}/{number}/invoke-operator-actionInvoke a custom operator action on a pipeline issueInvokeOperatorActionRequestInvokeOperatorActionResponse
GET/pipeline/issues/{owner}/{repo}/{number}/lifecycle-traceReturn the selected lifecycle trace for a pipeline issue, one page of its events; traceId pins the trace across pages—LifecycleTraceResponse
GET/pipeline/issues/{owner}/{repo}/{number}/messagesReturn agent messages for a pipeline issue task—AgentMessagesResponse
POST/pipeline/issues/{owner}/{repo}/{number}/operator-actionExecute any operator action (framework or custom) via the unified snapshot-driven handler. An Accept may carry expectedHeadSha, followup (followup or no-followup) and note (at most 2000 characters); both apply only to Accept. A pipeline that has not confirmed the Accept yet returns outcome pending. Refusals accept nothing and return 409 with the pipeline’s message: HEAD_MOVED, WRONG_STATE, ITEM_PAUSED, ALREADY_DECIDED, NOTHING_TO_ACCEPT, EPIC_SUBTASK, NOT_EPIC or CODE_HOST_UNAVAILABLEOperatorActionRequestInvokeOperatorActionResponse
GET/pipeline/issues/{owner}/{repo}/{number}/overrideReturn the states an item’s workflow allows it to move to from its current state—OverrideTargetsResponse
POST/pipeline/issues/{owner}/{repo}/{number}/releaseRelease a parent from a canceled subtask so it stops waiting and can finalize (requires the release grant)ReleaseSubtaskRequestReleaseSubtaskResponse
GET/pipeline/issues/{owner}/{repo}/{number}/retrospectiveReturn retrospective analysis for a completed pipeline issue—IssueRetrospectiveResponse
POST/pipeline/issues/{owner}/{repo}/{number}/stewardshipClaim, take over or assign a work item’s stewardship with the caller’s own VCS credentialStewardshipRequestStewardshipResponse
GET/pipeline/issues/{owner}/{repo}/{number}/toldReturn who has been told about a work item, and the ladder’s next step—WorkItemToldResponse
GET/pipeline/operational-summaryReturn operational summary dashboard data—OperationalSummaryResponse
GET/pipeline/owed-countReturn count of queue items owed to the viewer, optionally in one repository—OwedCountResponse
GET/pipeline/projectionsReturn GitHub write projections filtered by status (default failed)—ProjectionsResponse
POST/pipeline/projections/{id}/discardDiscard a failed or pending GitHub write projection—MutationSuccessResponse
POST/pipeline/projections/{id}/retryReset a failed GitHub write projection to pending—MutationSuccessResponse
GET/pipeline/regression-guardReturn KPI regression guard status across repos, paged by repo—RegressionGuardResponse
GET/pipeline/repo-budgetsReturn each repo’s budget cap and effective ceiling, with the tenant cap—RepoBudgetsResponse
GET/pipeline/reportsReturn the sealed report ledger, newest first, including restatements; paged (up to 430 rows per page)—ReportLedgerResponse
GET/pipeline/reports/{id}Return a sealed report by id, byte-identical to the stored payload—Report
GET/pipeline/reports/{id}/itemsReturn a sealed report’s A1 or A5 items as they stood at period close, recomputed from the transition history, with the sealed count—ReportItemsResponse
GET/pipeline/reports/{id}/readingReturn Colony’s stored reading of a sealed report, or an unavailable reading when none exists; never calls the model—Reading
GET/pipeline/reports/openReturn the live open report for the current period window, recomputed on read—OpenReportResponse
GET/pipeline/reports/subscriptionsReturn the signed-in user’s report subscriptions for a tenant, ordered day, week, month—ReportSubscriptionsResponse
DELETE/pipeline/reports/subscriptions/{period}Unsubscribe the signed-in user from a tenant period report (idempotent)—ReportSubscriptionsResponse
PUT/pipeline/reports/subscriptions/{period}Subscribe the signed-in user to a tenant period report (idempotent)—ReportSubscriptionsResponse
GET/pipeline/repos/{owner}/{repo}/code-map/entitiesReturn a searchable paginated list of code-map entities for a repo—CodeMapEntityListResponse
GET/pipeline/repos/{owner}/{repo}/code-map/entities/{entityId}/relationshipsReturn inbound and outbound relationships for a code-map entity—CodeMapEntityRelationshipsResponse
GET/pipeline/repos/{owner}/{repo}/code-map/scanReturn the latest code-map scan status, entity/relationship counts, and staleness for a repo—CodeMapScanStatusResponse
GET/pipeline/repos/{owner}/{repo}/cost-basisMedian cost of the last 20 completed work items in a repository—CostBasisResponse
POST/pipeline/repos/{owner}/{repo}/estimateRequest a cost and complexity estimate for a task descriptionEstimateRequestEstimateResponse
POST/pipeline/repos/{owner}/{repo}/file-issueFile a new issue into the pipeline via natural-language descriptionFileIssueRequestFileIssueResponse
GET/pipeline/repos/{owner}/{repo}/intelligenceReturn intelligence items for a repo—IntelligenceListResponse
GET/pipeline/repos/{owner}/{repo}/intelligence/retrieveRetrieve ranked intelligence snippets for an agent role, with optional issue/PR context—IntelligenceRetrieveResponse
GET/pipeline/repos/{owner}/{repo}/intelligence/searchSemantic search over intelligence items using pgvector embeddings—IntelligenceSearchResponse
POST/pipeline/repos/{owner}/{repo}/knowledgeAdd a knowledge item to a repoAddKnowledgeRequestAddKnowledgeResponse
POST/pipeline/repos/{owner}/{repo}/plan/importImport a structured task plan into the pipelineImportPlanRequestPlanImportResult
GET/pipeline/repos/{owner}/{repo}/prs/{prNumber}/reviewReturn the colony review for a pull request—ReviewResponse
GET/pipeline/repos/{owner}/{repo}/retrieval/source-stateLatest persisted retrieval source states (code map, precedent) for a repo—RetrievalSourceStatesEntry
GET/pipeline/repos/{owner}/{repo}/retrospectivesReturn all retrospectives for a repo—RepoRetrospectivesResponse
GET/pipeline/repos/{owner}/{repo}/routed-workflowReturn the workflow an item from this repo routes to by default, plus the workflows its routing rules can send an item to (no predicate evaluated)—RoutedWorkflowResponse
GET/pipeline/repos/{owner}/{repo}/workflow-setReturn a repo’s activated workflow set—RepoWorkflowSetResponse
PUT/pipeline/repos/{owner}/{repo}/workflow-setReplace a repo’s activated workflow set (requires the Operations grant)RepoWorkflowSetSaveRequestRepoWorkflowSetResponse
GET/pipeline/snapshotReturn per-state issue counts and issue details for all pipeline states. A row in its acceptance action’s target state carries acceptVerdict when a verdict is recorded. A row whose ask is a judgment carries judgement: the deterministic review summary, its tally and the change link—SnapshotResponse
GET/pipeline/standards-adoptionReturn, per enforced check in a standards set, its blocking flag and how subscribed repos split into failing, clean, excepted and not running—StandardsAdoptionResponse
GET/pipeline/state-timeseriesReturn state occupancy timeseries for a time window—StateTimeseriesResponse
GET/pipeline/statsReturn aggregate pipeline statistics—PipelineStatsResponse
GET/pipeline/task-queueReturn the current task queue (paged); summary covers the whole queue, optionally scoped by repo—TaskQueueResponse
GET/pipeline/transitionsReturn state transition history since a given timestamp—TransitionsResponse
GET/pipeline/trendsReturn pipeline trend metrics for a time window—PipelineTrendsResponse
GET/pipeline/version-skewReturn declared workflow pins, running workflow versions and running worker builds—VersionSkewResponse
GET/pipeline/work-items/searchSearch work items by number or title across the tenant, all states, newest first—WorkItemSearchResponse
GET/pipeline/workflow-definitionsReturn workflow definitions for the tenant (paged)—WorkflowRegistryResponse
POST/pipeline/workflow-definitionsRegister a validated workflow YAML as a new version in the registry (requires the Standards grant)WorkflowRegisterRequestWorkflowRegisterResponse
GET/pipeline/workflow-definitions/{workflowId}Return a specific workflow definition by ID and optional version—WorkflowDefinitionDetail
POST/pipeline/workflow-definitions/{workflowId}/activateActivate a published workflow version on one or more repos of a tenant in one transaction, writing workflow_id and workflow_version togetherWorkflowActivateRequestWorkflowActivateResponse
GET/pipeline/workflow-definitions/{workflowId}/activation-previewRead-only count of items in flight per repo (judged against each item’s pinned workflow) before activating a version—WorkflowActivationPreviewResponse
POST/pipeline/workflow-definitions/validateValidate a workflow YAML and return structured errors or a preview snapshotWorkflowValidateRequestWorkflowValidateResponse
DELETE/pipeline/workflow-draftsClear the tenant’s persisted workflow draft—WorkflowDraftResponse
GET/pipeline/workflow-draftsReturn the tenant’s single persisted workflow draft, or null if none exists—WorkflowDraftResponse
PUT/pipeline/workflow-draftsUpsert the tenant’s single workflow draft, so it survives closing the editorWorkflowDraftSaveRequestWorkflowDraftResponse
GET/pipeline/workflowsReturn each enabled repo’s active WorkflowSnapshot keyed by owner/repo—WorkflowSnapshotMapResponse