{ "openapi": "3.0.3", "info": { "title": "Devin API v3", "description": "Devin v3 API with Service User authentication and RBAC", "version": "3.0.0" }, "paths": { "/v3/self": { "get": { "tags": [ "self" ], "summary": "Get Self", "operationId": "handle_get_self_v3_self_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ServiceUserSelf" }, { "$ref": "#/components/schemas/PatUserSelf" }, { "$ref": "#/components/schemas/DevinBrainUserSelf" }, { "$ref": "#/components/schemas/WindsurfSessionUserSelf" } ], "title": "Response Handle Get Self V3 Self Get" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/acu-limits/devin": { "get": { "tags": [ "acu-limits" ], "summary": "Get Devin ACU limits", "description": "Get all org-level Devin ACU limits for this enterprise.", "operationId": "handle_get_devin_acu_limits_v3_enterprise_consumption_acu_limits_devin_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_ACULimitResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/acu-limits/devin/organizations/{org_id}": { "put": { "tags": [ "acu-limits" ], "summary": "Set org-level Devin ACU limit", "description": "Create or update an org-level Devin ACU limit.", "operationId": "handle_set_org_devin_acu_limit_v3_enterprise_consumption_acu_limits_devin_organizations__org_id__put", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateACULimitRequest" } } } }, "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "acu-limits" ], "summary": "Delete org-level Devin ACU limit", "description": "Delete an org-level Devin ACU limit.", "operationId": "handle_delete_org_devin_acu_limit_v3_enterprise_consumption_acu_limits_devin_organizations__org_id__delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/cycles": { "get": { "tags": [ "consumption" ], "summary": "List Consumption Cycles", "operationId": "handle_get_consumption_cycles_v3_enterprise_consumption_cycles_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_ConsumptionCycle_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/daily": { "get": { "tags": [ "consumption" ], "summary": "Get Daily Consumption", "description": "Get daily ACU consumption for the entire enterprise.\n\nReturns total ACUs and consumption broken down by date.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC. To match the consumption\ndata shown in the Devin dashboard, pass Unix timestamps that align with this\ntimezone offset (e.g., 1733385600 for December 5, 2025 at midnight PST).", "operationId": "handle_get_consumption_daily_v3_enterprise_consumption_daily_get", "parameters": [ { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/daily/organizations/{org_id}": { "get": { "tags": [ "consumption" ], "summary": "Get Organization Daily Consumption", "description": "Get daily ACU consumption for a specific organization.\n\nReturns total ACUs and consumption broken down by date for the org.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC. To match the consumption\ndata shown in the Devin dashboard, pass Unix timestamps that align with this\ntimezone offset (e.g., 1733385600 for December 5, 2025 at midnight PST).", "operationId": "handle_get_org_consumption_daily_v3_enterprise_consumption_daily_organizations__org_id__get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/daily/users/{user_id}": { "get": { "tags": [ "consumption" ], "summary": "Get User Daily Consumption", "description": "Get daily ACU consumption for a specific user.\n\nReturns total ACUs and consumption broken down by date for the user.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC. To match the consumption\ndata shown in the Devin dashboard, pass Unix timestamps that align with this\ntimezone offset (e.g., 1733385600 for December 5, 2025 at midnight PST).", "operationId": "handle_get_user_consumption_daily_v3_enterprise_consumption_daily_users__user_id__get", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" }, { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/daily/service-users/{service_user_id}": { "get": { "tags": [ "consumption" ], "summary": "Get Service User Daily Consumption", "description": "Get daily ACU consumption for a specific service user.\n\nReturns total ACUs and consumption broken down by date for sessions\ncreated by the given service user.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC. To match the consumption\ndata shown in the Devin dashboard, pass Unix timestamps that align with this\ntimezone offset (e.g., 1733385600 for December 5, 2025 at midnight PST).", "operationId": "handle_get_service_user_consumption_daily_v3_enterprise_consumption_daily_service_users__service_user_id__get", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/consumption/daily/sessions/{session_id}": { "get": { "tags": [ "consumption" ], "summary": "Get Session Daily Consumption", "description": "Get daily ACU consumption for a specific session.\n\nReturns total ACUs and consumption broken down by date for the session.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC. To match the consumption\ndata shown in the Devin dashboard, pass Unix timestamps that align with this\ntimezone offset (e.g., 1733385600 for December 5, 2025 at midnight PST).", "operationId": "handle_get_session_consumption_daily_v3_enterprise_consumption_daily_sessions__session_id__get", "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id", "example": "devin-abc123def456" }, "description": "Session ID (prefix: devin-). Alias for devin_id used in consumption endpoints." }, { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/usage": { "get": { "tags": [ "metrics" ], "summary": "Get Usage Metrics", "description": "Get aggregated usage metrics for the enterprise account.\n\nReturns counts of sessions, searches, and PRs (opened, closed, merged)\nwithin the specified time range.", "operationId": "handle_get_usage_metrics_v3_enterprise_metrics_usage_get", "parameters": [ { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageMetrics" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/metrics/usage": { "get": { "tags": [ "metrics" ], "summary": "Get Organization Usage Metrics", "description": "Get aggregated usage metrics for the enterprise account.\n\nReturns counts of sessions, searches, and PRs (opened, closed, merged)\nwithin the specified time range.", "operationId": "handle_get_organization_usage_metrics_v3_enterprise_organizations__org_id__metrics_usage_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageMetrics" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/sessions": { "get": { "tags": [ "metrics" ], "summary": "Get Session Metrics", "description": "Get aggregated session metrics for the enterprise account.\n\nOptionally filter by playbook_id to get metrics for sessions created with a specific playbook.", "operationId": "handle_get_session_metrics_v3_enterprise_metrics_sessions_get", "parameters": [ { "name": "user_ids", "in": "query", "required": false, "schema": { "title": "User Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "service_user_ids", "in": "query", "required": false, "schema": { "title": "Service User Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "title": "Org Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "playbook_id", "in": "query", "required": false, "schema": { "title": "Playbook Id", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/searches": { "get": { "tags": [ "metrics" ], "summary": "Get Search Metrics", "description": "Get aggregated search metrics for the enterprise account.", "operationId": "handle_get_search_metrics_v3_enterprise_metrics_searches_get", "parameters": [ { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "title": "Org Ids", "nullable": true, "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/prs": { "get": { "tags": [ "metrics" ], "summary": "Get PR Metrics", "description": "Get aggregated PR metrics for the enterprise account.\n\nOptionally filter by playbook_id to get metrics for PRs from sessions created with a specific playbook.", "operationId": "handle_get_pr_metrics_v3_enterprise_metrics_prs_get", "parameters": [ { "name": "user_ids", "in": "query", "required": false, "schema": { "title": "User Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "service_user_ids", "in": "query", "required": false, "schema": { "title": "Service User Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "title": "Org Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "playbook_id", "in": "query", "required": false, "schema": { "title": "Playbook Id", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/dau": { "get": { "tags": [ "metrics" ], "summary": "Get Daily Active Users", "description": "Get daily active users for each day in the specified time range.\n\nA user is considered active on a given day if they have created at least\nmin_sessions sessions OR at least min_searches searches during that UTC day.\n\nReturns a list of daily active user counts, one entry per day in the range.", "operationId": "handle_get_dau_metrics_v3_enterprise_metrics_dau_get", "parameters": [ { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "title": "Org Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "min_sessions", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Sessions" } }, { "name": "min_searches", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Searches" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveUserMetricsListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/wau": { "get": { "tags": [ "metrics" ], "summary": "Get Weekly Active Users", "description": "Get weekly active users for each week in the specified time range.\n\nA user is considered active in a given week if they have created at least\nmin_sessions sessions OR at least min_searches searches during that UTC week.\n\nWeeks are defined as Monday 00:00:00 UTC to Sunday 23:59:59 UTC.\n\nReturns a list of weekly active user counts, one entry per week in the range.", "operationId": "handle_get_wau_metrics_v3_enterprise_metrics_wau_get", "parameters": [ { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "title": "Org Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "min_sessions", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Sessions" } }, { "name": "min_searches", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Searches" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveUserMetricsListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/mau": { "get": { "tags": [ "metrics" ], "summary": "Get Monthly Active Users", "description": "Get monthly active users for each month in the specified time range.\n\nA user is considered active in a given month if they have created at least\nmin_sessions sessions OR at least min_searches searches during that UTC month.\n\nReturns a list of monthly active user counts, one entry per month in the range.", "operationId": "handle_get_mau_metrics_v3_enterprise_metrics_mau_get", "parameters": [ { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "title": "Org Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "min_sessions", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Sessions" } }, { "name": "min_searches", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Searches" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveUserMetricsListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/sessions-by-category": { "get": { "tags": [ "metrics" ], "summary": "Get Session Metrics by Category", "description": "Get session counts and ACU consumption grouped by category and subcategory.", "operationId": "handle_get_sessions_by_category_v3_enterprise_metrics_sessions_by_category_get", "parameters": [ { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "title": "Org Ids", "nullable": true, "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionsByCategoryResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/metrics/active-users": { "get": { "tags": [ "metrics" ], "summary": "Get Active Users for Custom Date Range", "description": "Get unique active users for a custom date range.\n\nA user is considered active if they have created at least min_sessions sessions\nOR at least min_searches searches within the specified time range.\n\nReturns a single count of unique active users across the entire range.", "operationId": "handle_get_active_users_metrics_v3_enterprise_metrics_active_users_get", "parameters": [ { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "title": "Org Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "min_sessions", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Sessions" } }, { "name": "min_searches", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Searches" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveUserMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/ip-access-list": { "get": { "tags": [ "ip-access-list" ], "summary": "Get IP Access List", "operationId": "handle_get_ip_access_list_v3_enterprise_ip_access_list_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAccessListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "ip-access-list" ], "summary": "Replace IP Access List", "operationId": "handle_replace_ip_access_list_v3_enterprise_ip_access_list_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAccessListReplaceRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAccessListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "ip-access-list" ], "summary": "Add IPs to IP Access List", "operationId": "handle_add_ip_access_list_v3_enterprise_ip_access_list_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAccessListAddRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAccessListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "ip-access-list" ], "summary": "Clear IP Access List", "operationId": "handle_clear_ip_access_list_v3_enterprise_ip_access_list_delete", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAccessListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/git-providers/connections": { "get": { "tags": [ "git_connections" ], "summary": "List Git Connections", "operationId": "handle_get_git_connections_v3_enterprise_git_providers_connections_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_GitConnectionResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/git-providers/connections/{connection_id}/repositories": { "get": { "tags": [ "git_connections" ], "summary": "List repositories for a git connection", "operationId": "handle_list_git_connection_repositories_v3_enterprise_git_providers_connections__connection_id__repositories_get", "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Connection Id" } }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 100, "title": "First" } }, { "name": "filter_name", "in": "query", "required": false, "schema": { "title": "Filter Name", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_GitConnectionRepositoryResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/git-providers/permissions": { "get": { "tags": [ "git_permissions" ], "summary": "List Git Permissions", "description": "List git permissions for the organization.", "operationId": "handle_get_organization_git_permissions_v3_enterprise_organizations__org_id__git_providers_permissions_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_GitPermissionResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "git_permissions" ], "summary": "Create Git Permissions", "operationId": "handle_bulk_create_organization_git_permissions_v3_enterprise_organizations__org_id__git_providers_permissions_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitPermissionBulkCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GitPermissionResponse" }, "title": "Response Handle Bulk Create Organization Git Permissions V3 Enterprise Organizations Org Id Git Providers Permissions Post" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "git_permissions" ], "summary": "Replace Git Permissions", "operationId": "handle_replace_organization_git_permissions_v3_enterprise_organizations__org_id__git_providers_permissions_put", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitPermissionBulkCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GitPermissionResponse" }, "title": "Response Handle Replace Organization Git Permissions V3 Enterprise Organizations Org Id Git Providers Permissions Put" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "git_permissions" ], "summary": "Clear Git Permissions", "operationId": "handle_clear_organization_git_permissions_v3_enterprise_organizations__org_id__git_providers_permissions_delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GitPermissionResponse" }, "title": "Response Handle Clear Organization Git Permissions V3 Enterprise Organizations Org Id Git Providers Permissions Delete" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/git-providers/permissions/{git_permission_id}": { "patch": { "tags": [ "git_permissions" ], "summary": "Update Git Permission", "operationId": "handle_update_organization_git_permission_v3_enterprise_organizations__org_id__git_providers_permissions__git_permission_id__patch", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "git_permission_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Git Permission Id", "example": "git-permission-abc123def456" }, "description": "Git permission ID (prefix: git-permission-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitPermissionUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitPermissionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "git_permissions" ], "summary": "Delete Git Permission", "operationId": "handle_delete_organization_git_permission_v3_enterprise_organizations__org_id__git_providers_permissions__git_permission_id__delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "git_permission_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Git Permission Id", "example": "git-permission-abc123def456" }, "description": "Git permission ID (prefix: git-permission-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitPermissionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/audit-logs": { "get": { "tags": [ "audit_logs" ], "summary": "List Audit Logs", "description": "List audit logs for the enterprise.", "operationId": "handle_get_enterprise_audit_logs_v3_enterprise_audit_logs_get", "parameters": [ { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "desc", "title": "Order", "x-extensible-enum": [ "asc", "desc" ], "description": "Known values: `asc`, `desc`. Additional values may be added in the future." } }, { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "action", "in": "query", "required": false, "schema": { "title": "Action", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_AuditLogResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/audit-logs": { "get": { "tags": [ "audit_logs" ], "summary": "List Organization Audit Logs", "description": "List audit logs for the organization.", "operationId": "handle_get_org_audit_logs_v3_enterprise_organizations__org_id__audit_logs_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "desc", "title": "Order", "x-extensible-enum": [ "asc", "desc" ], "description": "Known values: `asc`, `desc`. Additional values may be added in the future." } }, { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "action", "in": "query", "required": false, "schema": { "title": "Action", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_AuditLogResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/hypervisors": { "get": { "summary": "List Hypervisors", "operationId": "handle_get_hypervisors_v3_enterprise_hypervisors_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "default": "available", "title": "Status", "x-extensible-enum": [ "available", "restarting", "disconnected", "terminated", "draining", "all" ], "description": "Known values: `available`, `restarting`, `disconnected`, `terminated`, `draining`, `all`. Additional values may be added in the future." } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_HypervisorResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations": { "get": { "tags": [ "organizations" ], "summary": "List Organizations", "description": "List organizations in the enterprise.", "operationId": "handle_get_organizations_v3_enterprise_organizations_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_OrganizationResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "organizations" ], "summary": "Create Organization", "description": "Create a new organization in this enterprise", "operationId": "handle_create_organization_v3_enterprise_organizations_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}": { "get": { "tags": [ "organizations" ], "summary": "Get Organization", "description": "Get details for a specific organization in the enterprise.", "operationId": "handle_get_organization_v3_enterprise_organizations__org_id__get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "organizations" ], "summary": "Update Organization", "description": "Update an organization's name and/or ACU limits", "operationId": "handle_update_organization_v3_enterprise_organizations__org_id__patch", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "organizations" ], "summary": "Delete Organization", "description": "Delete an organization from this enterprise", "operationId": "handle_delete_organization_v3_enterprise_organizations__org_id__delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/org-group-limits": { "get": { "tags": [ "org-groups" ], "summary": "Get Org Groups Config", "description": "Get the current organization groups configuration.", "operationId": "get_org_groups_config_v3_enterprise_org_group_limits_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgGroupsConfig" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "org-groups" ], "summary": "Update Org Groups Config", "description": "Update the organization groups configuration.\n\nThis endpoint replaces the entire org groups configuration with the provided config.\n- Groups not in the request will be deleted\n- Groups in the request will be created or updated to match the config", "operationId": "update_org_groups_config_v3_enterprise_org_group_limits_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgGroupsConfig" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgGroupsConfig" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/roles": { "get": { "tags": [ "roles" ], "summary": "List Roles", "description": "Get roles for this enterprise", "operationId": "handle_get_roles_v3_enterprise_roles_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_Role_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/members/idp-groups": { "get": { "tags": [ "idp_groups" ], "summary": "List IDP Groups", "operationId": "handle_list_enterprise_idp_groups_v3_enterprise_members_idp_groups_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_IdpGroup_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/members/idp-groups/{idp_group_name}": { "get": { "tags": [ "idp_groups" ], "summary": "Get IDP Group", "operationId": "handle_get_enterprise_idp_group_v3_enterprise_members_idp_groups__idp_group_name__get", "parameters": [ { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroup" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "idp_groups" ], "summary": "Assign IDP Group", "operationId": "handle_assign_enterprise_idp_group_role_v3_enterprise_members_idp_groups__idp_group_name__post", "parameters": [ { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroupUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroup" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "idp_groups" ], "summary": "Update IDP Group", "operationId": "handle_update_enterprise_idp_group_role_v3_enterprise_members_idp_groups__idp_group_name__patch", "parameters": [ { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroupUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroup" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "idp_groups" ], "summary": "Delete IDP Group", "operationId": "handle_remove_enterprise_idp_group_v3_enterprise_members_idp_groups__idp_group_name__delete", "parameters": [ { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroup" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/members/idp-groups": { "get": { "tags": [ "idp_groups" ], "summary": "List Organization IDP Groups", "operationId": "handle_list_organization_idp_groups_v3_enterprise_organizations__org_id__members_idp_groups_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_IdpGroup_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/members/idp-groups/{idp_group_name}": { "get": { "tags": [ "idp_groups" ], "summary": "Get Organization IDP Group", "operationId": "handle_get_organization_idp_group_v3_enterprise_organizations__org_id__members_idp_groups__idp_group_name__get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroup" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "idp_groups" ], "summary": "Assign Organization IDP Group", "operationId": "handle_assign_organization_idp_group_role_v3_enterprise_organizations__org_id__members_idp_groups__idp_group_name__post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroupUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroup" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "idp_groups" ], "summary": "Update Organization IDP Group", "operationId": "handle_update_organization_idp_group_role_v3_enterprise_organizations__org_id__members_idp_groups__idp_group_name__patch", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroupUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroup" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "idp_groups" ], "summary": "Delete Organization IDP Group", "description": "Remove idp_group from the organization.", "operationId": "handle_remove_organization_idp_group_v3_enterprise_organizations__org_id__members_idp_groups__idp_group_name__delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroup" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/members/users": { "get": { "tags": [ "users" ], "summary": "List Users", "operationId": "handle_list_enterprise_users_v3_enterprise_members_users_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "email", "in": "query", "required": false, "schema": { "description": "Filter by exact email address", "title": "Email", "nullable": true, "type": "string" }, "description": "Filter by exact email address" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_User_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "users" ], "summary": "Invite Users", "operationId": "handle_bulk_invite_enterprise_users_v3_enterprise_members_users_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserBulkCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" }, "title": "Response Handle Bulk Invite Enterprise Users V3 Enterprise Members Users Post" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/members/idp-users": { "get": { "tags": [ "users" ], "summary": "List IDP Group Users", "description": "List users whose enterprise membership is derived from IDP group assignments.", "operationId": "handle_list_enterprise_idp_users_v3_enterprise_members_idp_users_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "email", "in": "query", "required": false, "schema": { "description": "Filter by exact email address", "title": "Email", "nullable": true, "type": "string" }, "description": "Filter by exact email address" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_IdpGroupUser_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/members/users/{user_id}": { "get": { "tags": [ "users" ], "summary": "Get User", "description": "Get a user by ID. Returns both direct and IDP-group-derived role assignments.", "operationId": "handle_get_enterprise_user_v3_enterprise_members_users__user_id__get", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithIdpRoles" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "users" ], "summary": "Update User", "operationId": "handle_update_enterprise_user_role_v3_enterprise_members_users__user_id__patch", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "users" ], "summary": "Delete User", "operationId": "handle_remove_enterprise_user_v3_enterprise_members_users__user_id__delete", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/members/users/{user_id}": { "post": { "tags": [ "users" ], "summary": "Assign Organization User", "operationId": "handle_assign_organization_user_role_v3_enterprise_organizations__org_id__members_users__user_id__post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "users" ], "summary": "Update Organization User", "operationId": "handle_update_organization_user_role_v3_enterprise_organizations__org_id__members_users__user_id__patch", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "users" ], "summary": "Delete Organization User", "operationId": "handle_remove_organization_user_v3_enterprise_organizations__org_id__members_users__user_id__delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/members/service-users": { "get": { "tags": [ "service_users" ], "summary": "List Service Users", "description": "List service users in the enterprise.", "operationId": "handle_list_enterprise_service_users_v3_enterprise_members_service_users_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "include_inactive", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include inactive service users (expired or removed).", "default": false, "title": "Include Inactive" }, "description": "Include inactive service users (expired or removed)." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_ServiceUser_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/members/service-users/{service_user_id}": { "get": { "tags": [ "service_users" ], "summary": "Get Service User", "description": "Get a service user by ID.", "operationId": "handle_get_enterprise_service_user_v3_enterprise_members_service_users__service_user_id__get", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUser" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "service_users" ], "summary": "Assign Service User", "description": "Assign enterprise role to service user.", "operationId": "handle_assign_enterprise_service_user_role_v3_enterprise_members_service_users__service_user_id__post", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUserUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUser" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "service_users" ], "summary": "Update Service User", "description": "Update enterprise role for service user.", "operationId": "handle_update_enterprise_service_user_role_v3_enterprise_members_service_users__service_user_id__patch", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUserUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUser" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "service_users" ], "summary": "Delete Service User", "operationId": "handle_remove_enterprise_service_user_v3_enterprise_members_service_users__service_user_id__delete", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUser" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/members/service-users": { "get": { "tags": [ "service_users" ], "summary": "List Organization Service Users", "description": "List service users in the organization.", "operationId": "handle_list_organization_service_users_v3_enterprise_organizations__org_id__members_service_users_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "include_inactive", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include inactive service users (expired or removed).", "default": false, "title": "Include Inactive" }, "description": "Include inactive service users (expired or removed)." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_ServiceUser_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/members/service-users/{service_user_id}": { "post": { "tags": [ "service_users" ], "summary": "Assign Organization Service User", "description": "Assign organization role to service user.", "operationId": "handle_assign_organization_service_user_role_v3_enterprise_organizations__org_id__members_service_users__service_user_id__post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUserUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUser" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "service_users" ], "summary": "Update Organization Service User", "description": "Update organization role for service user.", "operationId": "handle_update_organization_service_user_role_v3_enterprise_organizations__org_id__members_service_users__service_user_id__patch", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUserUpdateRoleRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUser" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "service_users" ], "summary": "Delete Organization Service User", "description": "Remove service user from the organization.", "operationId": "handle_remove_organization_service_user_v3_enterprise_organizations__org_id__members_service_users__service_user_id__delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceUser" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/tags": { "get": { "tags": [ "organization-tags" ], "summary": "Get Organization Allowed Tags", "description": "Get the allowed session tags for an organization.", "operationId": "handle_get_organization_allowed_tags_v3_enterprise_organizations__org_id__tags_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "organization-tags" ], "summary": "Append Organization Tags", "description": "Append tags to the allowed session tags for an organization.", "operationId": "handle_append_organization_allowed_tags_v3_enterprise_organizations__org_id__tags_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "organization-tags" ], "summary": "Replace Organization Allowed Tags", "description": "Replace the full set of allowed session tags for an organization.", "operationId": "handle_replace_organization_allowed_tags_v3_enterprise_organizations__org_id__tags_put", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "organization-tags" ], "summary": "Clear Organization Tags", "description": "Clear all allowed session tags for an organization.", "operationId": "clear_organization_allowed_tags_v3_enterprise_organizations__org_id__tags_delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/tags/default": { "put": { "tags": [ "organization-tags" ], "summary": "Set Organization Default Tag", "description": "Set the default tag for an organization. The tag must exist in the allowed tags list.", "operationId": "set_organization_default_tag_v3_enterprise_organizations__org_id__tags_default_put", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultTagRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultTagResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "organization-tags" ], "summary": "Get Organization Default Tag", "description": "Get the current default tag for an organization.", "operationId": "get_organization_default_tag_v3_enterprise_organizations__org_id__tags_default_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultTagResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "organization-tags" ], "summary": "Clear Organization Default Tag", "description": "Clear the default tag for an organization.", "operationId": "clear_organization_default_tag_v3_enterprise_organizations__org_id__tags_default_delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultTagResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/tags/{tag}": { "delete": { "tags": [ "organization-tags" ], "summary": "Remove Organization Tag", "description": "Remove a single tag from the allowed session tags for an organization.", "operationId": "remove_organization_allowed_tag_v3_enterprise_organizations__org_id__tags__tag__delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "tag", "in": "path", "required": true, "schema": { "type": "string", "title": "Tag" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/idp-groups": { "get": { "tags": [ "idp_groups" ], "summary": "List Account IDP Groups", "description": "List IDP groups registered with this enterprise.", "operationId": "handle_list_account_idp_groups_v3_enterprise_idp_groups_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_IdpGroupResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "idp_groups" ], "summary": "Register Account IDP Groups", "description": "Bulk create IDP groups for this enterprise. Existing groups are ignored.", "operationId": "handle_bulk_register_account_idp_groups_v3_enterprise_idp_groups_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroupsBulkCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IdpGroupResponse" }, "title": "Response Handle Bulk Register Account Idp Groups V3 Enterprise Idp Groups Post" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/idp-groups/{idp_group_name}": { "delete": { "tags": [ "idp_groups" ], "summary": "Delete Account IDP Group", "description": "Remove a registered IDP group from this enterprise.", "operationId": "handle_delete_account_idp_group_v3_enterprise_idp_groups__idp_group_name__delete", "parameters": [ { "name": "idp_group_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Idp Group Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdpGroupResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/knowledge/notes": { "get": { "tags": [ "notes" ], "summary": "List all notes.", "operationId": "handle_list_notes_v3_enterprise_knowledge_notes_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "access_type", "in": "query", "required": false, "schema": { "title": "Access Type", "nullable": true, "type": "string", "x-extensible-enum": [ "org", "enterprise" ], "description": "Known values: `org`, `enterprise`. Additional values may be added in the future." } }, { "name": "search", "in": "query", "required": false, "schema": { "title": "Search", "nullable": true, "type": "string" } }, { "name": "folder_path", "in": "query", "required": false, "schema": { "title": "Folder Path", "nullable": true, "type": "string" } }, { "name": "pinned_repo", "in": "query", "required": false, "schema": { "title": "Pinned Repo", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_KnowledgeNoteResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "notes" ], "summary": "Create an enterprise-level note", "operationId": "handle_create_note_v3_enterprise_knowledge_notes_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/knowledge/folders": { "get": { "tags": [ "notes" ], "summary": "Get knowledge folder structure with note counts.", "description": "Return the full folder tree with per-folder note counts.", "operationId": "handle_list_folders_v3_enterprise_knowledge_folders_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderTreeResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/knowledge/notes/{note_id}": { "get": { "tags": [ "notes" ], "summary": "Get a note by ID", "description": "Get a note by ID.", "operationId": "handle_get_note_v3_enterprise_knowledge_notes__note_id__get", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id", "example": "note-abc123def456" }, "description": "Knowledge note ID (prefix: note-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "notes" ], "summary": "Update a note", "operationId": "handle_update_note_v3_enterprise_knowledge_notes__note_id__put", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id", "example": "note-abc123def456" }, "description": "Knowledge note ID (prefix: note-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "notes" ], "summary": "Delete a note", "operationId": "handle_delete_note_v3_enterprise_knowledge_notes__note_id__delete", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id", "example": "note-abc123def456" }, "description": "Knowledge note ID (prefix: note-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/playbooks": { "get": { "tags": [ "playbooks" ], "summary": "List all playbooks.", "operationId": "handle_list_playbooks_v3_enterprise_playbooks_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_PlaybookResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "playbooks" ], "summary": "Create an enterprise-level playbook", "operationId": "handle_create_playbook_v3_enterprise_playbooks_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/playbooks/{playbook_id}": { "get": { "tags": [ "playbooks" ], "summary": "Get a playbook by ID.", "description": "Get a specific playbook by ID.", "operationId": "handle_get_playbook_v3_enterprise_playbooks__playbook_id__get", "parameters": [ { "name": "playbook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Playbook Id", "example": "playbook-abc123def456" }, "description": "Playbook ID (prefix: playbook-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "playbooks" ], "summary": "Update a playbook", "operationId": "handle_update_playbook_v3_enterprise_playbooks__playbook_id__put", "parameters": [ { "name": "playbook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Playbook Id", "example": "playbook-abc123def456" }, "description": "Playbook ID (prefix: playbook-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "playbooks" ], "summary": "Delete a playbook", "operationId": "handle_delete_playbook_v3_enterprise_playbooks__playbook_id__delete", "parameters": [ { "name": "playbook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Playbook Id", "example": "playbook-abc123def456" }, "description": "Playbook ID (prefix: playbook-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/pr-reviews": { "post": { "tags": [ "pr-reviews" ], "summary": "Trigger Devin Review", "description": "Trigger a Devin Review for a pull/merge request.\n\nCreates a database record that will be picked up by the review\nworker pool. Always fetches the latest commit from the PR.", "operationId": "handle_create_pr_review_v3_enterprise_pr_reviews_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrReviewCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrReviewResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "pr-reviews" ], "summary": "Get latest Devin Review status", "description": "Return the latest Devin Review for a PR scoped to the enterprise.\n\nThe owning organization is resolved server-side from ``pr_url`` —\nthe same way as the trigger endpoint. When ``commit_sha`` is\nomitted, the PR's current head commit is fetched from the provider\nand used. Returns ``404`` when no review exists for the resolved\ncommit.", "operationId": "handle_get_pr_review_status_v3_enterprise_pr_reviews_get", "parameters": [ { "name": "pr_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Full URL of the pull/merge request to look up (e.g. `https://github.com/owner/repo/pull/123`).", "title": "Pr Url", "example": "https://github.com/owner/repo/pull/123" }, "description": "Full URL of the pull/merge request to look up (e.g. `https://github.com/owner/repo/pull/123`)." }, { "name": "commit_sha", "in": "query", "required": false, "schema": { "description": "Commit SHA to look up (full or short prefix). Defaults to the PR's current head commit when omitted.", "title": "Commit Sha", "nullable": true, "type": "string", "example": "abc123def4567890abc123def4567890abc123de" }, "description": "Commit SHA to look up (full or short prefix). Defaults to the PR's current head commit when omitted." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrReviewResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/sessions/insights": { "get": { "tags": [ "sessions" ], "summary": "List sessions with insights", "description": "List sessions with detailed insights including message counts,\nsession size classification, and AI-generated analysis.", "operationId": "handle_get_account_sessions_insights_v3_enterprise_sessions_insights_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "session_ids", "in": "query", "required": false, "schema": { "title": "Session Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "created_after", "in": "query", "required": false, "schema": { "title": "Created After", "nullable": true, "type": "integer" } }, { "name": "created_before", "in": "query", "required": false, "schema": { "title": "Created Before", "nullable": true, "type": "integer" } }, { "name": "updated_after", "in": "query", "required": false, "schema": { "title": "Updated After", "nullable": true, "type": "integer" } }, { "name": "updated_before", "in": "query", "required": false, "schema": { "title": "Updated Before", "nullable": true, "type": "integer" } }, { "name": "tags", "in": "query", "required": false, "schema": { "title": "Tags", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "playbook_id", "in": "query", "required": false, "schema": { "title": "Playbook Id", "nullable": true, "type": "string" } }, { "name": "origins", "in": "query", "required": false, "schema": { "title": "Origins", "nullable": true, "type": "array", "items": { "type": "string", "x-extensible-enum": [ "webapp", "slack", "teams", "api", "linear", "jira", "automation", "cli", "desktop", "code_scan", "other" ], "description": "Known values: `webapp`, `slack`, `teams`, `api`, `linear`, `jira`, `automation`, `cli`, `desktop`, `code_scan`, `other`. Additional values may be added in the future." } } }, { "name": "schedule_id", "in": "query", "required": false, "schema": { "title": "Schedule Id", "nullable": true, "type": "string" } }, { "name": "user_ids", "in": "query", "required": false, "schema": { "title": "User Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "service_user_ids", "in": "query", "required": false, "schema": { "title": "Service User Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "repo_names", "in": "query", "required": false, "schema": { "description": "Filter by repository names (e.g., 'owner/repo')", "title": "Repo Names", "nullable": true, "type": "array", "items": { "type": "string" } }, "description": "Filter by repository names (e.g., 'owner/repo')" }, { "name": "category", "in": "query", "required": false, "schema": { "title": "Category", "nullable": true, "type": "string", "x-extensible-enum": [ "bug_fixing", "ci_cd_and_devops", "code_quality_and_security", "code_review", "code_review_and_analysis", "data_and_automation", "documentation_and_content", "feature_development", "migrations_and_upgrades", "other", "production_investigation", "refactoring_and_optimization", "research_and_exploration", "security", "unit_test_generation" ], "description": "Known values: `bug_fixing`, `ci_cd_and_devops`, `code_quality_and_security`, `code_review`, `code_review_and_analysis`, `data_and_automation`, `documentation_and_content`, `feature_development`, `migrations_and_upgrades`, `other`, `production_investigation`, `refactoring_and_optimization`, `research_and_exploration`, `security`, `unit_test_generation`. Additional values may be added in the future." } }, { "name": "is_archived", "in": "query", "required": false, "schema": { "title": "Is Archived", "nullable": true, "type": "boolean" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "title": "Org Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "include_deleted_orgs", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Deleted Orgs" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SessionInsightsResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/sessions/{devin_id}": { "get": { "tags": [ "sessions" ], "summary": "Get session details", "description": "Get details of a specific session.", "operationId": "handle_get_account_session_v3_enterprise_sessions__devin_id__get", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "org_id", "in": "query", "required": false, "schema": { "title": "Org Id", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/sessions/{devin_id}/insights": { "get": { "tags": [ "sessions" ], "summary": "Get session insights", "description": "Get detailed insights for a specific session, including message counts,\nsession size classification, and AI-generated analysis.", "operationId": "handle_get_account_session_insights_v3_enterprise_sessions__devin_id__insights_get", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "org_id", "in": "query", "required": false, "schema": { "title": "Org Id", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionInsightsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/sessions/{devin_id}/insights/generate": { "post": { "tags": [ "sessions" ], "summary": "Generate session insights", "description": "Trigger on-demand generation of session insights.\n\nReturns ``already_exists`` if insights have already been generated.\nOtherwise kicks off generation in the background. Poll the\nGET insights endpoint to retrieve results once generation completes.", "operationId": "handle_generate_account_session_insights_v3_enterprise_sessions__devin_id__insights_generate_post", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "org_id", "in": "query", "required": false, "schema": { "title": "Org Id", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionInsightsGenerateResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/sessions": { "get": { "tags": [ "sessions" ], "summary": "List sessions for account", "description": "List all sessions across the enterprise.", "operationId": "handle_get_account_sessions_v3_enterprise_sessions_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "session_ids", "in": "query", "required": false, "schema": { "title": "Session Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "created_after", "in": "query", "required": false, "schema": { "title": "Created After", "nullable": true, "type": "integer" } }, { "name": "created_before", "in": "query", "required": false, "schema": { "title": "Created Before", "nullable": true, "type": "integer" } }, { "name": "updated_after", "in": "query", "required": false, "schema": { "title": "Updated After", "nullable": true, "type": "integer" } }, { "name": "updated_before", "in": "query", "required": false, "schema": { "title": "Updated Before", "nullable": true, "type": "integer" } }, { "name": "tags", "in": "query", "required": false, "schema": { "title": "Tags", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "playbook_id", "in": "query", "required": false, "schema": { "title": "Playbook Id", "nullable": true, "type": "string" } }, { "name": "origins", "in": "query", "required": false, "schema": { "title": "Origins", "nullable": true, "type": "array", "items": { "type": "string", "x-extensible-enum": [ "webapp", "slack", "teams", "api", "linear", "jira", "automation", "cli", "desktop", "code_scan", "other" ], "description": "Known values: `webapp`, `slack`, `teams`, `api`, `linear`, `jira`, `automation`, `cli`, `desktop`, `code_scan`, `other`. Additional values may be added in the future." } } }, { "name": "schedule_id", "in": "query", "required": false, "schema": { "title": "Schedule Id", "nullable": true, "type": "string" } }, { "name": "user_ids", "in": "query", "required": false, "schema": { "title": "User Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "service_user_ids", "in": "query", "required": false, "schema": { "title": "Service User Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "repo_names", "in": "query", "required": false, "schema": { "description": "Filter by repository names (e.g., 'owner/repo')", "title": "Repo Names", "nullable": true, "type": "array", "items": { "type": "string" } }, "description": "Filter by repository names (e.g., 'owner/repo')" }, { "name": "category", "in": "query", "required": false, "schema": { "title": "Category", "nullable": true, "type": "string", "x-extensible-enum": [ "bug_fixing", "ci_cd_and_devops", "code_quality_and_security", "code_review", "code_review_and_analysis", "data_and_automation", "documentation_and_content", "feature_development", "migrations_and_upgrades", "other", "production_investigation", "refactoring_and_optimization", "research_and_exploration", "security", "unit_test_generation" ], "description": "Known values: `bug_fixing`, `ci_cd_and_devops`, `code_quality_and_security`, `code_review`, `code_review_and_analysis`, `data_and_automation`, `documentation_and_content`, `feature_development`, `migrations_and_upgrades`, `other`, `production_investigation`, `refactoring_and_optimization`, `research_and_exploration`, `security`, `unit_test_generation`. Additional values may be added in the future." } }, { "name": "is_archived", "in": "query", "required": false, "schema": { "title": "Is Archived", "nullable": true, "type": "boolean" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "title": "Org Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "include_deleted_orgs", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Deleted Orgs" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SessionResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/sessions/{devin_id}/attachments": { "get": { "tags": [ "sessions" ], "summary": "List session attachments", "description": "List all attachments for a session.", "operationId": "handle_get_account_session_attachments_v3_enterprise_sessions__devin_id__attachments_get", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "org_id", "in": "query", "required": false, "schema": { "title": "Org Id", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionAttachment" }, "title": "Response Handle Get Account Session Attachments V3 Enterprise Sessions Devin Id Attachments Get" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/sessions/{devin_id}/tags": { "get": { "tags": [ "sessions" ], "summary": "Get session tags", "description": "Get the tags for a specific session.", "operationId": "handle_get_account_session_tags_v3_enterprise_sessions__devin_id__tags_get", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "org_id", "in": "query", "required": false, "schema": { "title": "Org Id", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "sessions" ], "summary": "Replace session tags", "description": "Replace all tags on a session.", "operationId": "handle_replace_account_session_tags_v3_enterprise_sessions__devin_id__tags_put", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "org_id", "in": "query", "required": false, "schema": { "title": "Org Id", "nullable": true, "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "sessions" ], "summary": "Append session tags", "description": "Append tags to a session (deduplicating with existing tags).", "operationId": "handle_append_account_session_tags_v3_enterprise_sessions__devin_id__tags_post", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "org_id", "in": "query", "required": false, "schema": { "title": "Org Id", "nullable": true, "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/sessions/{devin_id}/messages": { "get": { "tags": [ "sessions" ], "summary": "List session messages", "description": "List all messages for a session with cursor-based pagination, ordered chronologically.", "operationId": "handle_get_account_session_messages_v3_enterprise_sessions__devin_id__messages_get", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "qs", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/CursorPaginationParams" } }, { "name": "org_id", "in": "query", "required": false, "schema": { "title": "Org Id", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SessionMessage_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "sessions" ], "summary": "Send a message to a session", "description": "Send a message to an active session. The session will be automatically resumed if suspended.", "operationId": "handle_post_account_session_message_v3_enterprise_sessions__devin_id__messages_post", "parameters": [ { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "org_id", "in": "query", "required": false, "schema": { "title": "Org Id", "nullable": true, "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionMessageCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/queue": { "get": { "tags": [ "queue" ], "summary": "Get Queue", "description": "Get the queue status for an enterprise.\n\nReturns the total number of queued sessions (status: new, resuming, claimed)\nand a status indicator (normal/elevated/high).\n\nThis endpoint is useful for enterprise admins to monitor queue health and\nset up alerts for capacity issues.", "operationId": "get_queue_v3_enterprise_queue_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/members/users": { "get": { "tags": [ "users" ], "summary": "List Organization Users", "operationId": "handle_list_organization_users_v3_enterprise_organizations__org_id__members_users_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "email", "in": "query", "required": false, "schema": { "description": "Filter by exact email address", "title": "Email", "nullable": true, "type": "string" }, "description": "Filter by exact email address" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_User_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/members/idp-users": { "get": { "tags": [ "users" ], "summary": "List Organization IDP Group Users", "description": "List users whose organization membership is derived from IDP group assignments.", "operationId": "handle_list_organization_idp_users_v3_enterprise_organizations__org_id__members_idp_users_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "email", "in": "query", "required": false, "schema": { "description": "Filter by exact email address", "title": "Email", "nullable": true, "type": "string" }, "description": "Filter by exact email address" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_IdpGroupUser_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/code-scans/metrics": { "get": { "tags": [ "code-scans" ], "summary": "Get Code Scan Metrics", "description": "Get aggregated code scan metrics for the enterprise account.\n\nReturns scan, finding, and remediation-PR metrics for code scans created\nwithin the specified time range, optionally filtered to specific\norganizations.", "operationId": "handle_get_code_scan_metrics_v3_enterprise_code_scans_metrics_get", "parameters": [ { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "title": "Org Ids", "nullable": true, "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/code-scans/scans": { "get": { "tags": [ "code-scans" ], "summary": "List Code Scans", "description": "List code scans for the enterprise account.\n\nScans are returned newest first. Optionally filter by ``org_ids``,\n``repo_name``, and creation time (``time_after`` / ``time_before``);\nresults are paginated with an opaque cursor (``after`` / ``first``).", "operationId": "handle_list_code_scans_v3_enterprise_code_scans_scans_get", "parameters": [ { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "repo_name", "in": "query", "required": false, "schema": { "description": "Filter to scans that scanned this repository. Matches multi-repo scans even when the repository is not the scan's primary repo, so returned items may report a different repo_name.", "title": "Repo Name", "nullable": true, "type": "string" }, "description": "Filter to scans that scanned this repository. Matches multi-repo scans even when the repository is not the scan's primary repo, so returned items may report a different repo_name." }, { "name": "org_ids", "in": "query", "required": false, "schema": { "description": "Filter to scans in these organizations.", "title": "Org Ids", "nullable": true, "type": "array", "items": { "type": "string" } }, "description": "Filter to scans in these organizations." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_CodeScanResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/code-scans/findings": { "get": { "tags": [ "code-scans" ], "summary": "List Code Scan Findings", "description": "List code scan findings for the enterprise account.\n\nFindings are returned newest first. Optionally filter by ``org_ids``,\n``scan_id``, ``repo_name``, ``severity``, and ``status`` (``severity`` and\n``status`` accept multiple values); results are paginated with an opaque\ncursor (``after`` / ``first``).", "operationId": "handle_list_code_scan_findings_v3_enterprise_code_scans_findings_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "scan_id", "in": "query", "required": false, "schema": { "description": "Filter to findings produced by this scan.", "title": "Scan Id", "nullable": true, "type": "string" }, "description": "Filter to findings produced by this scan." }, { "name": "repo_name", "in": "query", "required": false, "schema": { "description": "Filter to findings reported in this repository.", "title": "Repo Name", "nullable": true, "type": "string" }, "description": "Filter to findings reported in this repository." }, { "name": "severity", "in": "query", "required": false, "schema": { "description": "Filter to findings with any of these severities (critical, high, medium, low).", "title": "Severity", "nullable": true, "type": "array", "items": { "type": "string", "x-extensible-enum": [ "critical", "high", "medium", "low" ], "description": "Known values: `critical`, `high`, `medium`, `low`. Additional values may be added in the future." } }, "description": "Filter to findings with any of these severities (critical, high, medium, low)." }, { "name": "status", "in": "query", "required": false, "schema": { "description": "Filter to findings with any of these statuses (open, dismissed, resolved).", "title": "Status", "nullable": true, "type": "array", "items": { "type": "string", "x-extensible-enum": [ "open", "dismissed", "resolved" ], "description": "Known values: `open`, `dismissed`, `resolved`. Additional values may be added in the future." } }, "description": "Filter to findings with any of these statuses (open, dismissed, resolved)." }, { "name": "org_ids", "in": "query", "required": false, "schema": { "description": "Filter to findings in these organizations.", "title": "Org Ids", "nullable": true, "type": "array", "items": { "type": "string" } }, "description": "Filter to findings in these organizations." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_CodeScanFindingResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/code-scans/profiles": { "get": { "tags": [ "code-scans" ], "summary": "List Code Scan Profiles", "description": "List code scan profiles for the enterprise account.\n\nReturns profile summaries (without guidance) newest first, including both\norg-owned and account-shared profiles. Optionally filter by ``org_ids``;\nresults are paginated with an opaque cursor (``after`` / ``first``).", "operationId": "handle_list_code_scan_profiles_v3_enterprise_code_scans_profiles_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "org_ids", "in": "query", "required": false, "schema": { "description": "Only return profiles visible to these organizations. Defaults to all organizations in the account.", "title": "Org Ids", "nullable": true, "type": "array", "items": { "type": "string" } }, "description": "Only return profiles visible to these organizations. Defaults to all organizations in the account." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_CodeScanProfileSummaryResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/code-scans/profiles/{profile_id}": { "get": { "tags": [ "code-scans" ], "summary": "Get Code Scan Profile", "description": "Get a code scan profile by ID.\n\nReturns the profile's metadata, visibility (org-owned or shared\naccount-wide), and all of its guidance fields. Returns ``404`` when the\nprofile does not exist or is not visible to the enterprise account.", "operationId": "handle_get_code_scan_profile_v3_enterprise_code_scans_profiles__profile_id__get", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Profile Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanProfileDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans/{scan_id}/findings/{finding_id}/remediate": { "post": { "tags": [ "code-scans" ], "summary": "Remediate Code Scan Finding", "description": "Launch a Devin session to remediate a code scan finding.\n\nThe session analyzes the vulnerable code, implements a fix, and opens a\npull request. The session is attributed to the calling principal (the\nservice user or PAT that made the request). Returns ``409`` if the finding\nalready has a remediation session.", "operationId": "handle_remediate_code_scan_finding_v3_enterprise_organizations__org_id__code_scans__scan_id__findings__finding_id__remediate_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "finding_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Finding Id" } } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemediateFindingResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/enterprise/organizations/{org_id}/code-scans": { "post": { "tags": [ "code-scans" ], "summary": "Start Code Scan", "description": "Start a new code scan on a repository in an organization.\n\nThe scan is enqueued and launched asynchronously by the scan dispatcher.\nThe scan is attributed to the calling principal (the service user or PAT\nthat made the request). Returns ``409`` when the organization's scan\nbacklog is at capacity.", "operationId": "handle_start_code_scan_v3_enterprise_organizations__org_id__code_scans_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/service-users/{service_user_id}/api-keys": { "post": { "tags": [ "service_user_api_keys" ], "summary": "Create API key for service user", "description": "Create a new API key for a service user.\n\nThe caller must have ManageAccountServiceUsers permission.", "operationId": "handle_create_service_user_api_key_v3beta1_enterprise_service_users__service_user_id__api_keys_post", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyWithTokenResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "service_user_api_keys" ], "summary": "List API keys for service user", "description": "List API keys for a service user, optionally filtered by status.", "operationId": "handle_list_service_user_api_keys_v3beta1_enterprise_service_users__service_user_id__api_keys_get", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "default": "all", "title": "Status", "x-extensible-enum": [ "active", "revoked", "expired", "all" ], "description": "Known values: `active`, `revoked`, `expired`, `all`. Additional values may be added in the future." } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_ApiKeyResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/service-users/{service_user_id}/api-keys/{api_key_id}": { "delete": { "tags": [ "service_user_api_keys" ], "summary": "Revoke API key for service user", "description": "Revoke an API key for a service user.\n\nReturns 404 if the key is not found, 409 if already revoked.", "operationId": "handle_revoke_service_user_api_key_v3beta1_enterprise_service_users__service_user_id__api_keys__api_key_id__delete", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" }, { "name": "api_key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Api Key Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/service-users/{service_user_id}/api-keys/{api_key_id}/rotate": { "post": { "tags": [ "service_user_api_keys" ], "summary": "Rotate API key for service user", "description": "Rotate an API key for a service user.\n\nCreates a new key. By default revokes the old key; set revoke_current=false\nfor graceful rollover where both keys remain active temporarily.\nReturns 404 if the key is not found, 400 if the key is not active.", "operationId": "handle_rotate_service_user_api_key_v3beta1_enterprise_service_users__service_user_id__api_keys__api_key_id__rotate_post", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" }, { "name": "api_key_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Api Key Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RotateApiKeyRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyWithTokenResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/guardrail-violations": { "get": { "tags": [ "guardrail_violations" ], "summary": "List Guardrail Violations", "description": "List guardrail violations across the enterprise.", "operationId": "handle_get_enterprise_guardrail_violations_v3beta1_enterprise_guardrail_violations_get", "parameters": [ { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "desc", "title": "Order", "x-extensible-enum": [ "asc", "desc" ], "description": "Known values: `asc`, `desc`. Additional values may be added in the future." } }, { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "session_id", "in": "query", "required": false, "schema": { "title": "Session Id", "nullable": true, "type": "string" } }, { "name": "guardrail_id", "in": "query", "required": false, "schema": { "title": "Guardrail Id", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_GuardrailViolationResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/organizations/{org_id}/guardrail-violations": { "get": { "tags": [ "guardrail_violations" ], "summary": "List Organization Guardrail Violations", "description": "List guardrail violations for a specific organization.", "operationId": "handle_get_org_guardrail_violations_v3beta1_enterprise_organizations__org_id__guardrail_violations_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "desc", "title": "Order", "x-extensible-enum": [ "asc", "desc" ], "description": "Known values: `asc`, `desc`. Additional values may be added in the future." } }, { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "session_id", "in": "query", "required": false, "schema": { "title": "Session Id", "nullable": true, "type": "string" } }, { "name": "guardrail_id", "in": "query", "required": false, "schema": { "title": "Guardrail Id", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_GuardrailViolationResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/snapshot-setup/blueprints": { "get": { "tags": [ "snapshot_setup" ], "summary": "List enterprise-tier blueprints", "operationId": "list_enterprise_blueprints_v3beta1_enterprise_snapshot_setup_blueprints_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintList" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "snapshot_setup" ], "summary": "Create the enterprise-tier blueprint", "description": "Create the single enterprise-tier blueprint.\n\nReturns 409 if a blueprint already exists for this enterprise.", "operationId": "create_enterprise_blueprint_endpoint_v3beta1_enterprise_snapshot_setup_blueprints_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEnterpriseBlueprintBody" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blueprint" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/snapshot-setup/blueprints/{blueprint_id}": { "get": { "tags": [ "snapshot_setup" ], "summary": "Get the enterprise blueprint", "operationId": "get_enterprise_blueprint_endpoint_v3beta1_enterprise_snapshot_setup_blueprints__blueprint_id__get", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blueprint" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "snapshot_setup" ], "summary": "Replace the enterprise blueprint's YAML contents", "operationId": "update_enterprise_blueprint_endpoint_v3beta1_enterprise_snapshot_setup_blueprints__blueprint_id__put", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBlueprintContentsBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blueprint" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "snapshot_setup" ], "summary": "Delete the enterprise blueprint (soft-delete)", "operationId": "delete_enterprise_blueprint_endpoint_v3beta1_enterprise_snapshot_setup_blueprints__blueprint_id__delete", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/snapshot-setup/blueprints/{blueprint_id}/contents": { "get": { "tags": [ "snapshot_setup" ], "summary": "Presigned URL for the enterprise blueprint YAML", "operationId": "get_enterprise_blueprint_contents_v3beta1_enterprise_snapshot_setup_blueprints__blueprint_id__contents_get", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresignedDownload" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/snapshot-setup/blueprints/{blueprint_id}/files": { "get": { "tags": [ "snapshot_setup" ], "summary": "List enterprise blueprint files", "operationId": "list_enterprise_blueprint_files_v3beta1_enterprise_snapshot_setup_blueprints__blueprint_id__files_get", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintFileList" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "snapshot_setup" ], "summary": "Upload an enterprise blueprint file", "description": "Upload a file attachment (env-var substitution material) to the blueprint.\n\nReturns 409 if the derived env-var name collides with another active file.", "operationId": "upload_enterprise_blueprint_file_endpoint_v3beta1_enterprise_snapshot_setup_blueprints__blueprint_id__files_post", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "title": "Name" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_enterprise_blueprint_file_endpoint_v3beta1_enterprise_snapshot_setup_blueprints__blueprint_id__files_post" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintFile" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/enterprise/snapshot-setup/blueprints/{blueprint_id}/files/{file_id}": { "delete": { "tags": [ "snapshot_setup" ], "summary": "Delete an enterprise blueprint file", "operationId": "delete_enterprise_blueprint_file_v3beta1_enterprise_snapshot_setup_blueprints__blueprint_id__files__file_id__delete", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/attachments": { "post": { "tags": [ "attachments" ], "summary": "Upload an attachment", "description": "Upload a file attachment that can be used in Devin sessions.", "operationId": "handle_upload_attachment_v3_organizations__org_id__attachments_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_handle_upload_attachment_v3_organizations__org_id__attachments_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/attachments/{uuid}/{name}": { "get": { "tags": [ "attachments" ], "summary": "Download an attachment", "description": "Download a file attachment.\n\nReturns a 307 redirect: to the IP-enforcing presigned proxy for orgs with an\nIP allowlist, or to a presigned S3 URL otherwise.", "operationId": "handle_download_attachment_v3_organizations__org_id__attachments__uuid___name__get", "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string", "title": "Uuid" } }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string", "title": "Name" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "307": { "description": "Redirect to the attachment download URL" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/knowledge/notes": { "get": { "tags": [ "notes" ], "summary": "List org-level notes", "description": "List notes for an organization.", "operationId": "handle_list_notes_v3_organizations__org_id__knowledge_notes_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "search", "in": "query", "required": false, "schema": { "title": "Search", "nullable": true, "type": "string" } }, { "name": "folder_path", "in": "query", "required": false, "schema": { "title": "Folder Path", "nullable": true, "type": "string" } }, { "name": "pinned_repo", "in": "query", "required": false, "schema": { "title": "Pinned Repo", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_KnowledgeNoteResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "notes" ], "summary": "Create an org-level note", "description": "Create a note for an organization.", "operationId": "handle_create_note_v3_organizations__org_id__knowledge_notes_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/knowledge/folders": { "get": { "tags": [ "notes" ], "summary": "Get knowledge folder structure with note counts.", "description": "Return the full folder tree with per-folder note counts.", "operationId": "handle_list_folders_v3_organizations__org_id__knowledge_folders_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FolderTreeResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/knowledge/notes/{note_id}": { "get": { "tags": [ "notes" ], "summary": "Get an org-level note", "description": "Get a note by ID for an organization.", "operationId": "handle_get_note_v3_organizations__org_id__knowledge_notes__note_id__get", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id", "example": "note-abc123def456" }, "description": "Knowledge note ID (prefix: note-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "notes" ], "summary": "Update an org-level note", "description": "Update a note for an organization.", "operationId": "handle_update_note_v3_organizations__org_id__knowledge_notes__note_id__put", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id", "example": "note-abc123def456" }, "description": "Knowledge note ID (prefix: note-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "notes" ], "summary": "Delete an org-level note", "description": "Delete a note for an organization.", "operationId": "handle_delete_note_v3_organizations__org_id__knowledge_notes__note_id__delete", "parameters": [ { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Note Id", "example": "note-abc123def456" }, "description": "Knowledge note ID (prefix: note-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeNoteResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/playbooks": { "get": { "tags": [ "playbooks" ], "summary": "List org-level playbooks", "description": "List playbooks for an organization.", "operationId": "handle_list_playbooks_v3_organizations__org_id__playbooks_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_PlaybookResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "playbooks" ], "summary": "Create an org-level playbook", "description": "Create a playbook for an organization.", "operationId": "handle_create_playbook_v3_organizations__org_id__playbooks_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/playbooks/{playbook_id}": { "get": { "tags": [ "playbooks" ], "summary": "Get an org-level playbook by ID", "description": "Get a specific playbook by ID for an organization.", "operationId": "handle_get_playbook_v3_organizations__org_id__playbooks__playbook_id__get", "parameters": [ { "name": "playbook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Playbook Id", "example": "playbook-abc123def456" }, "description": "Playbook ID (prefix: playbook-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "playbooks" ], "summary": "Update an org-level playbook", "description": "Update a playbook for an organization.", "operationId": "handle_update_playbook_v3_organizations__org_id__playbooks__playbook_id__put", "parameters": [ { "name": "playbook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Playbook Id", "example": "playbook-abc123def456" }, "description": "Playbook ID (prefix: playbook-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "playbooks" ], "summary": "Delete an org-level playbook", "description": "Delete a playbook for an organization.", "operationId": "handle_delete_playbook_v3_organizations__org_id__playbooks__playbook_id__delete", "parameters": [ { "name": "playbook_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Playbook Id", "example": "playbook-abc123def456" }, "description": "Playbook ID (prefix: playbook-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybookResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/schedules": { "post": { "tags": [ "schedules" ], "summary": "Create schedule", "description": "Create a new scheduled session.", "operationId": "handle_create_schedule_v3_organizations__org_id__schedules_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "schedules" ], "summary": "List schedules", "description": "List all schedules for the organization.", "operationId": "handle_list_schedules_v3_organizations__org_id__schedules_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 200, "title": "Limit" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_ScheduleResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/schedules/{schedule_id}": { "get": { "tags": [ "schedules" ], "summary": "Get schedule", "description": "Get a specific schedule by ID.", "operationId": "handle_get_schedule_v3_organizations__org_id__schedules__schedule_id__get", "parameters": [ { "name": "schedule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Schedule Id", "example": "sched-abc123def456" }, "description": "Schedule ID (prefix: sched-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "schedules" ], "summary": "Update schedule", "description": "Update an existing schedule.", "operationId": "handle_update_schedule_v3_organizations__org_id__schedules__schedule_id__patch", "parameters": [ { "name": "schedule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Schedule Id", "example": "sched-abc123def456" }, "description": "Schedule ID (prefix: sched-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "schedules" ], "summary": "Delete schedule", "description": "Soft delete a schedule.", "operationId": "handle_delete_schedule_v3_organizations__org_id__schedules__schedule_id__delete", "parameters": [ { "name": "schedule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Schedule Id", "example": "sched-abc123def456" }, "description": "Schedule ID (prefix: sched-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/secrets": { "get": { "tags": [ "secrets" ], "summary": "List org-level secrets", "description": "List secrets for an organization.", "operationId": "handle_list_secrets_v3_organizations__org_id__secrets_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SecretResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "secrets" ], "summary": "Create an org-level secret", "description": "Create a secret for an organization.", "operationId": "handle_create_secret_v3_organizations__org_id__secrets_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/secrets/{secret_id}": { "delete": { "tags": [ "secrets" ], "summary": "Delete an org-level secret", "description": "Delete a secret for an organization.", "operationId": "handle_delete_secret_v3_organizations__org_id__secrets__secret_id__delete", "parameters": [ { "name": "secret_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Secret Id", "example": "secret-abc123def456" }, "description": "Secret ID (prefix: secret-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions": { "post": { "tags": [ "sessions" ], "summary": "Create Session", "description": "Create a new session", "operationId": "handle_create_session_v3_organizations__org_id__sessions_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "title": "Org Id", "example": "org-abc123def456", "nullable": true, "type": "string" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "query", "required": false, "schema": { "title": "Devin Id", "nullable": true, "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "sessions" ], "summary": "List Sessions", "description": "List sessions.", "operationId": "handle_get_sessions_v3_organizations__org_id__sessions_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "title": "Org Id", "example": "org-abc123def456", "nullable": true, "type": "string" }, "description": "Organization ID (prefix: org-)" }, { "name": "qs", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/SessionsQueryParams" } }, { "name": "devin_id", "in": "query", "required": false, "schema": { "title": "Devin Id", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SessionResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/insights": { "get": { "tags": [ "sessions" ], "summary": "List sessions with insights", "description": "List sessions with detailed insights including message counts,\nsession size classification, and AI-generated analysis.", "operationId": "handle_get_sessions_insights_v3_organizations__org_id__sessions_insights_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "title": "Org Id", "example": "org-abc123def456", "nullable": true, "type": "string" }, "description": "Organization ID (prefix: org-)" }, { "name": "qs", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/SessionsQueryParams" } }, { "name": "devin_id", "in": "query", "required": false, "schema": { "title": "Devin Id", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SessionInsightsResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/{devin_id}": { "get": { "tags": [ "sessions" ], "summary": "Get Session", "description": "Get details of a specific session.", "operationId": "handle_get_session_v3_organizations__org_id__sessions__devin_id__get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "title": "Org Id", "example": "org-abc123def456", "nullable": true, "type": "string" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "sessions" ], "summary": "Terminate Session", "description": "Terminate session", "operationId": "handle_terminate_session_v3_organizations__org_id__sessions__devin_id__delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "title": "Org Id", "example": "org-abc123def456", "nullable": true, "type": "string" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "archive", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to archive the Devin session", "default": false, "title": "Archive" }, "description": "Whether to archive the Devin session" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/{devin_id}/insights": { "get": { "tags": [ "sessions" ], "summary": "Get session insights", "description": "Get detailed insights for a specific session, including message counts,\nsession size classification, and AI-generated analysis.", "operationId": "handle_get_session_insights_v3_organizations__org_id__sessions__devin_id__insights_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "title": "Org Id", "example": "org-abc123def456", "nullable": true, "type": "string" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionInsightsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/{devin_id}/insights/generate": { "post": { "tags": [ "sessions" ], "summary": "Generate session insights", "description": "Trigger on-demand generation of session insights.\n\nReturns ``already_exists`` if insights have already been generated.\nOtherwise kicks off generation in the background. Poll the\nGET insights endpoint to retrieve results once generation completes.", "operationId": "handle_generate_session_insights_v3_organizations__org_id__sessions__devin_id__insights_generate_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "title": "Org Id", "example": "org-abc123def456", "nullable": true, "type": "string" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionInsightsGenerateResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/{devin_id}/archive": { "post": { "tags": [ "sessions" ], "summary": "Archive Session", "description": "Archive session and put it to sleep if currently running", "operationId": "handle_archive_session_v3_organizations__org_id__sessions__devin_id__archive_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "title": "Org Id", "example": "org-abc123def456", "nullable": true, "type": "string" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/{devin_id}/attachments": { "get": { "tags": [ "sessions" ], "summary": "List session attachments", "description": "List all attachments for a session.", "operationId": "handle_get_session_attachments_v3_organizations__org_id__sessions__devin_id__attachments_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "title": "Org Id", "example": "org-abc123def456", "nullable": true, "type": "string" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionAttachment" }, "title": "Response Handle Get Session Attachments V3 Organizations Org Id Sessions Devin Id Attachments Get" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/{devin_id}/tags": { "get": { "tags": [ "sessions" ], "summary": "Get session tags", "description": "Get the tags for a specific session.", "operationId": "handle_get_session_tags_v3_organizations__org_id__sessions__devin_id__tags_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "title": "Org Id", "example": "org-abc123def456", "nullable": true, "type": "string" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "put": { "tags": [ "sessions" ], "summary": "Replace session tags", "description": "Replace all tags on a session.", "operationId": "handle_replace_session_tags_v3_organizations__org_id__sessions__devin_id__tags_put", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "title": "Org Id", "example": "org-abc123def456", "nullable": true, "type": "string" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "sessions" ], "summary": "Append session tags", "description": "Append tags to a session (deduplicating with existing tags).", "operationId": "handle_append_session_tags_v3_organizations__org_id__sessions__devin_id__tags_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "title": "Org Id", "example": "org-abc123def456", "nullable": true, "type": "string" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionTagsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/sessions/{devin_id}/messages": { "get": { "tags": [ "sessions" ], "summary": "List session messages", "description": "List all messages for a session with cursor-based pagination, ordered chronologically.", "operationId": "handle_get_session_messages_v3_organizations__org_id__sessions__devin_id__messages_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "title": "Org Id", "example": "org-abc123def456", "nullable": true, "type": "string" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SessionMessage_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "sessions" ], "summary": "Send a message to a session", "description": "Send a message to an active session. The session will be automatically resumed if suspended.", "operationId": "handle_post_message_v3_organizations__org_id__sessions__devin_id__messages_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "title": "Org Id", "example": "org-abc123def456", "nullable": true, "type": "string" }, "description": "Organization ID (prefix: org-)" }, { "name": "devin_id", "in": "path", "required": true, "schema": { "title": "Devin Id", "example": "devin-abc123def456", "nullable": true, "type": "string" }, "description": "Devin session ID (prefix: devin-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionMessageCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/metrics/usage": { "get": { "tags": [ "metrics" ], "summary": "Get Usage Metrics", "description": "Get aggregated usage metrics for the organization.", "operationId": "handle_get_usage_metrics_v3_organizations__org_id__metrics_usage_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageMetrics" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/metrics/sessions": { "get": { "tags": [ "metrics" ], "summary": "Get Session Metrics", "description": "Get aggregated session metrics for the organization.", "operationId": "handle_get_session_metrics_v3_organizations__org_id__metrics_sessions_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "user_ids", "in": "query", "required": false, "schema": { "title": "User Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "service_user_ids", "in": "query", "required": false, "schema": { "title": "Service User Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "playbook_id", "in": "query", "required": false, "schema": { "title": "Playbook Id", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/metrics/searches": { "get": { "tags": [ "metrics" ], "summary": "Get Search Metrics", "description": "Get aggregated search metrics for the organization.", "operationId": "handle_get_search_metrics_v3_organizations__org_id__metrics_searches_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/metrics/prs": { "get": { "tags": [ "metrics" ], "summary": "Get PR Metrics", "description": "Get aggregated PR metrics for the organization.", "operationId": "handle_get_pr_metrics_v3_organizations__org_id__metrics_prs_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "user_ids", "in": "query", "required": false, "schema": { "title": "User Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "service_user_ids", "in": "query", "required": false, "schema": { "title": "Service User Ids", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "playbook_id", "in": "query", "required": false, "schema": { "title": "Playbook Id", "nullable": true, "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/metrics/dau": { "get": { "tags": [ "metrics" ], "summary": "Get Daily Active Users", "description": "Get daily active users for each day in the specified time range.", "operationId": "handle_get_dau_metrics_v3_organizations__org_id__metrics_dau_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "min_sessions", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Sessions" } }, { "name": "min_searches", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Searches" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveUserMetricsListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/metrics/wau": { "get": { "tags": [ "metrics" ], "summary": "Get Weekly Active Users", "description": "Get weekly active users for each week in the specified time range.", "operationId": "handle_get_wau_metrics_v3_organizations__org_id__metrics_wau_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "min_sessions", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Sessions" } }, { "name": "min_searches", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Searches" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveUserMetricsListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/metrics/mau": { "get": { "tags": [ "metrics" ], "summary": "Get Monthly Active Users", "description": "Get monthly active users for each month in the specified time range.", "operationId": "handle_get_mau_metrics_v3_organizations__org_id__metrics_mau_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "min_sessions", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Sessions" } }, { "name": "min_searches", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Searches" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveUserMetricsListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/metrics/active-users": { "get": { "tags": [ "metrics" ], "summary": "Get Active Users for Custom Date Range", "description": "Get unique active users for a custom date range.", "operationId": "handle_get_active_users_metrics_v3_organizations__org_id__metrics_active_users_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } }, { "name": "min_sessions", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Sessions" } }, { "name": "min_searches", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 1, "title": "Min Searches" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveUserMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/consumption/daily": { "get": { "tags": [ "consumption" ], "summary": "Get Daily Consumption", "description": "Get daily ACU consumption for the organization.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC.", "operationId": "handle_get_consumption_daily_v3_organizations__org_id__consumption_daily_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/consumption/daily/users/{user_id}": { "get": { "tags": [ "consumption" ], "summary": "Get User Daily Consumption", "description": "Get daily ACU consumption for a specific user within the organization.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC.", "operationId": "handle_get_user_consumption_daily_v3_organizations__org_id__consumption_daily_users__user_id__get", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/consumption/daily/service-users/{service_user_id}": { "get": { "tags": [ "consumption" ], "summary": "Get Service User Daily Consumption", "description": "Get daily ACU consumption for a specific service user within the organization.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC.", "operationId": "handle_get_service_user_consumption_daily_v3_organizations__org_id__consumption_daily_service_users__service_user_id__get", "parameters": [ { "name": "service_user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Service User Id", "example": "service-user-abc123def456" }, "description": "Service user ID (prefix: service-user-)" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/consumption/daily/sessions/{session_id}": { "get": { "tags": [ "consumption" ], "summary": "Get Session Daily Consumption", "description": "Get daily ACU consumption for a specific session within the organization.\n\n**Timezone behavior**: Billing cycles use midnight PST (Pacific Standard Time)\nas the day boundary, which corresponds to 08:00:00 UTC.", "operationId": "handle_get_session_consumption_daily_v3_organizations__org_id__consumption_daily_sessions__session_id__get", "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id", "example": "devin-abc123def456" }, "description": "Session ID (prefix: devin-). Alias for devin_id used in consumption endpoints." }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumptionResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/pr-reviews": { "post": { "tags": [ "pr-reviews" ], "summary": "Trigger Devin Review", "description": "Trigger a Devin Review for a pull/merge request.\n\nCreates a database record that will be picked up by the review\nworker pool. Always fetches the latest commit from the PR.", "operationId": "handle_create_pr_review_v3_organizations__org_id__pr_reviews_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrReviewCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrReviewResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "pr-reviews" ], "summary": "Get latest Devin Review status", "description": "Return the latest Devin Review for a PR scoped to the organization.\n\nWhen ``commit_sha`` is omitted, the PR's current head commit is\nfetched from the provider and used. Returns ``404`` when no review\nexists for the resolved commit.", "operationId": "handle_get_pr_review_status_v3_organizations__org_id__pr_reviews_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "pr_url", "in": "query", "required": true, "schema": { "type": "string", "description": "Full URL of the pull/merge request to look up (e.g. `https://github.com/owner/repo/pull/123`).", "title": "Pr Url", "example": "https://github.com/owner/repo/pull/123" }, "description": "Full URL of the pull/merge request to look up (e.g. `https://github.com/owner/repo/pull/123`)." }, { "name": "commit_sha", "in": "query", "required": false, "schema": { "description": "Commit SHA to look up (full or short prefix). Defaults to the PR's current head commit when omitted.", "title": "Commit Sha", "nullable": true, "type": "string", "example": "abc123def4567890abc123def4567890abc123de" }, "description": "Commit SHA to look up (full or short prefix). Defaults to the PR's current head commit when omitted." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrReviewResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/metrics": { "get": { "tags": [ "code-scans" ], "summary": "Get Code Scan Metrics", "description": "Get aggregated code scan metrics for the organization.\n\nReturns scan, finding, and remediation-PR metrics for code scans created\nwithin the specified time range.", "operationId": "handle_get_code_scan_metrics_v3_organizations__org_id__code_scans_metrics_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time Before" } }, { "name": "time_after", "in": "query", "required": true, "schema": { "type": "integer", "title": "Time After" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanMetricsResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/scans": { "get": { "tags": [ "code-scans" ], "summary": "List Code Scans", "description": "List code scans for the organization.\n\nScans are returned newest first. Optionally filter by ``repo_name`` and\ncreation time (``time_after`` / ``time_before``); results are paginated\nwith an opaque cursor (``after`` / ``first``).", "operationId": "handle_list_code_scans_v3_organizations__org_id__code_scans_scans_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "time_before", "in": "query", "required": false, "schema": { "title": "Time Before", "nullable": true, "type": "integer" } }, { "name": "time_after", "in": "query", "required": false, "schema": { "title": "Time After", "nullable": true, "type": "integer" } }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "repo_name", "in": "query", "required": false, "schema": { "description": "Filter to scans that scanned this repository. Matches multi-repo scans even when the repository is not the scan's primary repo, so returned items may report a different repo_name.", "title": "Repo Name", "nullable": true, "type": "string" }, "description": "Filter to scans that scanned this repository. Matches multi-repo scans even when the repository is not the scan's primary repo, so returned items may report a different repo_name." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_CodeScanResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/findings": { "get": { "tags": [ "code-scans" ], "summary": "List Code Scan Findings", "description": "List code scan findings for the organization.\n\nFindings are returned newest first. Optionally filter by ``scan_id``,\n``repo_name``, ``severity``, and ``status`` (``severity`` and ``status``\naccept multiple values); results are paginated with an opaque cursor\n(``after`` / ``first``).", "operationId": "handle_list_code_scan_findings_v3_organizations__org_id__code_scans_findings_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "scan_id", "in": "query", "required": false, "schema": { "description": "Filter to findings produced by this scan.", "title": "Scan Id", "nullable": true, "type": "string" }, "description": "Filter to findings produced by this scan." }, { "name": "repo_name", "in": "query", "required": false, "schema": { "description": "Filter to findings reported in this repository.", "title": "Repo Name", "nullable": true, "type": "string" }, "description": "Filter to findings reported in this repository." }, { "name": "severity", "in": "query", "required": false, "schema": { "description": "Filter to findings with any of these severities (critical, high, medium, low).", "title": "Severity", "nullable": true, "type": "array", "items": { "type": "string", "x-extensible-enum": [ "critical", "high", "medium", "low" ], "description": "Known values: `critical`, `high`, `medium`, `low`. Additional values may be added in the future." } }, "description": "Filter to findings with any of these severities (critical, high, medium, low)." }, { "name": "status", "in": "query", "required": false, "schema": { "description": "Filter to findings with any of these statuses (open, dismissed, resolved).", "title": "Status", "nullable": true, "type": "array", "items": { "type": "string", "x-extensible-enum": [ "open", "dismissed", "resolved" ], "description": "Known values: `open`, `dismissed`, `resolved`. Additional values may be added in the future." } }, "description": "Filter to findings with any of these statuses (open, dismissed, resolved)." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_CodeScanFindingResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/profiles": { "get": { "tags": [ "code-scans" ], "summary": "List Code Scan Profiles", "description": "List code scan profiles for the organization.\n\nReturns profile summaries (without guidance) newest first, including both\norg-owned and account-shared profiles. Results are paginated with an\nopaque cursor (``after`` / ``first``).", "operationId": "handle_list_code_scan_profiles_v3_organizations__org_id__code_scans_profiles_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_CodeScanProfileSummaryResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/profiles/{profile_id}": { "get": { "tags": [ "code-scans" ], "summary": "Get Code Scan Profile", "description": "Get a code scan profile by ID.\n\nReturns the profile's metadata, visibility (org-owned or shared\naccount-wide), and all of its guidance fields. Returns ``404`` when the\nprofile does not exist or is not visible to the organization.", "operationId": "handle_get_code_scan_profile_v3_organizations__org_id__code_scans_profiles__profile_id__get", "parameters": [ { "name": "profile_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Profile Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanProfileDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans": { "post": { "tags": [ "code-scans" ], "summary": "Start Code Scan", "description": "Start a new code scan on a repository in the organization.\n\nThe scan is enqueued and launched asynchronously by the scan dispatcher.\nThe scan is attributed to the calling principal (the service user or PAT\nthat made the request). Returns ``409`` when the organization's scan\nbacklog is at capacity.", "operationId": "handle_start_code_scan_v3_organizations__org_id__code_scans_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanCreateRequest" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeScanResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3/organizations/{org_id}/code-scans/{scan_id}/findings/{finding_id}/remediate": { "post": { "tags": [ "code-scans" ], "summary": "Remediate Code Scan Finding", "description": "Launch a Devin session to remediate a code scan finding.\n\nThe session analyzes the vulnerable code, implements a fix, and opens a\npull request. The session is attributed to the calling principal (the\nservice user or PAT that made the request). Returns ``409`` if the finding\nalready has a remediation session.", "operationId": "handle_remediate_code_scan_finding_v3_organizations__org_id__code_scans__scan_id__findings__finding_id__remediate_post", "parameters": [ { "name": "scan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Scan Id" } }, { "name": "finding_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Finding Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemediateFindingResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/snapshot-setup/blueprints": { "get": { "tags": [ "snapshot_setup" ], "summary": "List org- and repo-tier blueprints", "operationId": "list_org_blueprints_v3beta1_organizations__org_id__snapshot_setup_blueprints_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "repo_name", "in": "query", "required": false, "schema": { "description": "Filter to a specific repository (e.g. 'org/repo').", "title": "Repo Name", "nullable": true, "type": "string" }, "description": "Filter to a specific repository (e.g. 'org/repo')." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintList" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "snapshot_setup" ], "summary": "Create an org- or repo-tier blueprint", "description": "Create a blueprint. ``type`` is inferred from ``repo_name``.\n\nPer spec, this never auto-triggers a build — callers must\n``POST /builds`` explicitly.", "operationId": "create_org_blueprint_v3beta1_organizations__org_id__snapshot_setup_blueprints_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrgBlueprintBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blueprint" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}": { "get": { "tags": [ "snapshot_setup" ], "summary": "Get a single blueprint", "operationId": "get_org_blueprint_v3beta1_organizations__org_id__snapshot_setup_blueprints__blueprint_id__get", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blueprint" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "patch": { "tags": [ "snapshot_setup" ], "summary": "Update a blueprint's contents and/or position", "description": "Partial update for a single blueprint. Does NOT auto-trigger a build.\n\nFields honored:\n\n- ``contents`` — writes a new YAML version for the blueprint.\n- ``position`` — sets the repo-tier blueprint's execution position.\n Returns ``400`` on an org-tier blueprint (those have no position).\n\nReturns ``400`` when the body is empty.", "operationId": "update_org_blueprint_v3beta1_organizations__org_id__snapshot_setup_blueprints__blueprint_id__patch", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrgBlueprintBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blueprint" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "snapshot_setup" ], "summary": "Soft-delete a blueprint", "operationId": "delete_org_blueprint_v3beta1_organizations__org_id__snapshot_setup_blueprints__blueprint_id__delete", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}/contents": { "get": { "tags": [ "snapshot_setup" ], "summary": "Presigned URL for the blueprint's YAML", "operationId": "get_org_blueprint_contents_v3beta1_organizations__org_id__snapshot_setup_blueprints__blueprint_id__contents_get", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresignedDownload" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}/files": { "get": { "tags": [ "snapshot_setup" ], "summary": "List blueprint files", "operationId": "list_org_blueprint_files_v3beta1_organizations__org_id__snapshot_setup_blueprints__blueprint_id__files_get", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintFileList" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "post": { "tags": [ "snapshot_setup" ], "summary": "Upload a blueprint file", "operationId": "upload_org_blueprint_file_v3beta1_organizations__org_id__snapshot_setup_blueprints__blueprint_id__files_post", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "title": "Name" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_org_blueprint_file_v3beta1_organizations__org_id__snapshot_setup_blueprints__blueprint_id__files_post" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlueprintFile" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}/files/{file_id}": { "delete": { "tags": [ "snapshot_setup" ], "summary": "Delete a blueprint file", "operationId": "delete_org_blueprint_file_v3beta1_organizations__org_id__snapshot_setup_blueprints__blueprint_id__files__file_id__delete", "parameters": [ { "name": "blueprint_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Blueprint Id" } }, { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string", "title": "File Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/snapshot-setup/builds": { "post": { "tags": [ "snapshot_setup" ], "summary": "Trigger a manual build", "description": "Manually trigger a snapshot build using the org's current blueprints.", "operationId": "trigger_org_build_v3beta1_organizations__org_id__snapshot_setup_builds_post", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerBuildBody" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Build" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "snapshot_setup" ], "summary": "List builds for the org", "operationId": "list_org_builds_v3beta1_organizations__org_id__snapshot_setup_builds_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "status", "in": "query", "required": false, "schema": { "description": "Filter by spec status.", "title": "Status", "nullable": true, "type": "string", "x-extensible-enum": [ "pending", "running", "succeeded", "failed", "cancelled" ] }, "description": "Filter by spec status." }, { "name": "active", "in": "query", "required": false, "schema": { "description": "If true, returns 0 or 1 items: the build whose image is currently used by new sessions.", "title": "Active", "nullable": true, "type": "boolean" }, "description": "If true, returns 0 or 1 items: the build whose image is currently used by new sessions." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_Build_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/snapshot-setup/builds/{build_id}": { "get": { "tags": [ "snapshot_setup" ], "summary": "Get a single build", "operationId": "get_org_build_v3beta1_organizations__org_id__snapshot_setup_builds__build_id__get", "parameters": [ { "name": "build_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Build Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Build" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/snapshot-setup/builds/{build_id}/cancel": { "post": { "tags": [ "snapshot_setup" ], "summary": "Cancel an in-flight build", "operationId": "cancel_org_build_v3beta1_organizations__org_id__snapshot_setup_builds__build_id__cancel_post", "parameters": [ { "name": "build_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Build Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Build" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/snapshot-setup/builds/{build_id}/pin": { "post": { "tags": [ "snapshot_setup" ], "summary": "Pin the org to a specific successful build", "description": "Pin a successful build (less than 7 days old).\n\nTranslates the SDK's 400 errors into 409 (per spec: \"409 if the\nbuild is not succeeded, or older than 7 days\").", "operationId": "pin_org_build_v3beta1_organizations__org_id__snapshot_setup_builds__build_id__pin_post", "parameters": [ { "name": "build_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Build Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PinBuildBody" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Build" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "snapshot_setup" ], "summary": "Unpin a build (no-op if not pinned)", "description": "Unpin the org if and only if it is currently pinned to ``build_id``.\n\nNo-op (still 204) when the org is not pinned to this build.", "operationId": "unpin_org_build_v3beta1_organizations__org_id__snapshot_setup_builds__build_id__pin_delete", "parameters": [ { "name": "build_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Build Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "204": { "description": "Successful Response" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/snapshot-setup/builds/{build_id}/logs": { "get": { "tags": [ "snapshot_setup" ], "summary": "Presigned URL for the build's log file", "operationId": "get_org_build_logs_v3beta1_organizations__org_id__snapshot_setup_builds__build_id__logs_get", "parameters": [ { "name": "build_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Build Id" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresignedDownload" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/repositories": { "get": { "tags": [ "repositories" ], "summary": "List repositories available to an organization", "operationId": "handle_list_repositories_v3beta1_organizations__org_id__repositories_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 100, "title": "First" } }, { "name": "filter_name", "in": "query", "required": false, "schema": { "title": "Filter Name", "nullable": true, "type": "string" } }, { "name": "only_repo_paths", "in": "query", "required": false, "schema": { "title": "Only Repo Paths", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "exclude_repo_paths", "in": "query", "required": false, "schema": { "title": "Exclude Repo Paths", "nullable": true, "type": "array", "items": { "type": "string" } } }, { "name": "load_indexing_status", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Load Indexing Status" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_RepositoryResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/repositories/indexing": { "put": { "tags": [ "repositories" ], "summary": "Bulk index repositories", "description": "Idempotently enables indexing for a batch of repositories and triggers indexing jobs.", "operationId": "handle_bulk_index_repositories_v3beta1_organizations__org_id__repositories_indexing_put", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkIndexRepositoriesRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepositoryIndexingResponse" }, "title": "Response Handle Bulk Index Repositories V3Beta1 Organizations Org Id Repositories Indexing Put" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "repositories" ], "summary": "Bulk remove repositories from indexing", "description": "Disables indexing and clears configured branches for a batch of repositories.", "operationId": "handle_bulk_remove_repositories_from_indexing_v3beta1_organizations__org_id__repositories_indexing_delete", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveRepositoriesRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepositoryIndexingResponse" }, "title": "Response Handle Bulk Remove Repositories From Indexing V3Beta1 Organizations Org Id Repositories Indexing Delete" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "repositories" ], "summary": "List indexed repositories", "operationId": "handle_list_indexed_repositories_v3beta1_organizations__org_id__repositories_indexing_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_RepositoryIndexingResponse_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/repositories/{repository_path}/indexing": { "put": { "tags": [ "repositories" ], "summary": "Index a repository", "description": "Idempotently enables indexing for a single repository and triggers indexing jobs.", "operationId": "handle_index_single_repository_v3beta1_organizations__org_id__repositories__repository_path__indexing_put", "parameters": [ { "name": "repository_path", "in": "path", "required": true, "schema": { "type": "string", "title": "Repository Path" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "requestBody": { "content": { "application/json": { "schema": { "title": "Payload", "nullable": true, "type": "object" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositoryIndexingResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "delete": { "tags": [ "repositories" ], "summary": "Remove a repository from indexing", "description": "Disables indexing and clears configured branches for a single repository.", "operationId": "handle_remove_single_repository_from_indexing_v3beta1_organizations__org_id__repositories__repository_path__indexing_delete", "parameters": [ { "name": "repository_path", "in": "path", "required": true, "schema": { "type": "string", "title": "Repository Path" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositoryIndexingResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } }, "get": { "tags": [ "repositories" ], "summary": "Get indexing status for a repository", "operationId": "handle_get_repository_indexing_status_v3beta1_organizations__org_id__repositories__repository_path__indexing_get", "parameters": [ { "name": "repository_path", "in": "path", "required": true, "schema": { "type": "string", "title": "Repository Path" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepoIndexingStatusResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/repositories/{repository_path}/indexing/branches/{branch_name}": { "delete": { "tags": [ "repositories" ], "summary": "Remove a branch from indexing", "operationId": "handle_remove_branch_v3beta1_organizations__org_id__repositories__repository_path__indexing_branches__branch_name__delete", "parameters": [ { "name": "repository_path", "in": "path", "required": true, "schema": { "type": "string", "title": "Repository Path" } }, { "name": "branch_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Branch Name" } }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepositoryIndexingResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/members/users": { "get": { "tags": [ "users" ], "summary": "List Organization Users", "description": "List users with direct membership in the organization.", "operationId": "handle_list_organization_users_v3beta1_organizations__org_id__members_users_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "email", "in": "query", "required": false, "schema": { "description": "Filter by exact email address", "title": "Email", "nullable": true, "type": "string" }, "description": "Filter by exact email address" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_User_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/members/idp-users": { "get": { "tags": [ "users" ], "summary": "List Organization IDP Group Users", "description": "List users whose organization membership is derived from IDP group assignments.", "operationId": "handle_list_organization_idp_users_v3beta1_organizations__org_id__members_idp_users_get", "parameters": [ { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" }, { "name": "after", "in": "query", "required": false, "schema": { "title": "After", "nullable": true, "type": "string" } }, { "name": "first", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 100, "title": "First" } }, { "name": "email", "in": "query", "required": false, "schema": { "description": "Filter by exact email address", "title": "Email", "nullable": true, "type": "string" }, "description": "Filter by exact email address" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_IdpGroupUser_" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } }, "/v3beta1/organizations/{org_id}/members/users/{user_id}": { "get": { "tags": [ "users" ], "summary": "Get Organization User", "description": "Get an organization member by ID. Returns both direct and IDP-group-derived role assignments.", "operationId": "handle_get_organization_user_v3beta1_organizations__org_id__members_users__user_id__get", "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" }, "description": "User ID" }, { "name": "org_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Org Id", "example": "org-abc123def456" }, "description": "Organization ID (prefix: org-)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithIdpRoles" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetail" } } } } } } } }, "components": { "schemas": { "ACULimitResponse": { "properties": { "cycle_acu_limit": { "type": "integer", "title": "Cycle Acu Limit" }, "scope": { "type": "string", "title": "Scope", "x-extensible-enum": [ "enterprise", "org", "user" ], "description": "Known values: `enterprise`, `org`, `user`. Additional values may be added in the future." }, "org_id": { "title": "Org Id", "nullable": true, "type": "string" }, "user_id": { "title": "User Id", "nullable": true, "type": "string" } }, "type": "object", "required": [ "cycle_acu_limit", "scope" ], "title": "ACULimitResponse" }, "ActiveUserMetricsListResponse": { "items": { "$ref": "#/components/schemas/ActiveUserMetricsResponse" }, "type": "array", "title": "ActiveUserMetricsListResponse", "description": "Validated list of active user metrics with ascending order and no overlapping periods." }, "ActiveUserMetricsResponse": { "properties": { "start_time": { "type": "integer", "title": "Start Time" }, "end_time": { "type": "integer", "title": "End Time" }, "active_users": { "type": "integer", "title": "Active Users" } }, "type": "object", "required": [ "start_time", "end_time", "active_users" ], "title": "ActiveUserMetricsResponse", "description": "Single entry for active users over time." }, "AcusByProduct": { "properties": { "devin": { "type": "number", "title": "Devin" }, "cascade": { "type": "number", "title": "Cascade" }, "terminal": { "type": "number", "title": "Terminal" }, "review": { "title": "Review", "nullable": true, "type": "number" } }, "type": "object", "required": [ "devin", "cascade", "terminal" ], "title": "AcusByProduct" }, "ApiKeyResponse": { "properties": { "api_key_id": { "type": "string", "title": "Api Key Id" }, "api_key_name": { "type": "string", "title": "Api Key Name" }, "created_at": { "type": "integer", "title": "Created At" }, "expires_at": { "title": "Expires At", "nullable": true, "type": "integer" }, "revoked_at": { "title": "Revoked At", "nullable": true, "type": "integer" }, "last_used_at": { "title": "Last Used At", "nullable": true, "type": "integer" }, "is_active": { "type": "boolean", "title": "Is Active" } }, "type": "object", "required": [ "api_key_id", "api_key_name", "created_at", "expires_at", "revoked_at", "last_used_at", "is_active" ], "title": "ApiKeyResponse", "description": "Shared response model for API key details (used by both PAT and service user endpoints)." }, "ApiKeyWithTokenResponse": { "properties": { "api_key_id": { "type": "string", "title": "Api Key Id" }, "api_key_name": { "type": "string", "title": "Api Key Name" }, "token": { "type": "string", "title": "Token", "description": "The raw API token. This is only shown once at creation/rotation time." } }, "type": "object", "required": [ "api_key_id", "api_key_name", "token" ], "title": "ApiKeyWithTokenResponse", "description": "Shared response model for API key creation/rotation (includes one-time token)." }, "AttachmentResponse": { "properties": { "attachment_id": { "type": "string", "title": "Attachment Id" }, "name": { "type": "string", "title": "Name" }, "url": { "type": "string", "title": "Url" } }, "type": "object", "required": [ "attachment_id", "name", "url" ], "title": "AttachmentResponse" }, "AuditLogAction": { "type": "string", "title": "AuditLogAction", "x-extensible-enum": [ "login", "create_org", "update_org", "delete_org", "revoke_all_enterprise_api_keys", "add_enterprise_member", "delete_member", "add_member", "assign_roles", "update_role", "create_role", "delete_role", "add_group_membership", "update_group_membership", "delete_group_membership", "create_knowledge", "edit_knowledge", "delete_knowledge", "create_folder", "update_folder", "delete_folder", "create_session", "sleep_session", "terminate_session", "send_message", "create_service_api_key", "revoke_enterprise_api_key", "create_gitlab_integration", "update_gitlab_integration", "reconnect_gitlab_integration", "delete_gitlab_integration", "create_gitlab_app_config", "create_azure_devops_integration", "reconnect_azure_devops_integration", "delete_azure_devops_integration", "remove_repo_from_devin", "update_enterprise_hypervisor_settings", "update_enterprise_settings", "update_org_settings", "update_code_snippet_telemetry", "ai_guardrail_violation", "update_ai_guardrail", "approve_deploy", "approve_test_app", "permission_response", "search_query", "create_org_api_key", "create_user_api_key", "view_org_api_key", "view_user_api_key", "create_secret", "update_secret", "delete_secret", "create_playbook", "update_playbook", "delete_playbook", "enable_persona", "disable_persona", "delete_persona", "start_repo_setup", "delete_repo_setup", "finish_repo_setup", "github_integration_deleted", "create_github_integration", "delete_github_integration", "refresh_github_integration", "create_bitbucket_integration", "delete_bitbucket_integration", "mcp_server_install", "mcp_server_update", "mcp_server_enable", "mcp_server_disable", "mcp_server_delete", "mcp_server_secret_link", "mcp_server_secret_unlink", "mcp_server_oauth_initiate", "mcp_server_oauth_tokens_granted", "mcp_server_oauth_tokens_revoked", "mcp_enterprise_server_targets_update", "mcp_enterprise_server_credential_set", "mcp_enterprise_server_credential_delete", "create_mcp_validation_session", "set_account_managed_plugins", "set_org_managed_plugins", "set_managed_plugin_bundle", "delete_managed_plugin_bundle", "secure_mode_profile_created", "secure_mode_profile_updated", "secure_mode_binding_created", "secure_mode_binding_updated", "secure_mode_binding_deleted", "create_service_user", "update_service_user", "delete_service_user", "assign_service_user_role", "remove_service_user_role", "create_git_permission", "delete_git_permission", "update_git_permission", "create_maintenance_task", "update_maintenance_task", "delete_maintenance_task", "create_snapshot_script", "schedule_snapshot_script", "execute_snapshot_script", "update_repo_setup_steering_knowledge", "delete_repo_setup_steering_knowledge", "set_org_group_limits", "create_join_request", "approve_join_request", "automatic_join_event", "reject_join_request", "create_seat_request", "approve_seat_request", "decline_seat_request", "create_service_user_api_key", "revoke_service_user_api_key", "rotate_service_user_api_key", "create_pat", "revoke_pat", "rotate_pat", "create_blueprint", "create_blueprint_version", "rollback_blueprint_version", "delete_blueprint", "reorder_blueprints", "create_enterprise_blueprint", "create_enterprise_blueprint_version", "rollback_enterprise_blueprint_version", "delete_enterprise_blueprint", "accept_skill_pr", "trigger_blueprint_build", "cancel_blueprint_build", "upload_blueprint_file", "delete_blueprint_file", "sync_repo_blueprints", "detach_blueprint_from_git", "create_blueprint_pr", "pin_build", "unpin_build", "delete_build", "trigger_automation", "create_automation", "update_automation", "delete_automation", "reset_automation_monitor", "update_automation_scratch", "regenerate_automation_webhook_secret", "acknowledge_session_hard_cap", "create_audit_log_export", "update_audit_log_export", "delete_audit_log_export", "start_code_scan", "create_outpost_pool", "delete_outpost_pool", "claim_outpost_session", "release_outpost_session" ], "description": "Known values: `login`, `create_org`, `update_org`, `delete_org`, `revoke_all_enterprise_api_keys`, `add_enterprise_member`, `delete_member`, `add_member`, `assign_roles`, `update_role`, `create_role`, `delete_role`, `add_group_membership`, `update_group_membership`, `delete_group_membership`, `create_knowledge`, `edit_knowledge`, `delete_knowledge`, `create_folder`, `update_folder`, `delete_folder`, `create_session`, `sleep_session`, `terminate_session`, `send_message`, `create_service_api_key`, `revoke_enterprise_api_key`, `create_gitlab_integration`, `update_gitlab_integration`, `reconnect_gitlab_integration`, `delete_gitlab_integration`, `create_gitlab_app_config`, `create_azure_devops_integration`, `reconnect_azure_devops_integration`, `delete_azure_devops_integration`, `remove_repo_from_devin`, `update_enterprise_hypervisor_settings`, `update_enterprise_settings`, `update_org_settings`, `update_code_snippet_telemetry`, `ai_guardrail_violation`, `update_ai_guardrail`, `approve_deploy`, `approve_test_app`, `permission_response`, `search_query`, `create_org_api_key`, `create_user_api_key`, `view_org_api_key`, `view_user_api_key`, `create_secret`, `update_secret`, `delete_secret`, `create_playbook`, `update_playbook`, `delete_playbook`, `enable_persona`, `disable_persona`, `delete_persona`, `start_repo_setup`, `delete_repo_setup`, `finish_repo_setup`, `github_integration_deleted`, `create_github_integration`, `delete_github_integration`, `refresh_github_integration`, `create_bitbucket_integration`, `delete_bitbucket_integration`, `mcp_server_install`, `mcp_server_update`, `mcp_server_enable`, `mcp_server_disable`, `mcp_server_delete`, `mcp_server_secret_link`, `mcp_server_secret_unlink`, `mcp_server_oauth_initiate`, `mcp_server_oauth_tokens_granted`, `mcp_server_oauth_tokens_revoked`, `mcp_enterprise_server_targets_update`, `mcp_enterprise_server_credential_set`, `mcp_enterprise_server_credential_delete`, `create_mcp_validation_session`, `set_account_managed_plugins`, `set_org_managed_plugins`, `set_managed_plugin_bundle`, `delete_managed_plugin_bundle`, `secure_mode_profile_created`, `secure_mode_profile_updated`, `secure_mode_binding_created`, `secure_mode_binding_updated`, `secure_mode_binding_deleted`, `create_service_user`, `update_service_user`, `delete_service_user`, `assign_service_user_role`, `remove_service_user_role`, `create_git_permission`, `delete_git_permission`, `update_git_permission`, `create_maintenance_task`, `update_maintenance_task`, `delete_maintenance_task`, `create_snapshot_script`, `schedule_snapshot_script`, `execute_snapshot_script`, `update_repo_setup_steering_knowledge`, `delete_repo_setup_steering_knowledge`, `set_org_group_limits`, `create_join_request`, `approve_join_request`, `automatic_join_event`, `reject_join_request`, `create_seat_request`, `approve_seat_request`, `decline_seat_request`, `create_service_user_api_key`, `revoke_service_user_api_key`, `rotate_service_user_api_key`, `create_pat`, `revoke_pat`, `rotate_pat`, `create_blueprint`, `create_blueprint_version`, `rollback_blueprint_version`, `delete_blueprint`, `reorder_blueprints`, `create_enterprise_blueprint`, `create_enterprise_blueprint_version`, `rollback_enterprise_blueprint_version`, `delete_enterprise_blueprint`, `accept_skill_pr`, `trigger_blueprint_build`, `cancel_blueprint_build`, `upload_blueprint_file`, `delete_blueprint_file`, `sync_repo_blueprints`, `detach_blueprint_from_git`, `create_blueprint_pr`, `pin_build`, `unpin_build`, `delete_build`, `trigger_automation`, `create_automation`, `update_automation`, `delete_automation`, `reset_automation_monitor`, `update_automation_scratch`, `regenerate_automation_webhook_secret`, `acknowledge_session_hard_cap`, `create_audit_log_export`, `update_audit_log_export`, `delete_audit_log_export`, `start_code_scan`, `create_outpost_pool`, `delete_outpost_pool`, `claim_outpost_session`, `release_outpost_session`. Additional values may be added in the future." }, "AuditLogResponse": { "properties": { "audit_log_id": { "type": "string", "title": "Audit Log Id" }, "action": { "$ref": "#/components/schemas/AuditLogAction" }, "created_at": { "type": "integer", "title": "Created At" }, "org_id": { "title": "Org Id", "nullable": true, "type": "string" }, "user_id": { "title": "User Id", "nullable": true, "type": "string" }, "user_email": { "title": "User Email", "nullable": true, "type": "string" }, "service_user_id": { "title": "Service User Id", "nullable": true, "type": "string" }, "service_user_name": { "title": "Service User Name", "nullable": true, "type": "string" }, "data": { "additionalProperties": true, "type": "object", "title": "Data" } }, "type": "object", "required": [ "audit_log_id", "action", "created_at", "org_id", "user_id", "user_email", "service_user_id", "service_user_name", "data" ], "title": "AuditLogResponse" }, "Blueprint": { "properties": { "blueprint_id": { "type": "string", "title": "Blueprint Id" }, "type": { "type": "string", "title": "Type", "x-extensible-enum": [ "enterprise", "org", "repo" ], "description": "Known values: `enterprise`, `org`, `repo`. Additional values may be added in the future." }, "repo_name": { "title": "Repo Name", "nullable": true, "type": "string" }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" } }, "type": "object", "required": [ "blueprint_id", "type", "repo_name", "created_at", "updated_at" ], "title": "Blueprint", "description": "Public ``Blueprint`` resource shape.\n\nNote: the ``type`` enum may grow in the future; clients MUST gracefully\nhandle unknown values. YAML contents are fetched separately via\n``GET /blueprints/{id}/contents``." }, "BlueprintFile": { "properties": { "file_id": { "type": "string", "title": "File Id" }, "blueprint_id": { "type": "string", "title": "Blueprint Id" }, "name": { "type": "string", "title": "Name" }, "env_var_name": { "type": "string", "title": "Env Var Name" }, "size_bytes": { "type": "integer", "title": "Size Bytes" }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" } }, "type": "object", "required": [ "file_id", "blueprint_id", "name", "env_var_name", "size_bytes", "created_at", "updated_at" ], "title": "BlueprintFile", "description": "Public ``BlueprintFile`` resource shape." }, "BlueprintFileList": { "properties": { "data": { "items": { "$ref": "#/components/schemas/BlueprintFile" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "BlueprintFileList", "description": "List envelope for blueprint files." }, "BlueprintList": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Blueprint" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "BlueprintList", "description": "List envelope for blueprints (returned in execution order)." }, "Body_handle_upload_attachment_v3_organizations__org_id__attachments_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_handle_upload_attachment_v3_organizations__org_id__attachments_post" }, "Body_upload_enterprise_blueprint_file_endpoint_v3beta1_enterprise_snapshot_setup_blueprints__blueprint_id__files_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_enterprise_blueprint_file_endpoint_v3beta1_enterprise_snapshot_setup_blueprints__blueprint_id__files_post" }, "Body_upload_org_blueprint_file_v3beta1_organizations__org_id__snapshot_setup_blueprints__blueprint_id__files_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_org_blueprint_file_v3beta1_organizations__org_id__snapshot_setup_blueprints__blueprint_id__files_post" }, "Build": { "properties": { "build_id": { "type": "string", "title": "Build Id" }, "status": { "type": "string", "title": "Status", "x-extensible-enum": [ "pending", "running", "succeeded", "failed", "cancelled" ], "description": "Known values: `pending`, `running`, `succeeded`, `failed`, `cancelled`. Additional values may be added in the future." }, "trigger": { "title": "Trigger", "nullable": true, "type": "string", "x-extensible-enum": [ "manual", "auto" ], "description": "Known values: `manual`, `auto`. Additional values may be added in the future." }, "triggered_by_user_id": { "title": "Triggered By User Id", "nullable": true, "type": "string" }, "pinned": { "type": "boolean", "title": "Pinned" }, "started_at": { "title": "Started At", "nullable": true, "type": "integer" }, "completed_at": { "title": "Completed At", "nullable": true, "type": "integer" }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" } }, "type": "object", "required": [ "build_id", "status", "trigger", "triggered_by_user_id", "pinned", "started_at", "completed_at", "created_at", "updated_at" ], "title": "Build", "description": "Public ``Build`` resource shape — opaque \"did this succeed yet?\" view.\n\nPer spec, no platform/snapshot/per-job introspection is exposed. Future\nadditions (``triggered_by_repo``, build metadata, etc.) are additive." }, "BulkIndexRepositoriesRequest": { "properties": { "repositories": { "items": { "$ref": "#/components/schemas/RepositoryIndexingItem" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Repositories" } }, "type": "object", "required": [ "repositories" ], "title": "BulkIndexRepositoriesRequest" }, "CategoryMetrics": { "properties": { "category": { "type": "string", "title": "Category" }, "sessions_count": { "type": "integer", "title": "Sessions Count" }, "acus": { "type": "number", "title": "Acus" }, "subcategories": { "items": { "$ref": "#/components/schemas/SubcategoryMetrics" }, "type": "array", "title": "Subcategories" } }, "type": "object", "required": [ "category", "sessions_count", "acus", "subcategories" ], "title": "CategoryMetrics" }, "CodeScanCreateRequest": { "properties": { "repo_name": { "type": "string", "title": "Repo Name", "description": "Full name of the repository to scan." }, "host": { "title": "Host", "description": "Git host of the repository, if known.", "nullable": true, "type": "string" }, "profile_id": { "title": "Profile Id", "description": "Scan profile to apply to the scan.", "nullable": true, "type": "string" }, "commit_sha": { "title": "Commit Sha", "description": "Commit to check out before scanning.", "nullable": true, "type": "string" } }, "type": "object", "required": [ "repo_name" ], "title": "CodeScanCreateRequest", "description": "Request body for starting a new code scan." }, "CodeScanFindingResponse": { "properties": { "finding_id": { "type": "string", "title": "Finding Id", "description": "Unique identifier for the finding." }, "title": { "title": "Title", "description": "Title of the finding, if any.", "nullable": true, "type": "string" }, "description": { "title": "Description", "description": "Detailed description of the vulnerability, if any.", "nullable": true, "type": "string" }, "recommendation": { "title": "Recommendation", "description": "Suggested remediation for the finding, if any.", "nullable": true, "type": "string" }, "note": { "title": "Note", "description": "Additional note attached to the finding, if any.", "nullable": true, "type": "string" }, "related_finding_ids": { "items": { "type": "string" }, "type": "array", "title": "Related Finding Ids", "description": "Finding IDs of the other links in a realized attack chain. Set only on the chain's sink finding." }, "code_owners": { "items": { "type": "string" }, "type": "array", "title": "Code Owners", "description": "Code owners associated with the affected code." }, "reference_snippets": { "items": { "$ref": "#/components/schemas/CodeScanReferenceSnippetResponse" }, "type": "array", "title": "Reference Snippets", "description": "Code snippets referenced by the finding as supporting evidence." }, "severity": { "type": "string", "title": "Severity", "description": "Severity of the finding: critical, high, medium, or low.\n\nKnown values: `critical`, `high`, `medium`, `low`. Additional values may be added in the future.", "x-extensible-enum": [ "critical", "high", "medium", "low" ] }, "category": { "title": "Category", "description": "Category (rule name) the finding was classified under, if any.", "nullable": true, "type": "string" }, "repo_name": { "type": "string", "title": "Repo Name", "description": "Repository the finding was reported in." }, "pr_url": { "title": "Pr Url", "description": "URL of the remediation PR opened for this finding, if any.", "nullable": true, "type": "string" }, "scan_id": { "type": "string", "title": "Scan Id", "description": "Identifier of the scan that produced the finding." }, "session_id": { "title": "Session Id", "description": "Session that remediated the finding (and opened the PR), if any.", "nullable": true, "type": "string" }, "orchestrator_session_id": { "title": "Orchestrator Session Id", "description": "Orchestrator session that ran the scan that produced the finding (the scan's Devin session), if any.", "nullable": true, "type": "string" }, "status": { "type": "string", "title": "Status", "description": "Finding status: open, dismissed, or resolved.\n\nKnown values: `open`, `dismissed`, `resolved`. Additional values may be added in the future.", "x-extensible-enum": [ "open", "dismissed", "resolved" ] }, "created_at": { "type": "integer", "title": "Created At", "description": "When the finding was created (unix seconds)." } }, "type": "object", "required": [ "finding_id", "title", "description", "recommendation", "note", "code_owners", "reference_snippets", "severity", "category", "repo_name", "pr_url", "scan_id", "session_id", "orchestrator_session_id", "status", "created_at" ], "title": "CodeScanFindingResponse", "description": "A single code scan finding." }, "CodeScanMetricsResponse": { "properties": { "scans_count": { "type": "integer", "title": "Scans Count", "description": "Number of code scans created within the specified time range." }, "repos_scanned_count": { "type": "integer", "title": "Repos Scanned Count", "description": "Number of distinct repositories scanned." }, "prs_created_count": { "type": "integer", "title": "Prs Created Count", "description": "Number of PRs created by the scans' remediation sessions." }, "prs_open_count": { "type": "integer", "title": "Prs Open Count", "description": "Number of remediation PRs currently in the open state." }, "prs_merged_count": { "type": "integer", "title": "Prs Merged Count", "description": "Number of remediation PRs merged." }, "prs_closed_count": { "type": "integer", "title": "Prs Closed Count", "description": "Number of remediation PRs closed without being merged." }, "avg_pr_time_to_merge_seconds": { "title": "Avg Pr Time To Merge Seconds", "description": "Average time from PR creation to merge, in seconds. Null when no PRs have been merged.", "nullable": true, "type": "number" }, "avg_pr_open_duration_seconds": { "title": "Avg Pr Open Duration Seconds", "description": "Average time a PR is (or was) open, in seconds: creation to merge/close for finished PRs, creation to now for open PRs. Null when no PRs were created.", "nullable": true, "type": "number" }, "open_critical_findings_count": { "type": "integer", "title": "Open Critical Findings Count", "description": "Number of open findings with critical severity." }, "open_high_findings_count": { "type": "integer", "title": "Open High Findings Count", "description": "Number of open findings with high severity." }, "open_medium_findings_count": { "type": "integer", "title": "Open Medium Findings Count", "description": "Number of open findings with medium severity." }, "open_low_findings_count": { "type": "integer", "title": "Open Low Findings Count", "description": "Number of open findings with low severity." } }, "type": "object", "required": [ "scans_count", "repos_scanned_count", "prs_created_count", "prs_open_count", "prs_merged_count", "prs_closed_count", "avg_pr_time_to_merge_seconds", "avg_pr_open_duration_seconds", "open_critical_findings_count", "open_high_findings_count", "open_medium_findings_count", "open_low_findings_count" ], "title": "CodeScanMetricsResponse", "description": "Response model for code scan metrics.\n\nAll metrics are scoped to code scans created within the specified time\nrange: findings and remediation PRs are attributed to the scan that\nproduced them." }, "CodeScanProfileDetailResponse": { "properties": { "profile_id": { "type": "string", "title": "Profile Id", "description": "Unique identifier for the profile." }, "name": { "type": "string", "title": "Name", "description": "Name of the profile." }, "description": { "title": "Description", "description": "Description of the profile, if any.", "nullable": true, "type": "string" }, "visibility": { "type": "string", "title": "Visibility", "description": "Whether the profile is owned by a single organization or shared across the whole account.\n\nKnown values: `org`, `account`. Additional values may be added in the future.", "x-extensible-enum": [ "org", "account" ] }, "org_id": { "title": "Org Id", "description": "Organization that owns the profile. Null when the profile is shared account-wide.", "nullable": true, "type": "string" }, "scan_type": { "type": "string", "title": "Scan Type", "description": "Type of scan the profile configures.\n\nKnown values: `security`. Additional values may be added in the future.", "x-extensible-enum": [ "security" ] }, "mode": { "type": "string", "title": "Mode", "description": "Profile mode: discover or ingest.\n\nKnown values: `discover`, `ingest`. Additional values may be added in the future.", "x-extensible-enum": [ "discover", "ingest" ] }, "include_globs": { "title": "Include Globs", "description": "Glob patterns of files to include in the scan, if any.", "nullable": true, "items": { "type": "string" }, "type": "array" }, "exclude_globs": { "title": "Exclude Globs", "description": "Glob patterns of files to exclude from the scan, if any.", "nullable": true, "items": { "type": "string" }, "type": "array" }, "threat_model_guidance": { "title": "Threat Model Guidance", "description": "Guidance describing the threat model, if any.", "nullable": true, "type": "string" }, "investigation_guidance": { "title": "Investigation Guidance", "description": "Guidance for the investigation phase, if any.", "nullable": true, "type": "string" }, "triage_guidance": { "title": "Triage Guidance", "description": "Guidance for the triage phase, if any.", "nullable": true, "type": "string" }, "validation_guidance": { "title": "Validation Guidance", "description": "Guidance for the validation phase, if any.", "nullable": true, "type": "string" }, "report_guidance": { "title": "Report Guidance", "description": "Guidance for the report phase, if any.", "nullable": true, "type": "string" }, "remediation_guidance": { "title": "Remediation Guidance", "description": "Guidance for the remediation phase, if any.", "nullable": true, "type": "string" }, "ingestion_source_guidance": { "title": "Ingestion Source Guidance", "description": "Guidance describing the ingestion source, if any.", "nullable": true, "type": "string" }, "post_ingestion_guidance": { "title": "Post Ingestion Guidance", "description": "Guidance for the post-ingestion phase, if any.", "nullable": true, "type": "string" }, "created_at": { "type": "integer", "title": "Created At", "description": "When the profile was created (unix seconds)." } }, "type": "object", "required": [ "profile_id", "name", "description", "visibility", "org_id", "scan_type", "mode", "include_globs", "exclude_globs", "threat_model_guidance", "investigation_guidance", "triage_guidance", "validation_guidance", "report_guidance", "remediation_guidance", "ingestion_source_guidance", "post_ingestion_guidance", "created_at" ], "title": "CodeScanProfileDetailResponse", "description": "Full details of a code scan profile, including its guidance." }, "CodeScanProfileResponse": { "properties": { "profile_id": { "type": "string", "title": "Profile Id", "description": "Unique identifier for the profile." }, "name": { "type": "string", "title": "Name", "description": "Name of the profile." } }, "type": "object", "required": [ "profile_id", "name" ], "title": "CodeScanProfileResponse", "description": "Summary of the profile a scan ran under." }, "CodeScanProfileSummaryResponse": { "properties": { "profile_id": { "type": "string", "title": "Profile Id", "description": "Unique identifier for the profile." }, "name": { "type": "string", "title": "Name", "description": "Name of the profile." }, "description": { "title": "Description", "description": "Description of the profile, if any.", "nullable": true, "type": "string" }, "visibility": { "type": "string", "title": "Visibility", "description": "Whether the profile is owned by a single organization or shared across the whole account.\n\nKnown values: `org`, `account`. Additional values may be added in the future.", "x-extensible-enum": [ "org", "account" ] }, "org_id": { "title": "Org Id", "description": "Organization that owns the profile. Null when the profile is shared account-wide.", "nullable": true, "type": "string" }, "scan_type": { "type": "string", "title": "Scan Type", "description": "Type of scan the profile configures.\n\nKnown values: `security`. Additional values may be added in the future.", "x-extensible-enum": [ "security" ] }, "mode": { "type": "string", "title": "Mode", "description": "Profile mode: discover or ingest.\n\nKnown values: `discover`, `ingest`. Additional values may be added in the future.", "x-extensible-enum": [ "discover", "ingest" ] }, "created_at": { "type": "integer", "title": "Created At", "description": "When the profile was created (unix seconds)." } }, "type": "object", "required": [ "profile_id", "name", "description", "visibility", "org_id", "scan_type", "mode", "created_at" ], "title": "CodeScanProfileSummaryResponse", "description": "Summary of a code scan profile, without its guidance." }, "CodeScanReferenceSnippetResponse": { "properties": { "file_path": { "type": "string", "title": "File Path", "description": "Path to the referenced file." }, "start_line": { "type": "integer", "title": "Start Line", "description": "First line of the referenced range." }, "end_line": { "type": "integer", "title": "End Line", "description": "Last line of the referenced range." }, "code": { "title": "Code", "description": "The referenced source code, if captured.", "nullable": true, "type": "string" }, "commentary": { "type": "string", "title": "Commentary", "description": "Explanation of why this snippet is relevant to the finding." } }, "type": "object", "required": [ "file_path", "start_line", "end_line", "commentary" ], "title": "CodeScanReferenceSnippetResponse", "description": "A code snippet referenced by a finding as supporting evidence." }, "CodeScanResponse": { "properties": { "scan_id": { "type": "string", "title": "Scan Id", "description": "Unique identifier for the scan." }, "org_id": { "type": "string", "title": "Org Id", "description": "Organization the scan belongs to." }, "repo_name": { "type": "string", "title": "Repo Name", "description": "Primary repository of the scan. Multi-repo scans cover additional repositories not listed here." }, "host": { "title": "Host", "description": "Git host of the repository, if known.", "nullable": true, "type": "string" }, "status": { "type": "string", "title": "Status", "description": "Scan status: waiting, pending, running, awaiting_user_input, completed, failed, or cancelled.\n\nKnown values: `waiting`, `pending`, `running`, `awaiting_user_input`, `completed`, `failed`, `cancelled`. Additional values may be added in the future.", "x-extensible-enum": [ "waiting", "pending", "running", "awaiting_user_input", "completed", "failed", "cancelled" ] }, "profile": { "description": "Profile the scan ran under, if any.", "nullable": true, "type": "object" }, "created_at": { "type": "integer", "title": "Created At", "description": "When the scan was created (unix seconds)." } }, "type": "object", "required": [ "scan_id", "org_id", "repo_name", "host", "status", "profile", "created_at" ], "title": "CodeScanResponse", "description": "A single code scan." }, "ConsumptionByDateResponse": { "properties": { "date": { "type": "integer", "title": "Date" }, "acus": { "type": "number", "title": "Acus" }, "acus_by_product": { "$ref": "#/components/schemas/AcusByProduct" } }, "type": "object", "required": [ "date", "acus", "acus_by_product" ], "title": "ConsumptionByDateResponse" }, "ConsumptionCycle": { "properties": { "before": { "type": "integer", "title": "Before" }, "after": { "type": "integer", "title": "After" } }, "type": "object", "required": [ "before", "after" ], "title": "ConsumptionCycle" }, "ConsumptionResponse": { "properties": { "total_acus": { "type": "number", "title": "Total Acus" }, "consumption_by_date": { "items": { "$ref": "#/components/schemas/ConsumptionByDateResponse" }, "type": "array", "title": "Consumption By Date" } }, "type": "object", "required": [ "total_acus", "consumption_by_date" ], "title": "ConsumptionResponse" }, "CreateApiKeyRequest": { "properties": { "name": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Name" }, "expires_at": { "title": "Expires At", "description": "Optional expiration as a UNIX timestamp in seconds. Must be in the future if provided.", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "name" ], "title": "CreateApiKeyRequest" }, "CreateEnterpriseBlueprintBody": { "properties": { "contents": { "title": "Contents", "description": "YAML body for the new blueprint. Omit to create an empty blueprint.", "nullable": true, "type": "string" } }, "type": "object", "title": "CreateEnterpriseBlueprintBody" }, "CreateOrgBlueprintBody": { "properties": { "repo_name": { "title": "Repo Name", "description": "If set, creates a repo-tier blueprint for that repository. If omitted, creates an org-wide (org-tier) blueprint.", "nullable": true, "type": "string" }, "contents": { "title": "Contents", "description": "Optional initial YAML body for the blueprint.", "nullable": true, "type": "string" } }, "type": "object", "title": "CreateOrgBlueprintBody" }, "CursorPaginationParams": { "properties": { "after": { "title": "After", "nullable": true, "type": "string" }, "first": { "type": "integer", "maximum": 200, "minimum": 1, "title": "First", "default": 100 } }, "type": "object", "title": "CursorPaginationParams" }, "DefaultTagRequest": { "properties": { "tag": { "type": "string", "title": "Tag" } }, "type": "object", "required": [ "tag" ], "title": "DefaultTagRequest" }, "DefaultTagResponse": { "properties": { "default_tag": { "title": "Default Tag", "nullable": true, "type": "string" } }, "type": "object", "required": [ "default_tag" ], "title": "DefaultTagResponse" }, "DevinBrainUserSelf": { "properties": { "principal_type": { "type": "string", "title": "Principal Type", "x-extensible-enum": [ "devin_brain" ], "description": "Known values: `devin_brain`. Additional values may be added in the future." }, "devin_id": { "type": "string", "title": "Devin Id" }, "org_id": { "type": "string", "title": "Org Id" }, "user_id": { "type": "string", "title": "User Id" }, "creator_service_user_id": { "title": "Creator Service User Id", "nullable": true, "type": "string" } }, "type": "object", "required": [ "principal_type", "devin_id", "org_id", "user_id" ], "title": "DevinBrainUserSelf", "description": "Identity information for an authenticated Devin brain session." }, "FolderSummary": { "properties": { "folder_id": { "type": "string", "title": "Folder Id" }, "name": { "type": "string", "title": "Name" }, "parent_folder_id": { "title": "Parent Folder Id", "nullable": true, "type": "string" }, "path": { "type": "string", "title": "Path" }, "note_count": { "type": "integer", "title": "Note Count" } }, "type": "object", "required": [ "folder_id", "name", "path", "note_count" ], "title": "FolderSummary", "description": "One folder in the knowledge folder tree." }, "FolderTreeResponse": { "properties": { "folders": { "items": { "$ref": "#/components/schemas/FolderSummary" }, "type": "array", "title": "Folders" }, "root_note_count": { "type": "integer", "title": "Root Note Count" } }, "type": "object", "required": [ "folders", "root_note_count" ], "title": "FolderTreeResponse", "description": "Response for the folder-structure endpoint." }, "GitConnectionRepositoryResponse": { "properties": { "provider_repository_id": { "type": "string", "title": "Provider Repository Id" }, "git_connection_id": { "type": "string", "title": "Git Connection Id" }, "git_connection_host": { "type": "string", "title": "Git Connection Host" }, "repo_name": { "type": "string", "title": "Repo Name" }, "repo_path": { "type": "string", "title": "Repo Path" }, "repo_description": { "title": "Repo Description", "nullable": true, "type": "string" }, "last_updated_at": { "title": "Last Updated At", "nullable": true, "type": "integer" }, "repo_language": { "title": "Repo Language", "nullable": true, "type": "string" } }, "type": "object", "required": [ "provider_repository_id", "git_connection_id", "git_connection_host", "repo_name", "repo_path", "repo_description", "last_updated_at", "repo_language" ], "title": "GitConnectionRepositoryResponse" }, "GitConnectionResponse": { "properties": { "git_connection_id": { "type": "string", "title": "Git Connection Id" }, "git_provider_type": { "type": "string", "title": "Git Provider Type", "x-extensible-enum": [ "github_token", "github_individual_token", "github_app", "gitlab_token", "gitlab_oauth", "azure_devops_oauth", "bitbucket_oauth", "bitbucket_token" ], "description": "Known values: `github_token`, `github_individual_token`, `github_app`, `gitlab_token`, `gitlab_oauth`, `azure_devops_oauth`, `bitbucket_oauth`, `bitbucket_token`. Additional values may be added in the future." }, "name": { "title": "Name", "nullable": true, "type": "string" }, "host": { "type": "string", "title": "Host" }, "created_at": { "type": "integer", "title": "Created At" } }, "type": "object", "required": [ "git_connection_id", "git_provider_type", "name", "host", "created_at" ], "title": "GitConnectionResponse" }, "GitPermissionBulkCreateRequest": { "properties": { "permissions": { "items": { "$ref": "#/components/schemas/GitPermissionCreateRequest" }, "type": "array", "maxItems": 200, "title": "Permissions" } }, "type": "object", "required": [ "permissions" ], "title": "GitPermissionBulkCreateRequest" }, "GitPermissionCreateRequest": { "properties": { "git_connection_id": { "type": "string", "title": "Git Connection Id" }, "repo_path": { "title": "Repo Path", "nullable": true, "type": "string" }, "group_prefix": { "title": "Group Prefix", "nullable": true, "type": "string" }, "prefix_path": { "title": "Prefix Path", "nullable": true, "type": "string" }, "read_only": { "type": "boolean", "title": "Read Only", "default": false } }, "type": "object", "required": [ "git_connection_id" ], "title": "GitPermissionCreateRequest" }, "GitPermissionResponse": { "properties": { "git_permission_id": { "type": "string", "title": "Git Permission Id" }, "git_connection_id": { "type": "string", "title": "Git Connection Id" }, "repo_path": { "title": "Repo Path", "nullable": true, "type": "string" }, "group_prefix": { "title": "Group Prefix", "nullable": true, "type": "string" }, "prefix_path": { "title": "Prefix Path", "nullable": true, "type": "string" }, "read_only": { "type": "boolean", "title": "Read Only", "default": false }, "created_at": { "title": "Created At", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "git_permission_id", "git_connection_id" ], "title": "GitPermissionResponse" }, "GitPermissionUpdateRequest": { "properties": { "read_only": { "title": "Read Only", "nullable": true, "type": "boolean" } }, "type": "object", "title": "GitPermissionUpdateRequest" }, "GuardrailViolationResponse": { "properties": { "violation_id": { "type": "integer", "title": "Violation Id" }, "org_id": { "type": "string", "title": "Org Id" }, "session_id": { "title": "Session Id", "nullable": true, "type": "string" }, "event_id": { "type": "string", "title": "Event Id" }, "guardrail_id": { "type": "string", "title": "Guardrail Id" }, "guardrail_name": { "type": "string", "title": "Guardrail Name" }, "confidence_score": { "type": "number", "title": "Confidence Score" }, "action_taken": { "type": "string", "title": "Action Taken" }, "reasoning": { "type": "string", "title": "Reasoning" }, "user_message": { "type": "string", "title": "User Message" }, "created_at": { "type": "integer", "title": "Created At" } }, "type": "object", "required": [ "violation_id", "org_id", "session_id", "event_id", "guardrail_id", "guardrail_name", "confidence_score", "action_taken", "reasoning", "user_message", "created_at" ], "title": "GuardrailViolationResponse" }, "HypervisorResponse": { "properties": { "hypervisor_id": { "type": "string", "title": "Hypervisor Id" }, "status": { "type": "string", "title": "Status" }, "utilization_percentage": { "type": "number", "title": "Utilization Percentage" }, "created_at": { "title": "Created At", "nullable": true, "type": "integer" }, "last_heartbeat": { "title": "Last Heartbeat", "nullable": true, "type": "integer" }, "cloud_provider_instance_id": { "title": "Cloud Provider Instance Id", "nullable": true, "type": "string" } }, "type": "object", "required": [ "hypervisor_id", "status", "utilization_percentage", "created_at", "last_heartbeat", "cloud_provider_instance_id" ], "title": "HypervisorResponse" }, "IdpGroup": { "properties": { "idp_group_name": { "type": "string", "title": "Idp Group Name" }, "role_assignments": { "items": { "$ref": "#/components/schemas/RoleAssignment" }, "type": "array", "title": "Role Assignments" } }, "type": "object", "required": [ "idp_group_name", "role_assignments" ], "title": "IdpGroup" }, "IdpGroupResponse": { "properties": { "idp_group_name": { "type": "string", "title": "Idp Group Name" } }, "type": "object", "required": [ "idp_group_name" ], "title": "IdpGroupResponse" }, "IdpGroupUpdateRoleRequest": { "properties": { "role_id": { "type": "string", "title": "Role Id" } }, "type": "object", "required": [ "role_id" ], "title": "IdpGroupUpdateRoleRequest" }, "IdpGroupUser": { "properties": { "user_id": { "type": "string", "title": "User Id" }, "email": { "title": "Email", "nullable": true, "type": "string" }, "name": { "title": "Name", "nullable": true, "type": "string" }, "idp_role_assignments": { "items": { "$ref": "#/components/schemas/IdpRoleAssignment" }, "type": "array", "title": "Idp Role Assignments" } }, "type": "object", "required": [ "user_id", "email", "name", "idp_role_assignments" ], "title": "IdpGroupUser", "description": "A user whose membership is derived from IDP group assignments." }, "IdpGroupsBulkCreateRequest": { "properties": { "idp_group_names": { "items": { "type": "string" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Idp Group Names" } }, "type": "object", "required": [ "idp_group_names" ], "title": "IdpGroupsBulkCreateRequest" }, "IdpRoleAssignment": { "properties": { "role": { "$ref": "#/components/schemas/Role" }, "org_id": { "title": "Org Id", "nullable": true, "type": "string" }, "idp_group_name": { "type": "string", "title": "Idp Group Name" } }, "type": "object", "required": [ "role", "idp_group_name" ], "title": "IdpRoleAssignment", "description": "A role assignment inherited via IDP group membership." }, "IndexRepositoryRequest": { "properties": { "branch_names": { "items": { "type": "string" }, "type": "array", "title": "Branch Names" } }, "type": "object", "title": "IndexRepositoryRequest" }, "IpAccessListAddRequest": { "properties": { "ip_ranges": { "items": { "type": "string" }, "type": "array", "title": "Ip Ranges" } }, "type": "object", "required": [ "ip_ranges" ], "title": "IpAccessListAddRequest" }, "IpAccessListReplaceRequest": { "properties": { "ip_ranges": { "items": { "type": "string" }, "type": "array", "title": "Ip Ranges" } }, "type": "object", "required": [ "ip_ranges" ], "title": "IpAccessListReplaceRequest" }, "IpAccessListResponse": { "properties": { "ip_ranges": { "items": { "type": "string" }, "type": "array", "title": "Ip Ranges" } }, "type": "object", "required": [ "ip_ranges" ], "title": "IpAccessListResponse" }, "KnowledgeNoteCreateRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "body": { "type": "string", "title": "Body" }, "trigger": { "type": "string", "title": "Trigger" }, "pinned_repo": { "title": "Pinned Repo", "nullable": true, "type": "string" }, "folder_id": { "title": "Folder Id", "nullable": true, "type": "string" }, "is_enabled": { "title": "Is Enabled", "nullable": true, "type": "boolean" } }, "type": "object", "required": [ "name", "body", "trigger" ], "title": "KnowledgeNoteCreateRequest" }, "KnowledgeNoteResponse": { "properties": { "note_id": { "type": "string", "title": "Note Id" }, "folder_id": { "title": "Folder Id", "nullable": true, "type": "string" }, "folder_path": { "type": "string", "title": "Folder Path" }, "name": { "type": "string", "title": "Name" }, "body": { "type": "string", "title": "Body" }, "trigger": { "type": "string", "title": "Trigger" }, "is_enabled": { "type": "boolean", "title": "Is Enabled" }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" }, "access_type": { "type": "string", "title": "Access Type", "x-extensible-enum": [ "enterprise", "org" ], "description": "Known values: `enterprise`, `org`. Additional values may be added in the future." }, "org_id": { "title": "Org Id", "nullable": true, "type": "string" }, "macro": { "title": "Macro", "nullable": true, "type": "string" }, "pinned_repo": { "title": "Pinned Repo", "nullable": true, "type": "string" } }, "type": "object", "required": [ "note_id", "folder_id", "folder_path", "name", "body", "trigger", "is_enabled", "created_at", "updated_at", "access_type", "org_id", "macro", "pinned_repo" ], "title": "KnowledgeNoteResponse" }, "OrgGroupConfig": { "properties": { "org_ids": { "items": { "type": "string" }, "type": "array", "uniqueItems": true, "title": "Org Ids" }, "max_cycle_acus": { "title": "Max Cycle Acus", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "org_ids" ], "title": "OrgGroupConfig" }, "OrgGroupsConfig": { "properties": { "groups": { "additionalProperties": { "$ref": "#/components/schemas/OrgGroupConfig" }, "type": "object", "title": "Groups" } }, "type": "object", "required": [ "groups" ], "title": "OrgGroupsConfig", "description": "Configuration mapping group names to their settings." }, "OrganizationCreateRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "max_session_acu_limit": { "title": "Max Session Acu Limit", "nullable": true, "type": "integer" }, "max_cycle_acu_limit": { "title": "Max Cycle Acu Limit", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "name" ], "title": "OrganizationCreateRequest" }, "OrganizationResponse": { "properties": { "org_id": { "type": "string", "title": "Org Id" }, "name": { "type": "string", "title": "Name" }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" }, "max_session_acu_limit": { "title": "Max Session Acu Limit", "nullable": true, "type": "integer" }, "max_cycle_acu_limit": { "title": "Max Cycle Acu Limit", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "org_id", "name", "created_at", "updated_at", "max_session_acu_limit", "max_cycle_acu_limit" ], "title": "OrganizationResponse" }, "OrganizationUpdateRequest": { "properties": { "name": { "title": "Name", "nullable": true, "type": "string" }, "max_session_acu_limit": { "title": "Max Session Acu Limit", "nullable": true, "type": "integer" }, "max_cycle_acu_limit": { "title": "Max Cycle Acu Limit", "nullable": true, "type": "integer" } }, "type": "object", "title": "OrganizationUpdateRequest" }, "PaginatedResponse_ACULimitResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ACULimitResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[ACULimitResponse]" }, "PaginatedResponse_ApiKeyResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ApiKeyResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[ApiKeyResponse]" }, "PaginatedResponse_AuditLogResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/AuditLogResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[AuditLogResponse]" }, "PaginatedResponse_Build_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Build" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[Build]" }, "PaginatedResponse_CodeScanFindingResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CodeScanFindingResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[CodeScanFindingResponse]" }, "PaginatedResponse_CodeScanProfileSummaryResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CodeScanProfileSummaryResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[CodeScanProfileSummaryResponse]" }, "PaginatedResponse_CodeScanResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CodeScanResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[CodeScanResponse]" }, "PaginatedResponse_ConsumptionCycle_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ConsumptionCycle" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[ConsumptionCycle]" }, "PaginatedResponse_GitConnectionRepositoryResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/GitConnectionRepositoryResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[GitConnectionRepositoryResponse]" }, "PaginatedResponse_GitConnectionResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/GitConnectionResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[GitConnectionResponse]" }, "PaginatedResponse_GitPermissionResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/GitPermissionResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[GitPermissionResponse]" }, "PaginatedResponse_GuardrailViolationResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/GuardrailViolationResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[GuardrailViolationResponse]" }, "PaginatedResponse_HypervisorResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/HypervisorResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[HypervisorResponse]" }, "PaginatedResponse_IdpGroupResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/IdpGroupResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[IdpGroupResponse]" }, "PaginatedResponse_IdpGroupUser_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/IdpGroupUser" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[IdpGroupUser]" }, "PaginatedResponse_IdpGroup_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/IdpGroup" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[IdpGroup]" }, "PaginatedResponse_KnowledgeNoteResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/KnowledgeNoteResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[KnowledgeNoteResponse]" }, "PaginatedResponse_OrganizationResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/OrganizationResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[OrganizationResponse]" }, "PaginatedResponse_PlaybookResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/PlaybookResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[PlaybookResponse]" }, "PaginatedResponse_RepositoryIndexingResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RepositoryIndexingResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[RepositoryIndexingResponse]" }, "PaginatedResponse_RepositoryResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RepositoryResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[RepositoryResponse]" }, "PaginatedResponse_Role_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Role" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[Role]" }, "PaginatedResponse_ScheduleResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ScheduleResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[ScheduleResponse]" }, "PaginatedResponse_SecretResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SecretResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[SecretResponse]" }, "PaginatedResponse_ServiceUser_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ServiceUser" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[ServiceUser]" }, "PaginatedResponse_SessionInsightsResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SessionInsightsResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[SessionInsightsResponse]" }, "PaginatedResponse_SessionMessage_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SessionMessage" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[SessionMessage]" }, "PaginatedResponse_SessionResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SessionResponse" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[SessionResponse]" }, "PaginatedResponse_User_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/User" }, "type": "array", "title": "Items" }, "end_cursor": { "title": "End Cursor", "description": "Cursor to fetch the next page, or None if this is the last page.", "nullable": true, "type": "string" }, "has_next_page": { "type": "boolean", "title": "Has Next Page", "description": "Whether there are more items available after this page.", "default": false }, "total": { "title": "Total", "description": "Optional total count (can be omitted for performance).", "nullable": true, "type": "integer" } }, "type": "object", "required": [ "items" ], "title": "PaginatedResponse[User]" }, "PatUserSelf": { "properties": { "principal_type": { "type": "string", "title": "Principal Type", "x-extensible-enum": [ "pat_user" ], "description": "Known values: `pat_user`. Additional values may be added in the future." }, "user_id": { "type": "string", "title": "User Id" }, "user_name": { "type": "string", "title": "User Name" }, "api_key_id": { "type": "string", "title": "Api Key Id" }, "api_key_name": { "type": "string", "title": "Api Key Name" }, "org_id": { "title": "Org Id", "nullable": true, "type": "string" } }, "type": "object", "required": [ "principal_type", "user_id", "user_name", "api_key_id", "api_key_name" ], "title": "PatUserSelf", "description": "Identity information for an authenticated PAT user." }, "PinBuildBody": { "properties": {}, "type": "object", "title": "PinBuildBody", "description": "``POST /builds/{id}/pin`` body. Empty per spec." }, "PlaybookCreateRequest": { "properties": { "title": { "type": "string", "title": "Title" }, "body": { "type": "string", "title": "Body" }, "macro": { "title": "Macro", "description": "Playbook macro identifier. Must start with '!' followed by one or more letters, digits, underscores, or hyphens. Example: '!my_macro' or '!my-macro'", "nullable": true, "type": "string" }, "structured_output_schema": { "title": "Structured Output Schema", "description": "JSON Schema (Draft 7) that sessions using this playbook will produce as structured output. Max 64KB. Must be self-contained (no external $ref).", "nullable": true, "additionalProperties": true, "type": "object" } }, "type": "object", "required": [ "title", "body" ], "title": "PlaybookCreateRequest" }, "PlaybookInfo": { "properties": { "playbook_id": { "type": "string", "title": "Playbook Id" }, "title": { "title": "Title", "nullable": true, "type": "string" } }, "type": "object", "required": [ "playbook_id", "title" ], "title": "PlaybookInfo" }, "PlaybookResponse": { "properties": { "playbook_id": { "type": "string", "title": "Playbook Id" }, "title": { "type": "string", "title": "Title" }, "body": { "type": "string", "title": "Body" }, "macro": { "title": "Macro", "nullable": true, "type": "string" }, "created_by": { "type": "string", "title": "Created By" }, "updated_by": { "type": "string", "title": "Updated By" }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" }, "access_type": { "type": "string", "title": "Access Type", "x-extensible-enum": [ "enterprise", "org" ], "description": "Known values: `enterprise`, `org`. Additional values may be added in the future." }, "org_id": { "title": "Org Id", "nullable": true, "type": "string" }, "structured_output_schema": { "title": "Structured Output Schema", "nullable": true, "additionalProperties": true, "type": "object" } }, "type": "object", "required": [ "playbook_id", "title", "body", "macro", "created_by", "updated_by", "created_at", "updated_at", "access_type", "org_id" ], "title": "PlaybookResponse" }, "PrMetricsResponse": { "properties": { "prs_created_count": { "type": "integer", "title": "Prs Created Count", "description": "Total PRs Devin authored across all states (open + merged + closed)." }, "prs_opened_count": { "type": "integer", "title": "Prs Opened Count", "description": "PRs Devin authored that are currently open." }, "prs_merged_count": { "type": "integer", "title": "Prs Merged Count", "description": "PRs Devin authored that were merged." }, "prs_closed_count": { "type": "integer", "title": "Prs Closed Count", "description": "PRs Devin authored that were closed without merging." }, "prs_taken_over_count": { "type": "integer", "title": "Prs Taken Over Count", "description": "Total PRs Devin took over across all states (open + merged + closed). A take-over is when Devin pushed commits to a PR it did not originally create.", "default": 0 }, "prs_taken_over_opened_count": { "type": "integer", "title": "Prs Taken Over Opened Count", "description": "PRs Devin took over that are currently open.", "default": 0 }, "prs_taken_over_merged_count": { "type": "integer", "title": "Prs Taken Over Merged Count", "description": "PRs Devin took over that were merged.", "default": 0 }, "prs_taken_over_closed_count": { "type": "integer", "title": "Prs Taken Over Closed Count", "description": "PRs Devin took over that were closed without merging.", "default": 0 } }, "type": "object", "required": [ "prs_created_count", "prs_opened_count", "prs_merged_count", "prs_closed_count" ], "title": "PrMetricsResponse", "description": "Response model for PR metrics." }, "PrReviewCreateRequest": { "properties": { "pr_url": { "type": "string", "title": "Pr Url", "description": "Full URL of the pull/merge request to review (e.g. `https://github.com/owner/repo/pull/123`).", "example": "https://github.com/owner/repo/pull/123" } }, "type": "object", "required": [ "pr_url" ], "title": "PrReviewCreateRequest" }, "PrReviewResponse": { "properties": { "status": { "type": "string", "title": "Status", "description": "Current review status. Newly accepted reviews start as `pending`.\n\nKnown values: `pending`, `running`, `completed`, `errored`, `cancelled`. Additional values may be added in the future.", "x-extensible-enum": [ "pending", "running", "completed", "errored", "cancelled" ] }, "repo_path": { "type": "string", "title": "Repo Path", "description": "Normalized host-prefixed repo path (e.g. `github.com/owner/repo`)." }, "pr_number": { "type": "integer", "title": "Pr Number", "description": "Pull/merge request number." }, "commit_sha": { "type": "string", "title": "Commit Sha", "description": "Commit SHA of the PR head that will be reviewed." }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "When the review was accepted." } }, "type": "object", "required": [ "status", "repo_path", "pr_number", "commit_sha", "created_at" ], "title": "PrReviewResponse" }, "PresignedDownload": { "properties": { "url": { "type": "string", "title": "Url", "description": "Presigned GET URL (HTTPS)." }, "expires_at": { "type": "integer", "title": "Expires At", "description": "Unix timestamp at which the URL expires." } }, "type": "object", "required": [ "url", "expires_at" ], "title": "PresignedDownload", "description": "Reusable presigned-URL response (10-minute TTL)." }, "ProblemDetail": { "properties": { "type": { "type": "string", "title": "Type", "description": "A URI reference identifying the problem type.", "default": "about:blank" }, "title": { "type": "string", "title": "Title", "description": "A short, human-readable summary of the problem type." }, "status": { "type": "integer", "title": "Status", "description": "The HTTP status code." }, "detail": { "title": "Detail", "description": "A human-readable explanation specific to this occurrence.", "nullable": true, "type": "string" }, "instance": { "title": "Instance", "description": "A URI reference (the request path) for this occurrence.", "nullable": true, "type": "string" }, "errors": { "title": "Errors", "description": "Field-level validation errors (422 responses only).", "nullable": true, "items": { "additionalProperties": true, "type": "object" }, "type": "array" } }, "type": "object", "required": [ "title", "status" ], "title": "ProblemDetail", "description": "RFC 9457 application/problem+json error body for the v3 API.\n\ndetail is retained from the legacy {\"detail\": ...} body for back-compat; the\nother members are additive. errors carries field-level validation failures\n(422 only)." }, "QueueResponse": { "properties": { "queue_size": { "type": "integer", "title": "Queue Size" }, "status": { "type": "string", "title": "Status", "x-extensible-enum": [ "normal", "elevated", "high" ], "description": "Known values: `normal`, `elevated`, `high`. Additional values may be added in the future." } }, "type": "object", "required": [ "queue_size", "status" ], "title": "QueueResponse", "description": "Response model for queue endpoint." }, "RemediateFindingResponse": { "properties": { "finding_id": { "type": "string", "title": "Finding Id", "description": "The finding that is being remediated." }, "session_id": { "type": "string", "title": "Session Id", "description": "ID of the Devin session launched to remediate the finding." } }, "type": "object", "required": [ "finding_id", "session_id" ], "title": "RemediateFindingResponse", "description": "The remediation session launched for a code scan finding." }, "RemoveRepositoriesRequest": { "properties": { "repository_paths": { "items": { "type": "string" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Repository Paths" } }, "type": "object", "required": [ "repository_paths" ], "title": "RemoveRepositoriesRequest" }, "RepoIndexJobResponse": { "properties": { "job_id": { "type": "string", "title": "Job Id" }, "status": { "type": "string", "title": "Status", "x-extensible-enum": [ "failed", "completed", "in_progress" ], "description": "Known values: `failed`, `completed`, `in_progress`. Additional values may be added in the future." }, "commit": { "type": "string", "title": "Commit" }, "branch_name": { "title": "Branch Name", "nullable": true, "type": "string" }, "created_at": { "type": "integer", "title": "Created At" } }, "type": "object", "required": [ "job_id", "status", "commit", "branch_name", "created_at" ], "title": "RepoIndexJobResponse" }, "RepoIndexingStatusResponse": { "properties": { "indexing_enabled": { "type": "boolean", "title": "Indexing Enabled" }, "latest_indexes": { "items": { "$ref": "#/components/schemas/RepoIndexJobResponse" }, "type": "array", "title": "Latest Indexes" }, "latest_completed_search_index_job": { "nullable": true, "type": "object" }, "latest_completed_wiki_index_job": { "nullable": true, "type": "object" } }, "type": "object", "required": [ "indexing_enabled", "latest_indexes", "latest_completed_search_index_job", "latest_completed_wiki_index_job" ], "title": "RepoIndexingStatusResponse" }, "RepositoryIndexingItem": { "properties": { "repository_path": { "type": "string", "title": "Repository Path", "description": "e.g., 'org/repo-name'" }, "branch_names": { "items": { "type": "string" }, "type": "array", "title": "Branch Names" } }, "type": "object", "required": [ "repository_path" ], "title": "RepositoryIndexingItem" }, "RepositoryIndexingResponse": { "properties": { "repository_path": { "type": "string", "title": "Repository Path" }, "indexing_enabled": { "type": "boolean", "title": "Indexing Enabled" }, "branches": { "items": { "type": "string" }, "type": "array", "title": "Branches" }, "indexing_status": { "nullable": true, "type": "object" } }, "type": "object", "required": [ "repository_path", "indexing_enabled", "branches" ], "title": "RepositoryIndexingResponse" }, "RepositoryResponse": { "properties": { "provider_repository_id": { "type": "string", "title": "Provider Repository Id" }, "git_connection_id": { "type": "string", "title": "Git Connection Id" }, "git_connection_host": { "type": "string", "title": "Git Connection Host" }, "repo_name": { "type": "string", "title": "Repo Name" }, "repo_path": { "type": "string", "title": "Repo Path" }, "repo_description": { "title": "Repo Description", "nullable": true, "type": "string" }, "last_updated_at": { "title": "Last Updated At", "nullable": true, "type": "integer" }, "repo_language": { "title": "Repo Language", "nullable": true, "type": "string" }, "indexing_status": { "nullable": true, "type": "object" } }, "type": "object", "required": [ "provider_repository_id", "git_connection_id", "git_connection_host", "repo_name", "repo_path", "repo_description", "last_updated_at", "repo_language", "indexing_status" ], "title": "RepositoryResponse" }, "Role": { "properties": { "role_name": { "type": "string", "title": "Role Name" }, "role_id": { "type": "string", "title": "Role Id" }, "role_type": { "type": "string", "title": "Role Type", "x-extensible-enum": [ "enterprise", "org" ], "description": "Known values: `enterprise`, `org`. Additional values may be added in the future." } }, "type": "object", "required": [ "role_name", "role_id", "role_type" ], "title": "Role" }, "RoleAssignment": { "properties": { "role": { "$ref": "#/components/schemas/Role" }, "org_id": { "title": "Org Id", "nullable": true, "type": "string" } }, "type": "object", "required": [ "role" ], "title": "RoleAssignment" }, "RotateApiKeyRequest": { "properties": { "new_key_expires_at": { "title": "New Key Expires At", "description": "Optional expiration for the new key as a UNIX timestamp in seconds. Null for no expiration.", "nullable": true, "type": "integer" }, "revoke_current": { "type": "boolean", "title": "Revoke Current", "description": "Whether to revoke the current key. Set to False for graceful rollover.", "default": true } }, "type": "object", "title": "RotateApiKeyRequest" }, "ScheduleCreateRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "prompt": { "type": "string", "title": "Prompt" }, "playbook_id": { "title": "Playbook Id", "nullable": true, "type": "string" }, "frequency": { "title": "Frequency", "nullable": true, "type": "string" }, "interval_count": { "type": "integer", "title": "Interval Count", "default": 1 }, "schedule_type": { "type": "string", "title": "Schedule Type", "default": "recurring", "x-extensible-enum": [ "recurring", "one_time" ], "description": "Known values: `recurring`, `one_time`. Additional values may be added in the future." }, "scheduled_at": { "title": "Scheduled At", "nullable": true, "type": "string", "format": "date-time" }, "notify_on": { "type": "string", "title": "Notify On", "default": "failure", "x-extensible-enum": [ "always", "failure", "never" ], "description": "Known values: `always`, `failure`, `never`. Additional values may be added in the future." }, "agent": { "type": "string", "title": "Agent", "default": "devin", "x-extensible-enum": [ "devin", "data_analyst" ], "description": "Known values: `devin`, `data_analyst`. Additional values may be added in the future." }, "bypass_approval": { "type": "boolean", "title": "Bypass Approval", "default": false }, "create_as_user_id": { "title": "Create As User Id", "nullable": true, "type": "string" }, "slack_channel_id": { "title": "Slack Channel Id", "nullable": true, "type": "string" }, "slack_team_id": { "title": "Slack Team Id", "nullable": true, "type": "string" }, "tags": { "title": "Tags", "nullable": true, "items": { "type": "string" }, "type": "array" }, "target_devin_id": { "title": "Target Devin Id", "nullable": true, "type": "string" }, "platform": { "title": "Platform", "description": "VM platform for sessions spawned by this schedule (e.g. 'windows'). When omitted, sessions fall back to the org's default platform at trigger time. Value must match a platform configured for the organization (case-insensitive); unknown values are rejected with a 400 that lists the available platform labels.", "nullable": true, "type": "string" } }, "type": "object", "required": [ "name", "prompt" ], "title": "ScheduleCreateRequest" }, "ScheduleResponse": { "properties": { "scheduled_session_id": { "type": "string", "title": "Scheduled Session Id" }, "org_id": { "type": "string", "title": "Org Id" }, "created_by": { "title": "Created By", "nullable": true, "type": "string" }, "last_edited_by": { "title": "Last Edited By", "nullable": true, "type": "string" }, "name": { "type": "string", "title": "Name" }, "prompt": { "type": "string", "title": "Prompt" }, "playbook": { "nullable": true, "type": "object" }, "frequency": { "title": "Frequency", "nullable": true, "type": "string" }, "interval_count": { "type": "integer", "title": "Interval Count", "default": 1 }, "schedule_type": { "type": "string", "title": "Schedule Type", "default": "recurring", "x-extensible-enum": [ "recurring", "one_time" ], "description": "Known values: `recurring`, `one_time`. Additional values may be added in the future." }, "scheduled_at": { "title": "Scheduled At", "nullable": true, "type": "string", "format": "date-time" }, "enabled": { "type": "boolean", "title": "Enabled" }, "last_executed_at": { "title": "Last Executed At", "nullable": true, "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "last_error_at": { "title": "Last Error At", "nullable": true, "type": "string", "format": "date-time" }, "last_error_message": { "title": "Last Error Message", "nullable": true, "type": "string" }, "consecutive_failures": { "type": "integer", "title": "Consecutive Failures" }, "notify_on": { "type": "string", "title": "Notify On", "x-extensible-enum": [ "always", "failure", "never" ], "description": "Known values: `always`, `failure`, `never`. Additional values may be added in the future." }, "agent": { "type": "string", "title": "Agent", "x-extensible-enum": [ "devin", "data_analyst" ], "description": "Known values: `devin`, `data_analyst`. Additional values may be added in the future." }, "bypass_approval": { "type": "boolean", "title": "Bypass Approval", "default": false }, "slack_channel_id": { "title": "Slack Channel Id", "nullable": true, "type": "string" }, "slack_team_id": { "title": "Slack Team Id", "nullable": true, "type": "string" }, "tags": { "title": "Tags", "nullable": true, "items": { "type": "string" }, "type": "array" }, "target_devin_id": { "title": "Target Devin Id", "nullable": true, "type": "string" }, "platform": { "title": "Platform", "nullable": true, "type": "string" } }, "type": "object", "required": [ "scheduled_session_id", "org_id", "created_by", "name", "prompt", "playbook", "frequency", "enabled", "last_executed_at", "created_at", "updated_at", "last_error_at", "last_error_message", "consecutive_failures", "notify_on", "agent" ], "title": "ScheduleResponse" }, "ScheduleUpdateRequest": { "properties": { "name": { "title": "Name", "nullable": true, "type": "string" }, "prompt": { "title": "Prompt", "nullable": true, "type": "string" }, "playbook_id": { "title": "Playbook Id", "nullable": true, "type": "string" }, "frequency": { "title": "Frequency", "nullable": true, "type": "string" }, "interval_count": { "title": "Interval Count", "nullable": true, "type": "integer" }, "schedule_type": { "title": "Schedule Type", "nullable": true, "type": "string", "x-extensible-enum": [ "recurring", "one_time" ], "description": "Known values: `recurring`, `one_time`. Additional values may be added in the future." }, "scheduled_at": { "title": "Scheduled At", "nullable": true, "type": "string", "format": "date-time" }, "enabled": { "title": "Enabled", "nullable": true, "type": "boolean" }, "notify_on": { "title": "Notify On", "nullable": true, "type": "string", "x-extensible-enum": [ "always", "failure", "never" ], "description": "Known values: `always`, `failure`, `never`. Additional values may be added in the future." }, "agent": { "title": "Agent", "nullable": true, "type": "string", "x-extensible-enum": [ "devin", "data_analyst" ], "description": "Known values: `devin`, `data_analyst`. Additional values may be added in the future." }, "bypass_approval": { "title": "Bypass Approval", "nullable": true, "type": "boolean" }, "run_as_user_id": { "title": "Run As User Id", "description": "Set the user ID that this schedule will run as. Requires ImpersonateOrgSessions permission. Setting to null reverts to the default bot user. Omitting the field leaves the current identity unchanged.", "nullable": true, "type": "string" }, "slack_channel_id": { "title": "Slack Channel Id", "nullable": true, "type": "string" }, "slack_team_id": { "title": "Slack Team Id", "nullable": true, "type": "string" }, "tags": { "title": "Tags", "nullable": true, "items": { "type": "string" }, "type": "array" }, "target_devin_id": { "title": "Target Devin Id", "nullable": true, "type": "string" }, "platform": { "title": "Platform", "description": "VM platform for sessions spawned by this schedule (e.g. 'windows'). When omitted, the platform is left unchanged. Value must match a platform configured for the organization (case-insensitive); unknown values are rejected with a 400 that lists the available platform labels.", "nullable": true, "type": "string" } }, "type": "object", "title": "ScheduleUpdateRequest" }, "SearchMetricsResponse": { "properties": { "searches_created_count": { "type": "integer", "title": "Searches Created Count" } }, "type": "object", "required": [ "searches_created_count" ], "title": "SearchMetricsResponse", "description": "Response model for search metrics." }, "SecretCreateRequest": { "properties": { "type": { "type": "string", "title": "Type", "x-extensible-enum": [ "cookie", "key-value", "totp" ], "description": "Known values: `cookie`, `key-value`, `totp`. Additional values may be added in the future." }, "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" }, "is_sensitive": { "type": "boolean", "title": "Is Sensitive", "default": true }, "note": { "title": "Note", "nullable": true, "type": "string" } }, "type": "object", "required": [ "type", "key", "value" ], "title": "SecretCreateRequest" }, "SecretResponse": { "properties": { "secret_id": { "type": "string", "title": "Secret Id" }, "key": { "title": "Key", "nullable": true, "type": "string" }, "note": { "title": "Note", "nullable": true, "type": "string" }, "is_sensitive": { "type": "boolean", "title": "Is Sensitive" }, "created_by": { "type": "string", "title": "Created By" }, "created_at": { "type": "integer", "title": "Created At" }, "secret_type": { "type": "string", "title": "Secret Type", "x-extensible-enum": [ "cookie", "key-value", "totp" ], "description": "Known values: `cookie`, `key-value`, `totp`. Additional values may be added in the future." }, "access_type": { "type": "string", "title": "Access Type", "x-extensible-enum": [ "org", "personal" ], "description": "Known values: `org`, `personal`. Additional values may be added in the future." }, "updated_at": { "title": "Updated At", "nullable": true, "type": "integer" }, "updated_by": { "title": "Updated By", "nullable": true, "type": "string" } }, "type": "object", "required": [ "secret_id", "key", "note", "is_sensitive", "created_by", "created_at", "secret_type", "access_type" ], "title": "SecretResponse" }, "ServiceUser": { "properties": { "service_user_id": { "type": "string", "title": "Service User Id" }, "name": { "type": "string", "title": "Name" }, "expires_at": { "title": "Expires At", "nullable": true, "type": "integer" }, "deleted_at": { "title": "Deleted At", "nullable": true, "type": "integer" }, "role_assignments": { "items": { "$ref": "#/components/schemas/RoleAssignment" }, "type": "array", "title": "Role Assignments" } }, "type": "object", "required": [ "service_user_id", "name", "expires_at", "deleted_at", "role_assignments" ], "title": "ServiceUser" }, "ServiceUserSelf": { "properties": { "principal_type": { "type": "string", "title": "Principal Type", "x-extensible-enum": [ "service_user" ], "description": "Known values: `service_user`. Additional values may be added in the future." }, "service_user_id": { "type": "string", "title": "Service User Id" }, "service_user_name": { "type": "string", "title": "Service User Name" }, "org_id": { "title": "Org Id", "nullable": true, "type": "string" } }, "type": "object", "required": [ "principal_type", "service_user_id", "service_user_name" ], "title": "ServiceUserSelf", "description": "Identity information for an authenticated service user." }, "ServiceUserUpdateRoleRequest": { "properties": { "role_id": { "type": "string", "title": "Role Id" } }, "type": "object", "required": [ "role_id" ], "title": "ServiceUserUpdateRoleRequest" }, "SessionAttachment": { "properties": { "attachment_id": { "type": "string", "title": "Attachment Id" }, "name": { "type": "string", "title": "Name" }, "url": { "type": "string", "title": "Url" }, "content_type": { "title": "Content Type", "nullable": true, "type": "string" }, "source": { "type": "string", "title": "Source", "x-extensible-enum": [ "devin", "user" ], "description": "Known values: `devin`, `user`. Additional values may be added in the future." } }, "type": "object", "required": [ "attachment_id", "name", "url", "source" ], "title": "SessionAttachment", "description": "An attachment sent during a session." }, "SessionCountsByOrigin": { "properties": { "webapp": { "type": "integer", "title": "Webapp", "default": 0 }, "slack": { "type": "integer", "title": "Slack", "default": 0 }, "teams": { "type": "integer", "title": "Teams", "default": 0 }, "api": { "type": "integer", "title": "Api", "default": 0 }, "linear": { "type": "integer", "title": "Linear", "default": 0 }, "jira": { "type": "integer", "title": "Jira", "default": 0 }, "automation": { "type": "integer", "title": "Automation", "default": 0 }, "desktop": { "type": "integer", "title": "Desktop", "default": 0 }, "code_scan": { "type": "integer", "title": "Code Scan", "default": 0 } }, "type": "object", "title": "SessionCountsByOrigin", "description": "Session counts by origin type, exposed on the v3 metrics API.\n\nA curated subset of `SessionOrigin`: legacy origins (cli,\nvscode_extension, devin_spaces) are intentionally not surfaced.\nCounts for sessions with a `scheduled` DB origin roll into\n`automation` via the canonical `db_origin_to_api` mapping, since\nautomations are a superset that schedules will migrate into." }, "SessionCountsBySize": { "properties": { "xs": { "type": "integer", "title": "Xs", "default": 0 }, "s": { "type": "integer", "title": "S", "default": 0 }, "m": { "type": "integer", "title": "M", "default": 0 }, "l": { "type": "integer", "title": "L", "default": 0 }, "xl": { "type": "integer", "title": "Xl", "default": 0 } }, "type": "object", "title": "SessionCountsBySize", "description": "Session counts by size category." }, "SessionCreateRequest": { "properties": { "prompt": { "type": "string", "title": "Prompt" }, "title": { "title": "Title", "nullable": true, "type": "string" }, "tags": { "title": "Tags", "nullable": true, "items": { "type": "string" }, "type": "array" }, "max_acu_limit": { "title": "Max Acu Limit", "nullable": true, "type": "integer" }, "playbook_id": { "title": "Playbook Id", "nullable": true, "type": "string" }, "knowledge_ids": { "title": "Knowledge Ids", "nullable": true, "items": { "type": "string" }, "type": "array" }, "secret_ids": { "title": "Secret Ids", "nullable": true, "items": { "type": "string" }, "type": "array" }, "session_secrets": { "title": "Session Secrets", "nullable": true, "items": { "$ref": "#/components/schemas/SessionSecretInput" }, "type": "array" }, "repos": { "title": "Repos", "nullable": true, "items": { "type": "string" }, "type": "array" }, "attachment_urls": { "title": "Attachment Urls", "nullable": true, "items": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri" }, "type": "array" }, "create_as_user_id": { "title": "Create As User Id", "nullable": true, "type": "string" }, "child_playbook_id": { "title": "Child Playbook Id", "nullable": true, "type": "string" }, "session_links": { "title": "Session Links", "nullable": true, "items": { "type": "string" }, "type": "array" }, "bypass_approval": { "title": "Bypass Approval", "nullable": true, "type": "boolean" }, "structured_output_schema": { "title": "Structured Output Schema", "description": "JSON Schema (Draft 7) for validating structured output. Max 64KB. Must be self-contained (no external $ref).", "nullable": true, "additionalProperties": true, "type": "object" }, "structured_output_required": { "title": "Structured Output Required", "description": "When true (default), the agent MUST call provide_structured_output with is_final=true before its turn ends. When false, the tool is available but not required — it is not guaranteed to be called in a given turn.", "nullable": true, "type": "boolean" }, "resumable": { "type": "boolean", "title": "Resumable", "description": "Whether to preserve the session's VM state after it stops so the session can be resumed. Set to false for disposable sessions.", "default": true }, "platform": { "title": "Platform", "description": "Override the VM platform for the session (e.g. 'windows'). When omitted (or set to 'inherit'), a session created by a parent Devin inherits the parent's platform; otherwise the organization default is used. Any value must match a platform configured for your organization (case-insensitive); unrecognized values are rejected with a 400 whose error body lists the available platform labels for the org.", "nullable": true, "type": "string" }, "devin_mode": { "title": "Devin Mode", "description": "Override the Devin agent mode for the session. 'normal' uses the default Agent mode, 'fast' uses Fast mode, 'lite' uses Devin Lite, 'ultra' uses Devin Ultra, and 'fusion' uses Fusion. Preview modes are subject to the same feature flag and enterprise agent preview restrictions as the web app.", "nullable": true, "type": "string", "x-extensible-enum": [ "normal", "fast", "lite", "ultra", "fusion" ] } }, "type": "object", "required": [ "prompt" ], "title": "SessionCreateRequest" }, "SessionInsightsActionItem": { "properties": { "type": { "type": "string", "title": "Type", "default": "other", "x-extensible-enum": [ "machine_setup", "repo_config", "knowledge", "prompt_improvement", "other" ], "description": "Known values: `machine_setup`, `repo_config`, `knowledge`, `prompt_improvement`, `other`. Additional values may be added in the future." }, "action_item": { "type": "string", "title": "Action Item" }, "issue_id": { "title": "Issue Id", "nullable": true, "type": "string" } }, "type": "object", "required": [ "action_item" ], "title": "SessionInsightsActionItem" }, "SessionInsightsAnalysis": { "properties": { "issues": { "items": { "$ref": "#/components/schemas/SessionInsightsIssue" }, "type": "array", "title": "Issues", "default": [] }, "timeline": { "items": { "$ref": "#/components/schemas/SessionInsightsTimelineEvent" }, "type": "array", "title": "Timeline", "default": [] }, "action_items": { "items": { "$ref": "#/components/schemas/SessionInsightsActionItem" }, "type": "array", "title": "Action Items", "default": [] }, "suggested_prompt": { "nullable": true, "type": "object" }, "note_usage": { "nullable": true, "type": "object" }, "classification": { "nullable": true, "type": "object" } }, "type": "object", "title": "SessionInsightsAnalysis", "description": "AI-generated analysis data from a completed session analysis." }, "SessionInsightsClassification": { "properties": { "category": { "type": "string", "title": "Category" }, "confidence": { "type": "number", "title": "Confidence" }, "tools_and_frameworks": { "items": { "type": "string" }, "type": "array", "title": "Tools And Frameworks", "default": [] }, "programming_languages": { "items": { "type": "string" }, "type": "array", "title": "Programming Languages", "default": [] } }, "type": "object", "required": [ "category", "confidence" ], "title": "SessionInsightsClassification" }, "SessionInsightsFeedbackItem": { "properties": { "summary": { "type": "string", "title": "Summary" }, "excerpt": { "type": "string", "title": "Excerpt" }, "details": { "type": "string", "title": "Details" }, "issue_id": { "title": "Issue Id", "nullable": true, "type": "string" } }, "type": "object", "required": [ "summary", "excerpt", "details" ], "title": "SessionInsightsFeedbackItem" }, "SessionInsightsGenerateResponse": { "properties": { "session_id": { "type": "string", "title": "Session Id", "description": "The session ID for which insights generation was triggered." }, "status": { "type": "string", "title": "Status", "description": "The status of the generation request." } }, "type": "object", "required": [ "session_id", "status" ], "title": "SessionInsightsGenerateResponse", "description": "Response from triggering session insights generation." }, "SessionInsightsIssue": { "properties": { "id": { "type": "string", "title": "Id", "default": "" }, "issue": { "type": "string", "title": "Issue" }, "impact": { "type": "string", "title": "Impact" }, "label": { "type": "string", "title": "Label" } }, "type": "object", "required": [ "issue", "impact", "label" ], "title": "SessionInsightsIssue" }, "SessionInsightsNoteUsage": { "properties": { "good_usages": { "items": { "$ref": "#/components/schemas/SessionInsightsNoteUsageItem" }, "type": "array", "title": "Good Usages", "default": [] }, "bad_usages": { "items": { "$ref": "#/components/schemas/SessionInsightsNoteUsageItem" }, "type": "array", "title": "Bad Usages", "default": [] } }, "type": "object", "title": "SessionInsightsNoteUsage" }, "SessionInsightsNoteUsageItem": { "properties": { "reason": { "type": "string", "title": "Reason" }, "message": { "type": "string", "title": "Message" }, "note_id": { "type": "string", "title": "Note Id" } }, "type": "object", "required": [ "reason", "message", "note_id" ], "title": "SessionInsightsNoteUsageItem" }, "SessionInsightsResponse": { "properties": { "session_id": { "type": "string", "title": "Session Id" }, "url": { "type": "string", "title": "Url" }, "status": { "type": "string", "title": "Status", "x-extensible-enum": [ "new", "claimed", "running", "exit", "error", "suspended", "resuming" ], "description": "Known values: `new`, `claimed`, `running`, `exit`, `error`, `suspended`, `resuming`. Additional values may be added in the future." }, "title": { "title": "Title", "nullable": true, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "playbook_id": { "title": "Playbook Id", "nullable": true, "type": "string" }, "user_id": { "title": "User Id", "nullable": true, "type": "string" }, "org_id": { "type": "string", "title": "Org Id" }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" }, "is_archived": { "type": "boolean", "title": "Is Archived", "default": false }, "acus_consumed": { "type": "number", "title": "Acus Consumed" }, "pull_requests": { "items": { "$ref": "#/components/schemas/SessionPullRequest" }, "type": "array", "title": "Pull Requests" }, "parent_session_id": { "title": "Parent Session Id", "nullable": true, "type": "string" }, "child_session_ids": { "title": "Child Session Ids", "nullable": true, "items": { "type": "string" }, "type": "array" }, "service_user_id": { "title": "Service User Id", "nullable": true, "type": "string" }, "category": { "title": "Category", "description": "The session's assigned use-case category, if categorisation has run. Only populated on get/list endpoints.", "nullable": true, "type": "string", "x-extensible-enum": [ "bug_fixing", "ci_cd_and_devops", "code_quality_and_security", "code_review", "code_review_and_analysis", "data_and_automation", "documentation_and_content", "feature_development", "migrations_and_upgrades", "other", "production_investigation", "refactoring_and_optimization", "research_and_exploration", "security", "unit_test_generation" ] }, "subcategory": { "title": "Subcategory", "description": "The session's assigned subcategory display name. 'Other' when a category is set but no subcategory was assigned or resolved. Only populated on get/list endpoints.", "nullable": true, "type": "string" }, "origin": { "title": "Origin", "description": "The origin from which the session was created.", "nullable": true, "type": "string", "x-extensible-enum": [ "webapp", "slack", "teams", "api", "linear", "jira", "automation", "cli", "desktop", "code_scan", "other" ] }, "structured_output": { "title": "Structured Output", "description": "Validated structured output from the session. Only populated on get/list endpoints.", "nullable": true, "additionalProperties": true, "type": "object" }, "status_detail": { "title": "Status Detail", "description": "Additional detail about the session's current status. When status is 'running': 'working' (actively working), 'waiting_for_user' (needs user input), 'waiting_for_approval' (awaiting action approval in safe mode), or 'finished' (task complete). When status is 'suspended': the reason for suspension such as 'inactivity', 'user_request', 'usage_limit_exceeded', 'out_of_credits', 'out_of_quota', 'no_quota_allocation', 'payment_declined', 'org_usage_limit_exceeded', 'total_session_limit_exceeded', or 'error'. Only populated on get/list endpoints.", "nullable": true, "type": "string", "x-extensible-enum": [ "working", "waiting_for_user", "waiting_for_approval", "finished", "inactivity", "user_request", "usage_limit_exceeded", "out_of_credits", "out_of_quota", "no_quota_allocation", "payment_declined", "org_usage_limit_exceeded", "total_session_limit_exceeded", "error" ] }, "num_user_messages": { "type": "integer", "title": "Num User Messages", "description": "Number of user messages sent during the session." }, "num_devin_messages": { "type": "integer", "title": "Num Devin Messages", "description": "Number of Devin messages sent during the session." }, "session_size": { "type": "string", "title": "Session Size", "description": "Session size classification based on ACU usage and message count.\n\nKnown values: `xs`, `s`, `m`, `l`, `xl`. Additional values may be added in the future.", "x-extensible-enum": [ "xs", "s", "m", "l", "xl" ] }, "analysis": { "description": "AI-generated session analysis. None if analysis has not completed.", "nullable": true, "type": "object" } }, "type": "object", "required": [ "session_id", "url", "status", "tags", "org_id", "created_at", "updated_at", "acus_consumed", "pull_requests", "num_user_messages", "num_devin_messages", "session_size" ], "title": "SessionInsightsResponse", "description": "Session details augmented with quantitative metrics and AI analysis.\n\nExtends SessionResponse with additional fields that require extra queries." }, "SessionInsightsSuggestedPrompt": { "properties": { "original_prompt": { "type": "string", "title": "Original Prompt" }, "suggested_prompt": { "type": "string", "title": "Suggested Prompt" }, "feedback_items": { "items": { "$ref": "#/components/schemas/SessionInsightsFeedbackItem" }, "type": "array", "title": "Feedback Items", "default": [] } }, "type": "object", "required": [ "original_prompt", "suggested_prompt" ], "title": "SessionInsightsSuggestedPrompt" }, "SessionInsightsTimelineEvent": { "properties": { "title": { "type": "string", "title": "Title" }, "color": { "type": "string", "title": "Color", "default": "" }, "description": { "type": "string", "title": "Description" }, "issue_id": { "title": "Issue Id", "nullable": true, "type": "string" } }, "type": "object", "required": [ "title", "description" ], "title": "SessionInsightsTimelineEvent" }, "SessionMessage": { "properties": { "event_id": { "type": "string", "title": "Event Id" }, "source": { "type": "string", "title": "Source", "x-extensible-enum": [ "devin", "user" ], "description": "Known values: `devin`, `user`. Additional values may be added in the future." }, "message": { "type": "string", "title": "Message" }, "created_at": { "type": "integer", "title": "Created At" } }, "type": "object", "required": [ "event_id", "source", "message", "created_at" ], "title": "SessionMessage", "description": "A message in a Devin session." }, "SessionMessageCreateRequest": { "properties": { "message": { "type": "string", "title": "Message" }, "message_as_user_id": { "title": "Message As User Id", "nullable": true, "type": "string" }, "attachment_urls": { "title": "Attachment Urls", "nullable": true, "items": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri" }, "type": "array" } }, "type": "object", "required": [ "message" ], "title": "SessionMessageCreateRequest" }, "SessionMetricsResponse": { "properties": { "sessions_created_count": { "type": "integer", "title": "Sessions Created Count" }, "sessions_created_by_size": { "$ref": "#/components/schemas/SessionCountsBySize" }, "sessions_created_by_origin": { "$ref": "#/components/schemas/SessionCountsByOrigin" }, "sessions_created_with_playbook_count": { "type": "integer", "title": "Sessions Created With Playbook Count" }, "sessions_created_with_search_count": { "type": "integer", "title": "Sessions Created With Search Count" }, "sessions_with_merged_prs_count": { "type": "integer", "title": "Sessions With Merged Prs Count" }, "sessions_with_merged_prs_by_size": { "$ref": "#/components/schemas/SessionCountsBySize" }, "avg_acus_per_session": { "type": "number", "title": "Avg Acus Per Session" } }, "type": "object", "required": [ "sessions_created_count", "sessions_created_by_size", "sessions_created_by_origin", "sessions_created_with_playbook_count", "sessions_created_with_search_count", "sessions_with_merged_prs_count", "sessions_with_merged_prs_by_size", "avg_acus_per_session" ], "title": "SessionMetricsResponse", "description": "Response model for session metrics." }, "SessionPullRequest": { "properties": { "pr_url": { "type": "string", "title": "Pr Url" }, "pr_state": { "title": "Pr State", "nullable": true, "type": "string" } }, "type": "object", "required": [ "pr_url", "pr_state" ], "title": "SessionPullRequest" }, "SessionPurpose": { "type": "string", "title": "SessionPurpose", "description": "Purpose of a child session spawned by a parent (brain callers only).\n\nPropagated to the session via `additional_args[\"purpose\"]`.\n\nKnown values: `testing`. Additional values may be added in the future.", "x-extensible-enum": [ "testing" ] }, "SessionResponse": { "properties": { "session_id": { "type": "string", "title": "Session Id" }, "url": { "type": "string", "title": "Url" }, "status": { "type": "string", "title": "Status", "x-extensible-enum": [ "new", "claimed", "running", "exit", "error", "suspended", "resuming" ], "description": "Known values: `new`, `claimed`, `running`, `exit`, `error`, `suspended`, `resuming`. Additional values may be added in the future." }, "title": { "title": "Title", "nullable": true, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" }, "playbook_id": { "title": "Playbook Id", "nullable": true, "type": "string" }, "user_id": { "title": "User Id", "nullable": true, "type": "string" }, "org_id": { "type": "string", "title": "Org Id" }, "created_at": { "type": "integer", "title": "Created At" }, "updated_at": { "type": "integer", "title": "Updated At" }, "is_archived": { "type": "boolean", "title": "Is Archived", "default": false }, "acus_consumed": { "type": "number", "title": "Acus Consumed" }, "pull_requests": { "items": { "$ref": "#/components/schemas/SessionPullRequest" }, "type": "array", "title": "Pull Requests" }, "parent_session_id": { "title": "Parent Session Id", "nullable": true, "type": "string" }, "child_session_ids": { "title": "Child Session Ids", "nullable": true, "items": { "type": "string" }, "type": "array" }, "service_user_id": { "title": "Service User Id", "nullable": true, "type": "string" }, "category": { "title": "Category", "description": "The session's assigned use-case category, if categorisation has run. Only populated on get/list endpoints.", "nullable": true, "type": "string", "x-extensible-enum": [ "bug_fixing", "ci_cd_and_devops", "code_quality_and_security", "code_review", "code_review_and_analysis", "data_and_automation", "documentation_and_content", "feature_development", "migrations_and_upgrades", "other", "production_investigation", "refactoring_and_optimization", "research_and_exploration", "security", "unit_test_generation" ] }, "subcategory": { "title": "Subcategory", "description": "The session's assigned subcategory display name. 'Other' when a category is set but no subcategory was assigned or resolved. Only populated on get/list endpoints.", "nullable": true, "type": "string" }, "origin": { "title": "Origin", "description": "The origin from which the session was created.", "nullable": true, "type": "string", "x-extensible-enum": [ "webapp", "slack", "teams", "api", "linear", "jira", "automation", "cli", "desktop", "code_scan", "other" ] }, "structured_output": { "title": "Structured Output", "description": "Validated structured output from the session. Only populated on get/list endpoints.", "nullable": true, "additionalProperties": true, "type": "object" }, "status_detail": { "title": "Status Detail", "description": "Additional detail about the session's current status. When status is 'running': 'working' (actively working), 'waiting_for_user' (needs user input), 'waiting_for_approval' (awaiting action approval in safe mode), or 'finished' (task complete). When status is 'suspended': the reason for suspension such as 'inactivity', 'user_request', 'usage_limit_exceeded', 'out_of_credits', 'out_of_quota', 'no_quota_allocation', 'payment_declined', 'org_usage_limit_exceeded', 'total_session_limit_exceeded', or 'error'. Only populated on get/list endpoints.", "nullable": true, "type": "string", "x-extensible-enum": [ "working", "waiting_for_user", "waiting_for_approval", "finished", "inactivity", "user_request", "usage_limit_exceeded", "out_of_credits", "out_of_quota", "no_quota_allocation", "payment_declined", "org_usage_limit_exceeded", "total_session_limit_exceeded", "error" ] } }, "type": "object", "required": [ "session_id", "url", "status", "tags", "org_id", "created_at", "updated_at", "acus_consumed", "pull_requests" ], "title": "SessionResponse" }, "SessionSecretInput": { "properties": { "key": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Key" }, "value": { "type": "string", "maxLength": 65536, "title": "Value" }, "sensitive": { "type": "boolean", "title": "Sensitive", "default": true } }, "type": "object", "required": [ "key", "value" ], "title": "SessionSecretInput", "description": "Input model for a session secret provided via API." }, "SessionTagsResponse": { "properties": { "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" } }, "type": "object", "required": [ "tags" ], "title": "SessionTagsResponse" }, "SessionTagsUpdateRequest": { "properties": { "tags": { "items": { "type": "string" }, "type": "array", "maxItems": 50, "title": "Tags" } }, "type": "object", "required": [ "tags" ], "title": "SessionTagsUpdateRequest" }, "SessionsByCategoryResponse": { "properties": { "categories": { "items": { "$ref": "#/components/schemas/CategoryMetrics" }, "type": "array", "title": "Categories" } }, "type": "object", "required": [ "categories" ], "title": "SessionsByCategoryResponse" }, "SessionsQueryParams": { "properties": { "after": { "title": "After", "nullable": true, "type": "string" }, "first": { "type": "integer", "maximum": 200, "minimum": 1, "title": "First", "default": 100 }, "session_ids": { "title": "Session Ids", "nullable": true, "items": { "type": "string" }, "type": "array" }, "created_after": { "title": "Created After", "nullable": true, "type": "integer" }, "created_before": { "title": "Created Before", "nullable": true, "type": "integer" }, "updated_after": { "title": "Updated After", "nullable": true, "type": "integer" }, "updated_before": { "title": "Updated Before", "nullable": true, "type": "integer" }, "tags": { "title": "Tags", "nullable": true, "items": { "type": "string" }, "type": "array" }, "playbook_id": { "title": "Playbook Id", "nullable": true, "type": "string" }, "origins": { "title": "Origins", "nullable": true, "items": { "type": "string", "x-extensible-enum": [ "webapp", "slack", "teams", "api", "linear", "jira", "automation", "cli", "desktop", "code_scan", "other" ], "description": "Known values: `webapp`, `slack`, `teams`, `api`, `linear`, `jira`, `automation`, `cli`, `desktop`, `code_scan`, `other`. Additional values may be added in the future." }, "type": "array" }, "schedule_id": { "title": "Schedule Id", "nullable": true, "type": "string" }, "user_ids": { "title": "User Ids", "nullable": true, "items": { "type": "string" }, "type": "array" }, "service_user_ids": { "title": "Service User Ids", "nullable": true, "items": { "type": "string" }, "type": "array" }, "repo_names": { "title": "Repo Names", "description": "Filter by repository names (e.g., 'owner/repo')", "nullable": true, "items": { "type": "string" }, "type": "array" }, "category": { "title": "Category", "nullable": true, "type": "string", "x-extensible-enum": [ "bug_fixing", "ci_cd_and_devops", "code_quality_and_security", "code_review", "code_review_and_analysis", "data_and_automation", "documentation_and_content", "feature_development", "migrations_and_upgrades", "other", "production_investigation", "refactoring_and_optimization", "research_and_exploration", "security", "unit_test_generation" ], "description": "Known values: `bug_fixing`, `ci_cd_and_devops`, `code_quality_and_security`, `code_review`, `code_review_and_analysis`, `data_and_automation`, `documentation_and_content`, `feature_development`, `migrations_and_upgrades`, `other`, `production_investigation`, `refactoring_and_optimization`, `research_and_exploration`, `security`, `unit_test_generation`. Additional values may be added in the future." }, "is_archived": { "title": "Is Archived", "nullable": true, "type": "boolean" } }, "type": "object", "title": "SessionsQueryParams" }, "SubcategoryMetrics": { "properties": { "subcategory_id": { "title": "Subcategory Id", "nullable": true, "type": "string" }, "display_name": { "type": "string", "title": "Display Name" }, "sessions_count": { "type": "integer", "title": "Sessions Count" }, "acus": { "type": "number", "title": "Acus" } }, "type": "object", "required": [ "subcategory_id", "display_name", "sessions_count", "acus" ], "title": "SubcategoryMetrics" }, "TagsCreateRequest": { "properties": { "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" } }, "type": "object", "required": [ "tags" ], "title": "TagsCreateRequest" }, "TagsResponse": { "properties": { "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" } }, "type": "object", "required": [ "tags" ], "title": "TagsResponse" }, "TriggerBuildBody": { "properties": {}, "type": "object", "title": "TriggerBuildBody", "description": "``POST /builds`` body. Empty per spec; reserved for future fields." }, "UpdateACULimitRequest": { "properties": { "cycle_acu_limit": { "type": "integer", "minimum": 0, "title": "Cycle Acu Limit" } }, "type": "object", "required": [ "cycle_acu_limit" ], "title": "UpdateACULimitRequest" }, "UpdateBlueprintContentsBody": { "properties": { "contents": { "type": "string", "title": "Contents", "description": "New YAML body for the blueprint." } }, "type": "object", "required": [ "contents" ], "title": "UpdateBlueprintContentsBody" }, "UpdateOrgBlueprintBody": { "properties": { "contents": { "title": "Contents", "description": "If set, replaces the blueprint's YAML body with a new version.", "nullable": true, "type": "string" }, "position": { "title": "Position", "description": "If set, updates the execution position of this repo-tier blueprint. Positions are not required to be unique; ties are broken arbitrarily by the server when sorting for execution.", "nullable": true, "type": "integer" } }, "type": "object", "title": "UpdateOrgBlueprintBody", "description": "Partial update for an org- or repo-tier blueprint.\n\nAny subset of fields may be provided. Fields not set are left alone.\nProviding ``position`` on an org-tier blueprint returns ``400`` — only\nrepo-tier blueprints have a position. Does NOT trigger a build." }, "UsageMetrics": { "properties": { "sessions_count": { "type": "integer", "title": "Sessions Count" }, "searches_count": { "type": "integer", "title": "Searches Count" }, "prs_created_count": { "type": "integer", "title": "Prs Created Count" }, "prs_merged_count": { "type": "integer", "title": "Prs Merged Count" } }, "type": "object", "required": [ "sessions_count", "searches_count", "prs_created_count", "prs_merged_count" ], "title": "UsageMetrics" }, "User": { "properties": { "user_id": { "type": "string", "title": "User Id" }, "email": { "title": "Email", "nullable": true, "type": "string" }, "name": { "title": "Name", "nullable": true, "type": "string" }, "role_assignments": { "items": { "$ref": "#/components/schemas/RoleAssignment" }, "type": "array", "title": "Role Assignments" } }, "type": "object", "required": [ "user_id", "email", "name", "role_assignments" ], "title": "User" }, "UserBulkCreateRequest": { "properties": { "emails": { "items": { "type": "string" }, "type": "array", "maxItems": 100, "title": "Emails" }, "enterprise_role_id": { "type": "string", "title": "Enterprise Role Id" } }, "type": "object", "required": [ "emails", "enterprise_role_id" ], "title": "UserBulkCreateRequest" }, "UserUpdateRoleRequest": { "properties": { "role_id": { "type": "string", "title": "Role Id" } }, "type": "object", "required": [ "role_id" ], "title": "UserUpdateRoleRequest" }, "UserWithIdpRoles": { "properties": { "user_id": { "type": "string", "title": "User Id" }, "email": { "title": "Email", "nullable": true, "type": "string" }, "name": { "title": "Name", "nullable": true, "type": "string" }, "role_assignments": { "items": { "$ref": "#/components/schemas/RoleAssignment" }, "type": "array", "title": "Role Assignments" }, "idp_role_assignments": { "items": { "$ref": "#/components/schemas/IdpRoleAssignment" }, "type": "array", "title": "Idp Role Assignments" } }, "type": "object", "required": [ "user_id", "email", "name", "role_assignments" ], "title": "UserWithIdpRoles", "description": "User with both direct and IDP-group-derived role assignments." }, "WindsurfSessionUserSelf": { "properties": { "principal_type": { "type": "string", "title": "Principal Type", "x-extensible-enum": [ "windsurf_session" ], "description": "Known values: `windsurf_session`. Additional values may be added in the future." }, "user_id": { "type": "string", "title": "User Id" }, "user_name": { "title": "User Name", "nullable": true, "type": "string" }, "org_id": { "type": "string", "title": "Org Id" } }, "type": "object", "required": [ "principal_type", "user_id", "org_id" ], "title": "WindsurfSessionUserSelf", "description": "Identity information for an authenticated Windsurf session user." } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Service User credential (prefix: cog_)" } } }, "security": [ { "bearerAuth": [] } ] }