diff --git a/apps/web/openapi-schemas/platform-source.json b/apps/web/openapi-schemas/platform-source.json new file mode 100644 index 00000000000..ce22feb90e6 --- /dev/null +++ b/apps/web/openapi-schemas/platform-source.json @@ -0,0 +1,4 @@ +{ + "sourceRepo": "vellum-ai/vellum-assistant-platform", + "sourceSha": "c0c3d0e797a141146ec849b10a04603dd93cb9d2" +} diff --git a/apps/web/openapi-schemas/platform.yaml b/apps/web/openapi-schemas/platform.yaml index 18d70e8477e..9a4b66d7597 100644 --- a/apps/web/openapi-schemas/platform.yaml +++ b/apps/web/openapi-schemas/platform.yaml @@ -4,6 +4,102 @@ info: version: 1.0.0 (v1) description: Documentation of API endpoints of vellum-assistant-platform paths: + /v1/admin/assistants/{assistant_id}/doctor/history/: + get: + operationId: admin_assistants_doctor_history_list + description: List persisted Doctor sessions for any hosted assistant. + parameters: + - in: header + name: Vellum-Organization-Id + schema: + type: string + format: uuid + description: Required if using Cookie-based or X-Session-Token authentication + methods. + - in: path + name: assistant_id + schema: + type: string + format: uuid + required: true + - name: limit + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - name: offset + required: false + in: query + description: The initial index from which to return the results. + schema: + type: integer + tags: + - admin + security: + - VellumAPIKey: [] + - cookieAuth: [] + - XSessionTokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedDoctorSessionListList' + description: '' + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/DetailResponse' + description: '' + x-vellum-api-clients: + - platform + /v1/admin/assistants/{assistant_id}/doctor/history/{doctor_session_id}/: + get: + operationId: admin_assistants_doctor_history_retrieve + description: Return a persisted Doctor session for any hosted assistant. + parameters: + - in: header + name: Vellum-Organization-Id + schema: + type: string + format: uuid + description: Required if using Cookie-based or X-Session-Token authentication + methods. + - in: path + name: assistant_id + schema: + type: string + format: uuid + required: true + - in: path + name: doctor_session_id + schema: + type: string + format: uuid + required: true + tags: + - admin + security: + - VellumAPIKey: [] + - cookieAuth: [] + - XSessionTokenAuth: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DoctorSessionDetail' + description: '' + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/DetailResponse' + description: '' + x-vellum-api-clients: + - platform /v1/assistants/: get: operationId: assistants_list @@ -2011,6 +2107,45 @@ paths: description: '' x-vellum-api-clients: - platform + /v1/assistants/{id}/upgrade-status/: + get: + operationId: assistants_upgrade_status_detail_read + parameters: + - in: header + name: Vellum-Organization-Id + schema: + type: string + format: uuid + description: Required if using Cookie-based or X-Session-Token authentication + methods. + - in: path + name: id + schema: + type: string + pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ + required: true + tags: + - assistants + security: + - VellumAPIKey: [] + - cookieAuth: [] + - XSessionTokenAuth: [] + - AssistantAPIKey: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UpgradeStatus' + description: '' + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/DetailResponse' + description: '' + x-vellum-api-clients: + - platform /v1/assistants/access-consent/: get: operationId: assistants_access_consent_retrieve @@ -2589,6 +2724,39 @@ paths: description: '' x-vellum-api-clients: - platform + /v1/assistants/upgrade-status/: + get: + operationId: assistants_upgrade_status_retrieve + parameters: + - in: header + name: Vellum-Organization-Id + schema: + type: string + format: uuid + description: Required if using Cookie-based or X-Session-Token authentication + methods. + tags: + - assistants + security: + - VellumAPIKey: [] + - cookieAuth: [] + - XSessionTokenAuth: [] + - AssistantAPIKey: [] + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/UpgradeStatus' + description: '' + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/DetailResponse' + description: '' + x-vellum-api-clients: + - platform /v1/feedback/: post: operationId: feedback_create @@ -3027,6 +3195,10 @@ paths: /v1/organizations/billing/subscription/machine/: post: operationId: organizations_billing_subscription_machine_resize + description: |- + Within-tier machine resize: bump every org assistant up to ``machine_size`` + (no-op for assistants already at or above it). Bounded by the org's + ``BillingAccount.max_machine_tier`` ceiling. Free — no Stripe call. parameters: - in: header name: Vellum-Organization-Id @@ -6133,6 +6305,20 @@ components: required: - detail - version + UpgradeStatus: + type: object + description: |- + Response shape for the upgrade-status read endpoint. + + `in_progress` reflects whether the `assistant:update-lifecycle:` + Redis lock is currently held by an in-flight upgrade or rollback. + Clients use this to proactively disable the Upgrade button rather + than only soft-handling a 409 from POST /upgrade/. + properties: + in_progress: + type: boolean + required: + - in_progress UsageBucket: type: object properties: