Files
cleveragents-core/docs/reference/server_api.yaml
T

1637 lines
36 KiB
YAML

openapi: 3.0.0
info:
title: CleverAgents API (Plandex Migration)
version: 1.0.0
description: API specification extracted from Plandex server for CleverAgents migration
servers:
- url: http://localhost:8080
description: Local development server
paths:
/accounts/email_verifications:
post:
summary: ''
operationId: CreateEmailVerificationHandler
tags:
- Authentication
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/accounts/email_verifications/check_pin:
post:
summary: ''
operationId: CheckEmailPinHandler
tags:
- Authentication
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/accounts/sign_in_codes:
post:
summary: like UI to CLI or vice versa
operationId: CreateSignInCodeHandler
tags:
- Authentication
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/accounts/sign_in:
post:
summary: ''
operationId: SignInHandler
tags:
- Authentication
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/accounts/sign_out:
post:
summary: ''
operationId: SignOutHandler
tags:
- Authentication
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/accounts:
post:
summary: ''
operationId: CreateAccountHandler
tags:
- Authentication
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/orgs/session:
get:
summary: ''
operationId: GetOrgSessionHandler
tags:
- Organizations
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/orgs:
get:
summary: ''
operationId: ListOrgsHandler
tags:
- Organizations
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
post:
summary: ''
operationId: CreateOrgHandler
tags:
- Organizations
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/users:
get:
summary: ''
operationId: ListUsersHandler
tags:
- Users
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/orgs/users/{userId}:
delete:
summary: ''
operationId: DeleteOrgUserHandler
tags:
- Organizations
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: userId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/orgs/roles:
get:
summary: ''
operationId: ListOrgRolesHandler
tags:
- Organizations
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/invites:
post:
summary: ''
operationId: InviteUserHandler
tags:
- Invitations
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/invites/pending:
get:
summary: ''
operationId: ListPendingInvitesHandler
tags:
- Invitations
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/invites/accepted:
get:
summary: ''
operationId: ListAcceptedInvitesHandler
tags:
- Invitations
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/invites/all:
get:
summary: ''
operationId: ListAllInvitesHandler
tags:
- Invitations
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/invites/{inviteId}:
delete:
summary: ''
operationId: DeleteInviteHandler
tags:
- Invitations
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: inviteId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/projects:
post:
summary: ''
operationId: CreateProjectHandler
tags:
- Projects
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
get:
summary: ''
operationId: ListProjectsHandler
tags:
- Projects
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/projects/{projectId}/set_plan:
put:
summary: ''
operationId: ProjectSetPlanHandler
tags:
- Projects
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: projectId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/projects/{projectId}/rename:
put:
summary: ''
operationId: RenameProjectHandler
tags:
- Projects
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: projectId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/projects/{projectId}/plans/current_branches:
post:
summary: ''
operationId: GetCurrentBranchByPlanIdHandler
tags:
- Projects
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: projectId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans:
get:
summary: ''
operationId: ListPlansHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/plans/archive:
get:
summary: ''
operationId: ListArchivedPlansHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/plans/ps:
get:
summary: ''
operationId: ListPlansRunningHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/projects/{projectId}/plans:
post:
summary: ''
operationId: CreatePlanHandler
tags:
- Projects
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: projectId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
delete:
summary: ''
operationId: DeleteAllPlansHandler
tags:
- Projects
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: projectId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}:
get:
summary: ''
operationId: GetPlanHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
delete:
summary: ''
operationId: DeletePlanHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/current_plan/{sha}:
get:
summary: ''
operationId: CurrentPlanHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: sha
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/current_plan:
get:
summary: ''
operationId: CurrentPlanHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/apply:
patch:
summary: ''
operationId: ApplyPlanHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/archive:
patch:
summary: ''
operationId: ArchivePlanHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/unarchive:
patch:
summary: ''
operationId: UnarchivePlanHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/rename:
patch:
summary: ''
operationId: RenamePlanHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/reject_all:
patch:
summary: ''
operationId: RejectAllChangesHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/reject_file:
patch:
summary: ''
operationId: RejectFileHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/reject_files:
patch:
summary: ''
operationId: RejectFilesHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/diffs:
get:
summary: ''
operationId: GetPlanDiffsHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/context:
get:
summary: ''
operationId: ListContextHandler
tags:
- Plan Context
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
post:
summary: ''
operationId: LoadContextHandler
tags:
- Plan Context
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
put:
summary: ''
operationId: UpdateContextHandler
tags:
- Plan Context
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
delete:
summary: ''
operationId: DeleteContextHandler
tags:
- Plan Context
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/context/{contextId}/body:
get:
summary: ''
operationId: GetContextBodyHandler
tags:
- Plan Context
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
- name: contextId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/convo:
get:
summary: ''
operationId: ListConvoHandler
tags:
- Plan Conversation
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/rewind:
patch:
summary: ''
operationId: RewindPlanHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/logs:
get:
summary: ''
operationId: ListLogsHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/branches:
get:
summary: ''
operationId: ListBranchesHandler
tags:
- Plan Branches
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/branches/{branch}:
delete:
summary: ''
operationId: DeleteBranchHandler
tags:
- Plan Branches
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/branches:
post:
summary: ''
operationId: CreateBranchHandler
tags:
- Plan Branches
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/settings:
get:
summary: ''
operationId: GetSettingsHandler
tags:
- Plan Settings
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
put:
summary: ''
operationId: UpdateSettingsHandler
tags:
- Plan Settings
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/status:
get:
summary: ''
operationId: GetPlanStatusHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/tell:
post:
summary: ''
operationId: TellPlanHandler
tags:
- Plans
responses:
'200':
description: Successful response
content:
text/event-stream:
schema:
type: string
description: Server-sent events stream
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
x-streaming: true
/plans/{planId}/{branch}/build:
patch:
summary: ''
operationId: BuildPlanHandler
tags:
- Plans
responses:
'200':
description: Successful response
content:
text/event-stream:
schema:
type: string
description: Server-sent events stream
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
x-streaming: true
/custom_models:
get:
summary: ''
operationId: ListCustomModelsHandler
tags:
- Models
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
post:
summary: ''
operationId: UpsertCustomModelsHandler
tags:
- Models
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/custom_models/{modelId}:
get:
summary: ''
operationId: GetCustomModelHandler
tags:
- Models
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: modelId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/custom_providers:
get:
summary: ''
operationId: ListCustomProvidersHandler
tags:
- Models
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/custom_providers/{providerId}:
get:
summary: ''
operationId: GetCustomProviderHandler
tags:
- Models
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: providerId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/model_sets:
get:
summary: ''
operationId: ListModelPacksHandler
tags:
- Models
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
post:
summary: ''
operationId: CreateModelPackHandler
tags:
- Models
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/model_sets/{setId}:
put:
summary: ''
operationId: UpdateModelPackHandler
tags:
- Models
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: setId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/default_settings:
get:
summary: ''
operationId: GetDefaultSettingsHandler
tags:
- Settings
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
put:
summary: ''
operationId: UpdateDefaultSettingsHandler
tags:
- Settings
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/file_map:
post:
summary: ''
operationId: GetFileMapHandler
tags:
- File Management
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/plans/{planId}/{branch}/load_cached_file_map:
post:
summary: ''
operationId: LoadCachedFileMapHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/config:
get:
summary: ''
operationId: GetPlanConfigHandler
tags:
- Plan Settings
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
put:
summary: ''
operationId: UpdatePlanConfigHandler
tags:
- Plan Settings
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/default_plan_config:
get:
summary: ''
operationId: GetDefaultPlanConfigHandler
tags:
- Other
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
put:
summary: ''
operationId: UpdateDefaultPlanConfigHandler
tags:
- Other
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/org_user_config:
get:
summary: ''
operationId: GetOrgUserConfigHandler
tags:
- Settings
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
put:
summary: ''
operationId: UpdateOrgUserConfigHandler
tags:
- Settings
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- sessionAuth: []
/plans/{planId}/{branch}/connect:
patch:
summary: ''
operationId: ConnectPlanHandler
tags:
- Plans
responses:
'200':
description: Successful response
content:
text/event-stream:
schema:
type: string
description: Server-sent events stream
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
x-streaming: true
/plans/{planId}/{branch}/stop:
delete:
summary: ''
operationId: StopPlanHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/respond_missing_file:
post:
summary: ''
operationId: RespondMissingFileHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/auto_load_context:
post:
summary: ''
operationId: AutoLoadContextHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/plans/{planId}/{branch}/build_status:
get:
summary: ''
operationId: GetBuildStatusHandler
tags:
- Plans
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
parameters:
- name: planId
in: path
required: true
schema:
type: string
- name: branch
in: path
required: true
schema:
type: string
security:
- sessionAuth: []
/health:
get:
summary: ''
operationId: HealthHandler
tags:
- System
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
/version:
get:
summary: ''
operationId: VersionHandler
tags:
- System
responses:
'200':
description: Successful response
'401':
description: Unauthorized
'500':
description: Internal server error
components:
securitySchemes:
sessionAuth:
type: apiKey
in: header
name: Authorization