π OpenHands: AI-Driven Development
docs: update OpenAPI specification to include all current endpoints (#10412)
Engel Nyst5ce5469bfa92
diff --git a/docs/openapi.json b/docs/openapi.jsonindex d36bdb8764..d073f858ca 100644--- a/docs/openapi.json+++ b/docs/openapi.json@@ -1,305 +1,169 @@{- "openapi": "3.0.3",+ "openapi": "3.1.0","info": {- "title": "OpenHands API",+ "title": "OpenHands","description": "OpenHands: Code Less, Make More",- "version": "1.0.0"+ "version": "0.53.0"},- "servers": [- {- "url": "https://app.all-hands.dev",- "description": "Production server"- },- {- "url": "http://localhost:3000",- "description": "Local development server"- }- ],"paths": {- "/health": {+ "/api/options/models": {"get": {- "summary": "Health check",- "description": "Check if the API is running",- "operationId": "health",+ "summary": "List Supported Models",+ "description": "List model identifiers available on this server based on configured providers.",+ "operationId": "get_litellm_models_api_options_models_get","responses": {"200": {- "description": "API is running",+ "description": "Successful Response","content": {- "text/plain": {+ "application/json": {"schema": {- "type": "string",- "example": "OK"+ "items": {+ "type": "string"+ },+ "type": "array",+ "title": "Response Get Litellm Models Api Options Models Get"}}}}- }- }- },- "/api/conversations/{conversation_id}/config": {- "get": {- "summary": "Get runtime configuration",- "description": "Retrieve the runtime configuration (session ID and runtime ID)",- "operationId": "getRemoteRuntimeConfig",- "parameters": [+ },+ "security": [{- "name": "conversation_id",- "in": "path",- "required": true,- "schema": {- "type": "string"- },- "description": "Conversation ID"- }- ],- "responses": {- "200": {- "description": "Runtime configuration",- "content": {- "application/json": {- "schema": {- "type": "object",- "properties": {- "runtime_id": {- "type": "string",- "nullable": true- },- "session_id": {- "type": "string",- "nullable": true- }- }- }- }- }+ "APIKeyHeader": []}- }+ ]}},- "/api/conversations/{conversation_id}/vscode-url": {+ "/api/options/agents": {"get": {- "summary": "Get VSCode URL",- "description": "Get the VSCode URL for the conversation",- "operationId": "getVscodeUrl",- "parameters": [- {- "name": "conversation_id",- "in": "path",- "required": true,- "schema": {- "type": "string"- },- "description": "Conversation ID"- }- ],+ "summary": "List Agents",+ "description": "List available agent types supported by this server.",+ "operationId": "get_agents_api_options_agents_get","responses": {"200": {- "description": "VSCode URL",- "content": {- "application/json": {- "schema": {- "type": "object",- "properties": {- "vscode_url": {- "type": "string",- "nullable": true- }- }- }- }- }- },- "500": {- "description": "Error getting VSCode URL",+ "description": "Successful Response","content": {"application/json": {"schema": {- "type": "object",- "properties": {- "vscode_url": {- "type": "string",- "nullable": true- },- "error": {- "type": "string"- }- }+ "items": {+ "type": "string"+ },+ "type": "array",+ "title": "Response Get Agents Api Options Agents Get"}}}}- }+ },+ "security": [+ {+ "APIKeyHeader": []+ }+ ]}},- "/api/conversations/{conversation_id}/web-hosts": {+ "/api/options/security-analyzers": {"get": {- "summary": "Get runtime hosts",- "description": "Get the hosts used by the runtime",- "operationId": "getHosts",- "parameters": [- {- "name": "conversation_id",- "in": "path",- "required": true,- "schema": {- "type": "string"- },- "description": "Conversation ID"- }- ],+ "summary": "List Security Analyzers",+ "description": "List supported security analyzers.",+ "operationId": "get_security_analyzers_api_options_security_analyzers_get","responses": {"200": {- "description": "Runtime hosts",- "content": {- "application/json": {- "schema": {- "type": "object",- "properties": {- "hosts": {- "type": "array",- "items": {- "type": "string"- }- }- }- }- }- }- },- "500": {- "description": "Error getting runtime hosts",+ "description": "Successful Response","content": {"application/json": {"schema": {- "type": "object",- "properties": {- "hosts": {- "type": "array",- "items": {- "type": "string"- },- "nullable": true- },- "error": {- "type": "string"- }- }- }- }- }- }- }- }- },- "/api/conversations/{conversation_id}/submit-feedback": {- "post": {- "summary": "Submit feedback",- "description": "Submit user feedback for a conversation",- "operationId": "submitFeedback",- "parameters": [- {- "name": "conversation_id",- "in": "path",- "required": true,- "schema": {- "type": "string"- },- "description": "Conversation ID"- }- ],- "requestBody": {- "required": true,- "content": {- "application/json": {- "schema": {- "type": "object",- "properties": {- "email": {- "type": "string",- "format": "email"- },- "version": {- "type": "string"- },- "permissions": {- "type": "string",- "default": "private"- },- "polarity": {+ "items": {"type": "string"},- "feedback": {- "type": "string"- }+ "type": "array",+ "title": "Response Get Security Analyzers Api Options Security Analyzers Get"}}}}},+ "security": [+ {+ "APIKeyHeader": []+ }+ ]+ }+ },+ "/api/options/config": {+ "get": {+ "summary": "Get Config",+ "description": "Get current config.",+ "operationId": "get_config_api_options_config_get","responses": {"200": {- "description": "Feedback submitted successfully",- "content": {- "application/json": {- "schema": {- "type": "object"- }- }- }- },- "500": {- "description": "Error submitting feedback",+ "description": "Successful Response","content": {"application/json": {"schema": {+ "additionalProperties": true,"type": "object",- "properties": {- "error": {- "type": "string"- }- }+ "title": "Response Get Config Api Options Config Get"}}}}- }+ },+ "security": [+ {+ "APIKeyHeader": []+ }+ ]}},"/api/conversations/{conversation_id}/list-files": {"get": {- "summary": "List files",- "description": "List files in the specified path",- "operationId": "listFiles",+ "summary": "List Workspace Files",+ "description": "List workspace files visible to the conversation runtime. Applies .gitignore and internal ignore rules.",+ "operationId": "list_files_api_conversations__conversation_id__list_files_get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"parameters": [{"name": "conversation_id","in": "path","required": true,"schema": {- "type": "string"- },- "description": "Conversation ID"+ "type": "string",+ "title": "Conversation Id"+ }},{"name": "path","in": "query","required": false,"schema": {- "type": "string"- },- "description": "Path to list files from"+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Path"+ }}],"responses": {"200": {- "description": "List of files",+ "description": "Successful Response","content": {"application/json": {"schema": {"type": "array","items": {"type": "string"- }+ },+ "title": "Response List Files Api Conversations Conversation Id List Files Get"}}}@@ -310,26 +174,30 @@"application/json": {"schema": {"type": "object",- "properties": {- "error": {- "type": "string"- }- }+ "additionalProperties": true,+ "title": "Response 404 List Files Api Conversations Conversation Id List Files Get"}}}},"500": {- "description": "Error listing files",+ "description": "Error listing or filtering files","content": {"application/json": {"schema": {"type": "object",- "properties": {- "error": {- "type": "string"- }- }+ "additionalProperties": true,+ "title": "Response 500 List Files Api Conversations Conversation Id List Files Get"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"}}}@@ -339,71 +207,79 @@},"/api/conversations/{conversation_id}/select-file": {"get": {- "summary": "Get file content",- "description": "Retrieve the content of a specified file",- "operationId": "selectFile",+ "summary": "Get File Content",+ "description": "Return the content of the given file from the conversation workspace.",+ "operationId": "select_file_api_conversations__conversation_id__select_file_get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"parameters": [{"name": "conversation_id","in": "path","required": true,"schema": {- "type": "string"- },- "description": "Conversation ID"+ "type": "string",+ "title": "Conversation Id"+ }},{"name": "file","in": "query","required": true,"schema": {- "type": "string"- },- "description": "Path of the file to be retrieved"+ "type": "string",+ "title": "File"+ }}],"responses": {"200": {- "description": "File content",+ "description": "File content returned as JSON","content": {"application/json": {"schema": {"type": "object",- "properties": {- "code": {- "type": "string"- }- }+ "additionalProperties": {+ "type": "string"+ },+ "title": "Response 200 Select File Api Conversations Conversation Id Select File Get"}}}},- "415": {- "description": "Unable to open binary file",+ "500": {+ "description": "Error opening file","content": {"application/json": {"schema": {"type": "object",- "properties": {- "error": {- "type": "string"- }- }+ "additionalProperties": true,+ "title": "Response 500 Select File Api Conversations Conversation Id Select File Get"}}}},- "500": {- "description": "Error opening file",+ "415": {+ "description": "Unsupported media type","content": {"application/json": {"schema": {"type": "object",- "properties": {- "error": {- "type": "string"- }- }+ "additionalProperties": true,+ "title": "Response 415 Select File Api Conversations Conversation Id Select File Get"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"}}}@@ -413,29 +289,30 @@},"/api/conversations/{conversation_id}/zip-directory": {"get": {- "summary": "Download workspace as zip",- "description": "Download the current workspace as a zip file",- "operationId": "zipCurrentWorkspace",+ "summary": "Download Workspace Archive",+ "operationId": "zip_current_workspace_api_conversations__conversation_id__zip_directory_get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"parameters": [{"name": "conversation_id","in": "path","required": true,"schema": {- "type": "string"- },- "description": "Conversation ID"+ "type": "string",+ "title": "Conversation Id"+ }}],"responses": {"200": {- "description": "Workspace zip file",+ "description": "Zipped workspace returned as FileResponse","content": {- "application/zip": {- "schema": {- "type": "string",- "format": "binary"- }+ "application/json": {+ "schema": {}}}},@@ -445,56 +322,94 @@"application/json": {"schema": {"type": "object",- "properties": {- "error": {- "type": "string"- }- }+ "additionalProperties": true,+ "title": "Response 500 Zip Current Workspace Api Conversations Conversation Id Zip Directory Get"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"}}}}- }+ },+ "description": "Return a ZIP archive of the current conversation workspace."}},"/api/conversations/{conversation_id}/git/changes": {"get": {- "summary": "Get git changes",- "description": "Get git changes in the workspace",- "operationId": "gitChanges",+ "summary": "Git Changes",+ "operationId": "git_changes_api_conversations__conversation_id__git_changes_get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"parameters": [{"name": "conversation_id","in": "path","required": true,"schema": {- "type": "string"- },- "description": "Conversation ID"+ "type": "string",+ "title": "Conversation Id"+ }}],"responses": {"200": {- "description": "Git changes",+ "description": "Successful Response","content": {"application/json": {"schema": {- "type": "object"- }- }- }- },+ "type": "array",+ "items": {+ "type": "object",+ "additionalProperties": {+ "type": "string"+ }+ },+ "title": "Response Git Changes Api Conversations Conversation Id Git Changes Get"+ }+ }+ }+ },+ "404": {+ "description": "Not a git repository",+ "content": {+ "application/json": {+ "schema": {+ "type": "object",+ "additionalProperties": true,+ "title": "Response 404 Git Changes Api Conversations Conversation Id Git Changes Get"+ }+ }+ }+ },"500": {- "description": "Error getting git changes",+ "description": "Error getting changes","content": {"application/json": {"schema": {"type": "object",- "properties": {- "error": {- "type": "string"- }- }+ "additionalProperties": true,+ "title": "Response 500 Git Changes Api Conversations Conversation Id Git Changes Get"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"}}}@@ -504,51 +419,64 @@},"/api/conversations/{conversation_id}/git/diff": {"get": {- "summary": "Get git diff",- "description": "Get git diff for a specific file",- "operationId": "gitDiff",+ "summary": "Git Diff",+ "operationId": "git_diff_api_conversations__conversation_id__git_diff_get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"parameters": [{"name": "conversation_id","in": "path","required": true,"schema": {- "type": "string"- },- "description": "Conversation ID"+ "type": "string",+ "title": "Conversation Id"+ }},{"name": "path","in": "query","required": true,"schema": {- "type": "string"- },- "description": "Path of the file to get diff for"+ "type": "string",+ "title": "Path"+ }}],"responses": {"200": {- "description": "Git diff",+ "description": "Successful Response","content": {"application/json": {"schema": {- "type": "string"+ "type": "object",+ "additionalProperties": true,+ "title": "Response Git Diff Api Conversations Conversation Id Git Diff Get"}}}},"500": {- "description": "Error getting git diff",+ "description": "Error getting diff","content": {"application/json": {"schema": {"type": "object",- "properties": {- "error": {- "type": "string"- }- }+ "additionalProperties": true,+ "title": "Response 500 Git Diff Api Conversations Conversation Id Git Diff Get"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"}}}@@ -556,59 +484,53 @@}}},- "/api/conversations/{conversation_id}/trajectory": {- "get": {- "summary": "Get trajectory",- "description": "Get the conversation trajectory",- "operationId": "getTrajectory",+ "/api/conversations/{conversation_id}/upload-files": {+ "post": {+ "summary": "Upload Files",+ "operationId": "upload_files_api_conversations__conversation_id__upload_files_post",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"parameters": [{"name": "conversation_id","in": "path","required": true,"schema": {- "type": "string"- },- "description": "Conversation ID"+ "type": "string",+ "title": "Conversation Id"+ }}],+ "requestBody": {+ "required": true,+ "content": {+ "multipart/form-data": {+ "schema": {+ "$ref": "#/components/schemas/Body_upload_files_api_conversations__conversation_id__upload_files_post"+ }+ }+ }+ },"responses": {"200": {- "description": "Conversation trajectory",+ "description": "Successful Response","content": {"application/json": {"schema": {- "type": "object",- "properties": {- "trajectory": {- "type": "array",- "items": {- "type": "object"- }- }- }+ "$ref": "#/components/schemas/POSTUploadFilesModel"}}}},- "500": {- "description": "Error getting trajectory",+ "422": {+ "description": "Validation Error","content": {"application/json": {"schema": {- "type": "object",- "properties": {- "trajectory": {- "type": "array",- "items": {- "type": "object"- },- "nullable": true- },- "error": {- "type": "string"- }- }+ "$ref": "#/components/schemas/HTTPValidationError"}}}@@ -616,229 +538,274 @@}}},- "/api/conversations/{conversation_id}/security/{path}": {- "get": {- "summary": "Security analyzer API (GET)",- "description": "Catch-all route for security analyzer API GET requests",- "operationId": "securityApiGet",+ "/api/conversations/{conversation_id}/submit-feedback": {+ "post": {+ "summary": "Submit Feedback",+ "description": "Submit user feedback.\n\nThis function stores the provided feedback data.\n\nTo submit feedback:",+ "operationId": "submit_feedback_api_conversations__conversation_id__submit_feedback_post",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"parameters": [{"name": "conversation_id","in": "path","required": true,"schema": {- "type": "string"- },- "description": "Conversation ID"- },- {- "name": "path",- "in": "path",- "required": true,- "schema": {- "type": "string"- },- "description": "Security analyzer API path"+ "type": "string",+ "title": "Conversation Id"+ }}],"responses": {"200": {- "description": "Security analyzer response",+ "description": "Successful Response","content": {"application/json": {- "schema": {- "type": "object"- }+ "schema": {}}}},- "404": {- "description": "Security analyzer not initialized",+ "422": {+ "description": "Validation Error","content": {"application/json": {"schema": {- "type": "object",- "properties": {- "detail": {- "type": "string"- }- }+ "$ref": "#/components/schemas/HTTPValidationError"}}}}}- },- "post": {- "summary": "Security analyzer API (POST)",- "description": "Catch-all route for security analyzer API POST requests",- "operationId": "securityApiPost",+ }+ },+ "/api/conversations/{conversation_id}/config": {+ "get": {+ "summary": "Get Remote Runtime Config",+ "description": "Retrieve the runtime configuration.\n\nCurrently, this is the session ID and runtime ID (if available).",+ "operationId": "get_remote_runtime_config_api_conversations__conversation_id__config_get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"parameters": [{"name": "conversation_id","in": "path","required": true,"schema": {- "type": "string"- },- "description": "Conversation ID"- },- {- "name": "path",- "in": "path",- "required": true,- "schema": {- "type": "string"- },- "description": "Security analyzer API path"- }- ],- "requestBody": {- "required": false,- "content": {- "application/json": {- "schema": {- "type": "object"- }+ "type": "string",+ "title": "Conversation Id"}}- },+ ],"responses": {"200": {- "description": "Security analyzer response",+ "description": "Successful Response","content": {"application/json": {- "schema": {- "type": "object"- }+ "schema": {}}}},- "404": {- "description": "Security analyzer not initialized",+ "422": {+ "description": "Validation Error","content": {"application/json": {"schema": {- "type": "object",- "properties": {- "detail": {- "type": "string"- }- }+ "$ref": "#/components/schemas/HTTPValidationError"}}}}}- },- "put": {- "summary": "Security analyzer API (PUT)",- "description": "Catch-all route for security analyzer API PUT requests",- "operationId": "securityApiPut",+ }+ },+ "/api/conversations/{conversation_id}/events": {+ "get": {+ "summary": "Search Events",+ "description": "Search through the event stream with filtering and pagination.",+ "operationId": "search_events_api_conversations__conversation_id__events_get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"parameters": [{"name": "conversation_id","in": "path","required": true,"schema": {- "type": "string"- },- "description": "Conversation ID"+ "type": "string",+ "title": "Conversation Id"+ }},{- "name": "path",- "in": "path",- "required": true,+ "name": "start_id",+ "in": "query",+ "required": false,"schema": {- "type": "string"- },- "description": "Security analyzer API path"+ "type": "integer",+ "default": 0,+ "title": "Start Id"+ }+ },+ {+ "name": "end_id",+ "in": "query",+ "required": false,+ "schema": {+ "anyOf": [+ {+ "type": "integer"+ },+ {+ "type": "null"+ }+ ],+ "title": "End Id"+ }+ },+ {+ "name": "reverse",+ "in": "query",+ "required": false,+ "schema": {+ "type": "boolean",+ "default": false,+ "title": "Reverse"+ }+ },+ {+ "name": "limit",+ "in": "query",+ "required": false,+ "schema": {+ "type": "integer",+ "default": 20,+ "title": "Limit"+ }}],"requestBody": {- "required": false,"content": {"application/json": {"schema": {- "type": "object"+ "anyOf": [+ {+ "$ref": "#/components/schemas/EventFilter"+ },+ {+ "type": "null"+ }+ ],+ "title": "Filter"}}}},"responses": {"200": {- "description": "Security analyzer response",+ "description": "Successful Response","content": {"application/json": {- "schema": {- "type": "object"- }+ "schema": {}}}},- "404": {- "description": "Security analyzer not initialized",+ "422": {+ "description": "Validation Error","content": {"application/json": {"schema": {- "type": "object",- "properties": {- "detail": {- "type": "string"- }- }+ "$ref": "#/components/schemas/HTTPValidationError"}}}}}},- "delete": {- "summary": "Security analyzer API (DELETE)",- "description": "Catch-all route for security analyzer API DELETE requests",- "operationId": "securityApiDelete",+ "post": {+ "summary": "Add Event",+ "operationId": "add_event_api_conversations__conversation_id__events_post",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"parameters": [{"name": "conversation_id","in": "path","required": true,"schema": {- "type": "string"- },- "description": "Conversation ID"+ "type": "string",+ "title": "Conversation Id"+ }+ }+ ],+ "responses": {+ "200": {+ "description": "Successful Response",+ "content": {+ "application/json": {+ "schema": {}+ }+ }},+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"+ }+ }+ }+ }+ }+ }+ },+ "/api/conversations/{conversation_id}/microagents": {+ "get": {+ "summary": "Get Microagents",+ "description": "Get all microagents associated with the conversation.\n\nThis endpoint returns all repository and knowledge microagents that are loaded for the conversation.",+ "operationId": "get_microagents_api_conversations__conversation_id__microagents_get",+ "security": [{- "name": "path",+ "APIKeyHeader": []+ }+ ],+ "parameters": [+ {+ "name": "conversation_id","in": "path","required": true,"schema": {- "type": "string"- },- "description": "Security analyzer API path"+ "type": "string",+ "title": "Conversation Id"+ }}],"responses": {"200": {- "description": "Security analyzer response",+ "description": "Successful Response","content": {"application/json": {- "schema": {- "type": "object"- }+ "schema": {}}}},- "404": {- "description": "Security analyzer not initialized",+ "422": {+ "description": "Validation Error","content": {"application/json": {"schema": {- "type": "object",- "properties": {- "detail": {- "type": "string"- }- }+ "$ref": "#/components/schemas/HTTPValidationError"}}}@@ -848,93 +815,41 @@},"/api/conversations": {"post": {- "summary": "Create new conversation",- "description": "Initialize a new conversation",- "operationId": "newConversation",+ "summary": "New Conversation",+ "description": "Initialize a new session or join an existing one.\n\nAfter successful initialization, the client should connect to the WebSocket\nusing the returned conversation ID.",+ "operationId": "new_conversation_api_conversations_post",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"requestBody": {"required": true,"content": {"application/json": {"schema": {- "type": "object",- "properties": {- "repository": {- "type": "string",- "nullable": true,- "description": "Full name of the repository (e.g., owner/repo)"- },- "git_provider": {- "type": "string",- "nullable": true,- "description": "The Git provider (e.g., github or gitlab). If omitted, all configured providers are checked for the repository."- },- "selected_branch": {- "type": "string",- "nullable": true- },- "initial_user_msg": {- "type": "string",- "nullable": true- },- "conversation_instructions": {- "type": "string",- "nullable": true,- "description": "Optional instructions the agent must follow throughout the conversation while addressing the user's initial task"- },- "image_urls": {- "type": "array",- "items": {- "type": "string"- },- "nullable": true- },- "replay_json": {- "type": "string",- "nullable": true- }- }+ "$ref": "#/components/schemas/InitSessionRequest"}}}},"responses": {"200": {- "description": "Conversation created successfully",+ "description": "Successful Response","content": {"application/json": {"schema": {- "type": "object",- "properties": {- "status": {- "type": "string",- "example": "ok"- },- "conversation_id": {- "type": "string"- }- }+ "$ref": "#/components/schemas/ConversationResponse"}}}},- "400": {- "description": "Error creating conversation",+ "422": {+ "description": "Validation Error","content": {"application/json": {"schema": {- "type": "object",- "properties": {- "status": {- "type": "string",- "example": "error"- },- "message": {- "type": "string"- },- "msg_id": {- "type": "string"- }- }+ "$ref": "#/components/schemas/HTTPValidationError"}}}@@ -942,18 +857,29 @@}},"get": {- "summary": "Search conversations",- "description": "Search for conversations",- "operationId": "searchConversations",+ "summary": "Search Conversations",+ "operationId": "search_conversations_api_conversations_get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"parameters": [{"name": "page_id","in": "query","required": false,"schema": {- "type": "string"- },- "description": "Page ID for pagination"+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Page Id"+ }},{"name": "limit",@@ -961,58 +887,60 @@"required": false,"schema": {"type": "integer",- "default": 20- },- "description": "Number of conversations to return"+ "default": 20,+ "title": "Limit"+ }+ },+ {+ "name": "selected_repository",+ "in": "query",+ "required": false,+ "schema": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Selected Repository"+ }+ },+ {+ "name": "conversation_trigger",+ "in": "query",+ "required": false,+ "schema": {+ "anyOf": [+ {+ "$ref": "#/components/schemas/ConversationTrigger"+ },+ {+ "type": "null"+ }+ ],+ "title": "Conversation Trigger"+ }}],"responses": {"200": {- "description": "Conversations",+ "description": "Successful Response","content": {"application/json": {"schema": {- "type": "object",- "properties": {- "results": {- "type": "array",- "items": {- "type": "object",- "properties": {- "conversation_id": {- "type": "string"- },- "title": {- "type": "string"- },- "last_updated_at": {- "type": "string",- "format": "date-time"- },- "created_at": {- "type": "string",- "format": "date-time"- },- "selected_repository": {- "type": "string",- "nullable": true- },- "status": {- "type": "string",- "enum": ["RUNNING", "STOPPED"]- },- "trigger": {- "type": "string",- "enum": ["GUI", "API"]- }- }- }- },- "next_page_id": {- "type": "string",- "nullable": true- }- }+ "$ref": "#/components/schemas/ConversationInfoResultSet"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"}}}@@ -1022,137 +950,146 @@},"/api/conversations/{conversation_id}": {"get": {- "summary": "Get conversation",- "description": "Get conversation details",- "operationId": "getConversation",+ "summary": "Get Conversation",+ "operationId": "get_conversation_api_conversations__conversation_id__get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"parameters": [{"name": "conversation_id","in": "path","required": true,"schema": {- "type": "string"- },- "description": "Conversation ID"+ "type": "string",+ "title": "Conversation Id"+ }}],"responses": {"200": {- "description": "Conversation details",+ "description": "Successful Response","content": {"application/json": {"schema": {- "type": "object",- "properties": {- "conversation_id": {- "type": "string"- },- "title": {- "type": "string"- },- "last_updated_at": {- "type": "string",- "format": "date-time"+ "anyOf": [+ {+ "$ref": "#/components/schemas/ConversationInfo"},- "created_at": {- "type": "string",- "format": "date-time"- },- "selected_repository": {- "type": "string",- "nullable": true- },- "status": {- "type": "string",- "enum": ["RUNNING", "STOPPED"]- },- "trigger": {- "type": "string",- "enum": ["GUI", "API"]+ {+ "type": "null"}- }+ ],+ "title": "Response Get Conversation Api Conversations Conversation Id Get"}}}},- "404": {- "description": "Conversation not found",+ "422": {+ "description": "Validation Error","content": {"application/json": {"schema": {- "type": "object",- "nullable": true+ "$ref": "#/components/schemas/HTTPValidationError"}}}}}},- "patch": {- "summary": "Update conversation",- "description": "Update conversation details",- "operationId": "updateConversation",+ "delete": {+ "summary": "Delete Conversation",+ "operationId": "delete_conversation_api_conversations__conversation_id__delete",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"parameters": [{"name": "conversation_id","in": "path","required": true,"schema": {- "type": "string"- },- "description": "Conversation ID"+ "type": "string",+ "title": "Conversation Id"+ }}],- "requestBody": {- "required": true,- "content": {- "application/json": {- "schema": {- "type": "object",- "properties": {- "title": {- "type": "string"- }+ "responses": {+ "200": {+ "description": "Successful Response",+ "content": {+ "application/json": {+ "schema": {+ "type": "boolean",+ "title": "Response Delete Conversation Api Conversations Conversation Id Delete"}}}- }- },- "responses": {- "200": {- "description": "Conversation updated successfully",+ },+ "422": {+ "description": "Validation Error","content": {"application/json": {"schema": {- "type": "boolean"+ "$ref": "#/components/schemas/HTTPValidationError"}}}}}},- "delete": {- "summary": "Delete conversation",- "description": "Delete a conversation",- "operationId": "deleteConversation",+ "patch": {+ "summary": "Update Conversation",+ "description": "Update conversation metadata.\n\nThis endpoint allows updating conversation details like title.\nOnly the conversation owner can update the conversation.",+ "operationId": "update_conversation_api_conversations__conversation_id__patch",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"parameters": [{"name": "conversation_id","in": "path","required": true,"schema": {- "type": "string"- },- "description": "Conversation ID"+ "type": "string",+ "title": "Conversation Id"+ }}],+ "requestBody": {+ "required": true,+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/UpdateConversationRequest"+ }+ }+ }+ },"responses": {"200": {- "description": "Conversation deleted successfully",+ "description": "Successful Response",+ "content": {+ "application/json": {+ "schema": {+ "type": "boolean",+ "title": "Response Update Conversation Api Conversations Conversation Id Patch"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error","content": {"application/json": {"schema": {- "type": "boolean"+ "$ref": "#/components/schemas/HTTPValidationError"}}}@@ -1160,75 +1097,50 @@}}},- "/api/user/repositories": {+ "/api/conversations/{conversation_id}/remember-prompt": {"get": {- "summary": "Get user repositories",- "description": "Get repositories for the authenticated user",- "operationId": "getUserRepositories",+ "summary": "Get Prompt",+ "operationId": "get_prompt_api_conversations__conversation_id__remember_prompt_get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"parameters": [{- "name": "sort",- "in": "query",- "required": false,+ "name": "conversation_id",+ "in": "path",+ "required": true,"schema": {"type": "string",- "default": "pushed"- },- "description": "Sort order for repositories"+ "title": "Conversation Id"+ }+ },+ {+ "name": "event_id",+ "in": "query",+ "required": true,+ "schema": {+ "type": "integer",+ "title": "Event Id"+ }}],"responses": {"200": {- "description": "User repositories",- "content": {- "application/json": {- "schema": {- "type": "array",- "items": {- "type": "object",- "properties": {- "full_name": {- "type": "string"- },- "description": {- "type": "string",- "nullable": true- },- "html_url": {- "type": "string"- },- "private": {- "type": "boolean"- },- "fork": {- "type": "boolean"- },- "updated_at": {- "type": "string",- "format": "date-time"- }- }- }- }- }- }- },- "401": {- "description": "Authentication error",+ "description": "Successful Response","content": {"application/json": {- "schema": {- "type": "string"- }+ "schema": {}}}},- "500": {- "description": "Unknown error",+ "422": {+ "description": "Validation Error","content": {"application/json": {"schema": {- "type": "string"+ "$ref": "#/components/schemas/HTTPValidationError"}}}@@ -1236,55 +1148,54 @@}}},- "/api/user/info": {- "get": {- "summary": "Get user info",- "description": "Get information about the authenticated user",- "operationId": "getUser",- "responses": {- "200": {- "description": "User information",- "content": {- "application/json": {- "schema": {- "type": "object",- "properties": {- "login": {- "type": "string"- },- "name": {- "type": "string",- "nullable": true- },- "email": {- "type": "string",- "nullable": true- },- "avatar_url": {- "type": "string",- "nullable": true- }- }- }+ "/api/conversations/{conversation_id}/start": {+ "post": {+ "summary": "Start Conversation",+ "description": "Start an agent loop for a conversation.\n\nThis endpoint calls the conversation_manager's maybe_start_agent_loop method\nto start a conversation. If the conversation is already running, it will\nreturn the existing agent loop info.",+ "operationId": "start_conversation_api_conversations__conversation_id__start_post",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],+ "parameters": [+ {+ "name": "conversation_id",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Conversation Id"+ }+ }+ ],+ "requestBody": {+ "required": true,+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/ProvidersSetModel"}}- },- "401": {- "description": "Authentication error",+ }+ },+ "responses": {+ "200": {+ "description": "Successful Response","content": {"application/json": {"schema": {- "type": "string"+ "$ref": "#/components/schemas/ConversationResponse"}}}},- "500": {- "description": "Unknown error",+ "422": {+ "description": "Validation Error","content": {"application/json": {"schema": {- "type": "string"+ "$ref": "#/components/schemas/HTTPValidationError"}}}@@ -1292,104 +1203,44 @@}}},- "/api/user/search/repositories": {- "get": {- "summary": "Search repositories",- "description": "Search for repositories",- "operationId": "searchRepositories",+ "/api/conversations/{conversation_id}/stop": {+ "post": {+ "summary": "Stop Conversation",+ "description": "Stop an agent loop for a conversation.\n\nThis endpoint calls the conversation_manager's close_session method\nto stop a conversation.",+ "operationId": "stop_conversation_api_conversations__conversation_id__stop_post",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],"parameters": [{- "name": "query",- "in": "query",+ "name": "conversation_id",+ "in": "path","required": true,- "schema": {- "type": "string"- },- "description": "Search query"- },- {- "name": "per_page",- "in": "query",- "required": false,- "schema": {- "type": "integer",- "default": 5- },- "description": "Number of repositories to return per page"- },- {- "name": "sort",- "in": "query",- "required": false,- "schema": {- "type": "string",- "default": "stars"- },- "description": "Sort order for repositories"- },- {- "name": "order",- "in": "query",- "required": false,"schema": {"type": "string",- "default": "desc"- },- "description": "Sort direction"+ "title": "Conversation Id"+ }}],"responses": {"200": {- "description": "Search results",- "content": {- "application/json": {- "schema": {- "type": "array",- "items": {- "type": "object",- "properties": {- "full_name": {- "type": "string"- },- "description": {- "type": "string",- "nullable": true- },- "html_url": {- "type": "string"- },- "private": {- "type": "boolean"- },- "fork": {- "type": "boolean"- },- "updated_at": {- "type": "string",- "format": "date-time"- }- }- }- }- }- }- },- "401": {- "description": "Authentication error",+ "description": "Successful Response","content": {"application/json": {"schema": {- "type": "string"+ "$ref": "#/components/schemas/ConversationResponse"}}}},- "500": {- "description": "Unknown error",+ "422": {+ "description": "Validation Error","content": {"application/json": {"schema": {- "type": "string"+ "$ref": "#/components/schemas/HTTPValidationError"}}}@@ -1397,363 +1248,369 @@}}},- "/api/user/suggested-tasks": {+ "/api/settings": {"get": {- "summary": "Get suggested tasks",- "description": "Get suggested tasks for the authenticated user across their most recently pushed repositories",- "operationId": "getSuggestedTasks",+ "summary": "Load Settings",+ "operationId": "load_settings_api_settings_get","responses": {"200": {- "description": "Suggested tasks",+ "description": "Successful Response","content": {"application/json": {"schema": {- "type": "array",- "items": {- "type": "object",- "properties": {- "title": {- "type": "string"- },- "url": {- "type": "string"- },- "repository": {- "type": "string"- },- "type": {- "type": "string"- },- "created_at": {- "type": "string",- "format": "date-time"- }- }- }+ "$ref": "#/components/schemas/GETSettingsModel"}}}},- "401": {- "description": "Authentication error",+ "404": {+ "description": "Settings not found","content": {"application/json": {"schema": {- "type": "string"+ "additionalProperties": true,+ "type": "object",+ "title": "Response 404 Load Settings Api Settings Get"}}}},- "500": {- "description": "Unknown error",+ "401": {+ "description": "Invalid token","content": {"application/json": {"schema": {- "type": "string"+ "additionalProperties": true,+ "type": "object",+ "title": "Response 401 Load Settings Api Settings Get"}}}}- }- }- },- "/api/settings": {- "get": {- "summary": "Get settings",- "description": "Get user settings",- "operationId": "loadSettings",+ },+ "security": [+ {+ "APIKeyHeader": []+ }+ ]+ },+ "post": {+ "summary": "Store Settings",+ "operationId": "store_settings_api_settings_post",+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/Settings"+ }+ }+ },+ "required": true+ },"responses": {"200": {- "description": "User settings",+ "description": "Settings stored successfully","content": {"application/json": {"schema": {+ "additionalProperties": true,"type": "object",- "properties": {- "language": {- "type": "string"- },- "agent": {- "type": "string"- },- "security_analyzer": {- "type": "string"- },- "confirmation_mode": {- "type": "boolean"- },- "llm_model": {- "type": "string"- },- "llm_api_key_set": {- "type": "boolean"- },- "llm_base_url": {- "type": "string",- "nullable": true- },- "remote_runtime_resource_factor": {- "type": "number"- },- "enable_default_condenser": {- "type": "boolean"- },- "enable_sound_notifications": {- "type": "boolean"- },- "user_consents_to_analytics": {- "type": "boolean"- },- "provider_tokens_set": {- "type": "object",- "additionalProperties": {- "type": "boolean"- }- }- }+ "title": "Response 200 Store Settings Api Settings Post"}}}},- "401": {- "description": "Invalid token",+ "500": {+ "description": "Error storing settings","content": {"application/json": {"schema": {+ "additionalProperties": true,"type": "object",- "properties": {- "error": {- "type": "string"- }- }+ "title": "Response 500 Store Settings Api Settings Post"}}}},- "404": {- "description": "Settings not found",+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"+ }+ }+ }+ }+ },+ "security": [+ {+ "APIKeyHeader": []+ }+ ]+ }+ },+ "/api/reset-settings": {+ "post": {+ "summary": "Reset Settings",+ "description": "Resets user settings. (Deprecated)",+ "operationId": "reset_settings_api_reset_settings_post",+ "responses": {+ "200": {+ "description": "Successful Response",+ "content": {+ "application/json": {+ "schema": {}+ }+ }+ },+ "410": {+ "description": "Reset settings functionality has been removed","content": {"application/json": {"schema": {+ "additionalProperties": true,"type": "object",- "properties": {- "error": {- "type": "string"- }- }+ "title": "Response 410 Reset Settings Api Reset Settings Post"}}}}- }- },+ },+ "security": [+ {+ "APIKeyHeader": []+ }+ ]+ }+ },+ "/api/add-git-providers": {"post": {- "summary": "Store settings",- "description": "Store user settings",- "operationId": "storeSettings",+ "summary": "Store Provider Tokens",+ "operationId": "store_provider_tokens_api_add_git_providers_post","requestBody": {- "required": true,"content": {"application/json": {"schema": {- "type": "object",- "properties": {- "language": {- "type": "string"- },- "agent": {- "type": "string"- },- "security_analyzer": {- "type": "string"- },- "confirmation_mode": {- "type": "boolean"- },- "llm_model": {- "type": "string"- },- "llm_api_key": {- "type": "string"- },- "llm_base_url": {- "type": "string",- "nullable": true- },- "remote_runtime_resource_factor": {- "type": "number"- },- "enable_default_condenser": {- "type": "boolean"- },- "enable_sound_notifications": {- "type": "boolean"- },- "user_consents_to_analytics": {- "type": "boolean"- },- "provider_tokens": {- "type": "object",- "additionalProperties": {- "type": "string"- }- }- }+ "$ref": "#/components/schemas/POSTProviderModel"}}- }+ },+ "required": true},"responses": {"200": {- "description": "Settings stored successfully",+ "description": "Successful Response","content": {"application/json": {- "schema": {- "type": "object",- "properties": {- "message": {- "type": "string"- }- }- }+ "schema": {}}}},- "401": {- "description": "Invalid token",+ "422": {+ "description": "Validation Error","content": {"application/json": {"schema": {- "type": "object",- "properties": {- "error": {- "type": "string"- }- }+ "$ref": "#/components/schemas/HTTPValidationError"}}}- },- "500": {- "description": "Error storing settings",+ }+ },+ "security": [+ {+ "APIKeyHeader": []+ }+ ]+ }+ },+ "/api/unset-provider-tokens": {+ "post": {+ "summary": "Unset Provider Tokens",+ "operationId": "unset_provider_tokens_api_unset_provider_tokens_post",+ "responses": {+ "200": {+ "description": "Successful Response","content": {"application/json": {"schema": {+ "additionalProperties": {+ "type": "string"+ },"type": "object",- "properties": {- "error": {- "type": "string"- }- }+ "title": "Response Unset Provider Tokens Api Unset Provider Tokens Post"}}}}- }+ },+ "security": [+ {+ "APIKeyHeader": []+ }+ ]}},- "/api/reset-settings": {- "post": {- "summary": "Reset settings (Deprecated)",- "description": "This endpoint is deprecated and will return a 410 Gone error. Reset functionality has been removed.",- "operationId": "resetSettings",- "deprecated": true,+ "/api/secrets": {+ "get": {+ "summary": "Load Custom Secrets Names",+ "operationId": "load_custom_secrets_names_api_secrets_get","responses": {- "410": {- "description": "Feature removed",+ "200": {+ "description": "Successful Response","content": {"application/json": {"schema": {- "type": "object",- "properties": {- "error": {- "type": "string",- "example": "Reset settings functionality has been removed."- }- }+ "$ref": "#/components/schemas/GETCustomSecrets"}}}}- }- }- },- "/api/unset-settings-tokens": {+ },+ "security": [+ {+ "APIKeyHeader": []+ }+ ]+ },"post": {- "summary": "Unset settings tokens",- "description": "Unset provider tokens in settings",- "operationId": "unsetSettingsTokens",+ "summary": "Create Custom Secret",+ "operationId": "create_custom_secret_api_secrets_post",+ "requestBody": {+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/CustomSecretModel"+ }+ }+ },+ "required": true+ },"responses": {"200": {- "description": "Tokens unset successfully",+ "description": "Successful Response","content": {"application/json": {"schema": {+ "additionalProperties": {+ "type": "string"+ },"type": "object",- "properties": {- "message": {- "type": "string"- }- }+ "title": "Response Create Custom Secret Api Secrets Post"}}}},- "500": {- "description": "Error unsetting tokens",+ "422": {+ "description": "Validation Error","content": {"application/json": {"schema": {- "type": "object",- "properties": {- "error": {- "type": "string"- }- }+ "$ref": "#/components/schemas/HTTPValidationError"}}}}- }+ },+ "security": [+ {+ "APIKeyHeader": []+ }+ ]}},- "/api/options/models": {- "get": {- "summary": "Get models",- "description": "Get all models supported by LiteLLM",- "operationId": "getLitellmModels",+ "/api/secrets/{secret_id}": {+ "put": {+ "summary": "Update Custom Secret",+ "operationId": "update_custom_secret_api_secrets__secret_id__put",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],+ "parameters": [+ {+ "name": "secret_id",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Secret Id"+ }+ }+ ],+ "requestBody": {+ "required": true,+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/CustomSecretWithoutValueModel"+ }+ }+ }+ },"responses": {"200": {- "description": "List of models",+ "description": "Successful Response","content": {"application/json": {"schema": {- "type": "array",- "items": {+ "type": "object",+ "additionalProperties": {"type": "string"- }+ },+ "title": "Response Update Custom Secret Api Secrets Secret Id Put"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"}}}}}- }- },- "/api/options/agents": {- "get": {- "summary": "Get agents",- "description": "Get all agents supported by OpenHands",- "operationId": "getAgents",+ },+ "delete": {+ "summary": "Delete Custom Secret",+ "operationId": "delete_custom_secret_api_secrets__secret_id__delete",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],+ "parameters": [+ {+ "name": "secret_id",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Secret Id"+ }+ }+ ],"responses": {"200": {- "description": "List of agents",+ "description": "Successful Response",+ "content": {+ "application/json": {+ "schema": {}+ }+ }+ },+ "422": {+ "description": "Validation Error","content": {"application/json": {"schema": {- "type": "array",- "items": {- "type": "string"- }+ "$ref": "#/components/schemas/HTTPValidationError"}}}@@ -1761,21 +1618,501 @@}}},- "/api/options/security-analyzers": {+ "/api/user/installations": {"get": {- "summary": "Get security analyzers",- "description": "Get all supported security analyzers",- "operationId": "getSecurityAnalyzers",+ "summary": "Get User Installations",+ "operationId": "get_user_installations_api_user_installations_get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],+ "parameters": [+ {+ "name": "provider",+ "in": "query",+ "required": true,+ "schema": {+ "$ref": "#/components/schemas/ProviderType"+ }+ }+ ],"responses": {"200": {- "description": "List of security analyzers",+ "description": "Successful Response","content": {"application/json": {"schema": {"type": "array","items": {"type": "string"- }+ },+ "title": "Response Get User Installations Api User Installations Get"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"+ }+ }+ }+ }+ }+ }+ },+ "/api/user/repositories": {+ "get": {+ "summary": "Get User Repositories",+ "operationId": "get_user_repositories_api_user_repositories_get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],+ "parameters": [+ {+ "name": "sort",+ "in": "query",+ "required": false,+ "schema": {+ "type": "string",+ "default": "pushed",+ "title": "Sort"+ }+ },+ {+ "name": "selected_provider",+ "in": "query",+ "required": false,+ "schema": {+ "anyOf": [+ {+ "$ref": "#/components/schemas/ProviderType"+ },+ {+ "type": "null"+ }+ ],+ "title": "Selected Provider"+ }+ },+ {+ "name": "page",+ "in": "query",+ "required": false,+ "schema": {+ "anyOf": [+ {+ "type": "integer"+ },+ {+ "type": "null"+ }+ ],+ "title": "Page"+ }+ },+ {+ "name": "per_page",+ "in": "query",+ "required": false,+ "schema": {+ "anyOf": [+ {+ "type": "integer"+ },+ {+ "type": "null"+ }+ ],+ "title": "Per Page"+ }+ },+ {+ "name": "installation_id",+ "in": "query",+ "required": false,+ "schema": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Installation Id"+ }+ }+ ],+ "responses": {+ "200": {+ "description": "Successful Response",+ "content": {+ "application/json": {+ "schema": {+ "type": "array",+ "items": {+ "$ref": "#/components/schemas/Repository"+ },+ "title": "Response Get User Repositories Api User Repositories Get"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"+ }+ }+ }+ }+ }+ }+ },+ "/api/user/info": {+ "get": {+ "summary": "Get User",+ "operationId": "get_user_api_user_info_get",+ "responses": {+ "200": {+ "description": "Successful Response",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/User"+ }+ }+ }+ }+ },+ "security": [+ {+ "APIKeyHeader": []+ }+ ]+ }+ },+ "/api/user/search/repositories": {+ "get": {+ "summary": "Search Repositories",+ "operationId": "search_repositories_api_user_search_repositories_get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],+ "parameters": [+ {+ "name": "query",+ "in": "query",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Query"+ }+ },+ {+ "name": "per_page",+ "in": "query",+ "required": false,+ "schema": {+ "type": "integer",+ "default": 5,+ "title": "Per Page"+ }+ },+ {+ "name": "sort",+ "in": "query",+ "required": false,+ "schema": {+ "type": "string",+ "default": "stars",+ "title": "Sort"+ }+ },+ {+ "name": "order",+ "in": "query",+ "required": false,+ "schema": {+ "type": "string",+ "default": "desc",+ "title": "Order"+ }+ },+ {+ "name": "selected_provider",+ "in": "query",+ "required": false,+ "schema": {+ "anyOf": [+ {+ "$ref": "#/components/schemas/ProviderType"+ },+ {+ "type": "null"+ }+ ],+ "title": "Selected Provider"+ }+ }+ ],+ "responses": {+ "200": {+ "description": "Successful Response",+ "content": {+ "application/json": {+ "schema": {+ "type": "array",+ "items": {+ "$ref": "#/components/schemas/Repository"+ },+ "title": "Response Search Repositories Api User Search Repositories Get"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"+ }+ }+ }+ }+ }+ }+ },+ "/api/user/suggested-tasks": {+ "get": {+ "summary": "Get Suggested Tasks",+ "description": "Get suggested tasks for the authenticated user across their most recently pushed repositories.",+ "operationId": "get_suggested_tasks_api_user_suggested_tasks_get",+ "responses": {+ "200": {+ "description": "Successful Response",+ "content": {+ "application/json": {+ "schema": {+ "items": {+ "$ref": "#/components/schemas/SuggestedTask"+ },+ "type": "array",+ "title": "Response Get Suggested Tasks Api User Suggested Tasks Get"+ }+ }+ }+ }+ },+ "security": [+ {+ "APIKeyHeader": []+ }+ ]+ }+ },+ "/api/user/repository/branches": {+ "get": {+ "summary": "Get Repository Branches",+ "description": "Get branches for a repository.",+ "operationId": "get_repository_branches_api_user_repository_branches_get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],+ "parameters": [+ {+ "name": "repository",+ "in": "query",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Repository"+ }+ }+ ],+ "responses": {+ "200": {+ "description": "Successful Response",+ "content": {+ "application/json": {+ "schema": {+ "type": "array",+ "items": {+ "$ref": "#/components/schemas/Branch"+ },+ "title": "Response Get Repository Branches Api User Repository Branches Get"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"+ }+ }+ }+ }+ }+ }+ },+ "/api/user/repository/{repository_name}/microagents": {+ "get": {+ "summary": "Get Repository Microagents",+ "description": "Scan the microagents directory of a repository and return the list of microagents.\n\nThe microagents directory location depends on the git provider and actual repository name:\n- If git provider is not GitLab and actual repository name is \".openhands\": scans \"microagents\" folder\n- If git provider is GitLab and actual repository name is \"openhands-config\": scans \"microagents\" folder\n- Otherwise: scans \".openhands/microagents\" folder",+ "operationId": "get_repository_microagents_api_user_repository__repository_name__microagents_get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],+ "parameters": [+ {+ "name": "repository_name",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Repository Name"+ }+ }+ ],+ "responses": {+ "200": {+ "description": "Successful Response",+ "content": {+ "application/json": {+ "schema": {+ "type": "array",+ "items": {+ "$ref": "#/components/schemas/MicroagentResponse"+ },+ "title": "Response Get Repository Microagents Api User Repository Repository Name Microagents Get"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"+ }+ }+ }+ }+ }+ }+ },+ "/api/user/repository/{repository_name}/microagents/content": {+ "get": {+ "summary": "Get Repository Microagent Content",+ "description": "Fetch the content of a specific microagent file from a repository.",+ "operationId": "get_repository_microagent_content_api_user_repository__repository_name__microagents_content_get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],+ "parameters": [+ {+ "name": "repository_name",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Repository Name"+ }+ },+ {+ "name": "file_path",+ "in": "query",+ "required": true,+ "schema": {+ "type": "string",+ "description": "Path to the microagent file within the repository",+ "title": "File Path"+ },+ "description": "Path to the microagent file within the repository"+ }+ ],+ "responses": {+ "200": {+ "description": "Successful Response",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/MicroagentContentResponse"+ }+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"+ }+ }+ }+ }+ }+ }+ },+ "/api/conversations/{conversation_id}/trajectory": {+ "get": {+ "summary": "Get Trajectory",+ "description": "Get trajectory.\n\nThis function retrieves the current trajectory and returns it.",+ "operationId": "get_trajectory_api_conversations__conversation_id__trajectory_get",+ "security": [+ {+ "APIKeyHeader": []+ }+ ],+ "parameters": [+ {+ "name": "conversation_id",+ "in": "path",+ "required": true,+ "schema": {+ "type": "string",+ "title": "Conversation Id"+ }+ }+ ],+ "responses": {+ "200": {+ "description": "Successful Response",+ "content": {+ "application/json": {+ "schema": {}+ }+ }+ },+ "422": {+ "description": "Validation Error",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/HTTPValidationError"}}}@@ -1783,18 +2120,34 @@}}},- "/api/options/config": {+ "/alive": {+ "get": {+ "summary": "Alive",+ "operationId": "alive_alive_get",+ "responses": {+ "200": {+ "description": "Successful Response",+ "content": {+ "application/json": {+ "schema": {}+ }+ }+ }+ }+ }+ },+ "/health": {"get": {- "summary": "Get config",- "description": "Get current server configuration",- "operationId": "getConfig",+ "summary": "Health",+ "operationId": "health_health_get","responses": {"200": {- "description": "Server configuration",+ "description": "Successful Response","content": {"application/json": {"schema": {- "type": "object"+ "type": "string",+ "title": "Response Health Health Get"}}}@@ -1805,292 +2158,1785 @@},"components": {"schemas": {- "Repository": {+ "Body_upload_files_api_conversations__conversation_id__upload_files_post": {+ "properties": {+ "files": {+ "items": {+ "type": "string",+ "format": "binary"+ },+ "type": "array",+ "title": "Files"+ }+ },"type": "object",+ "required": [+ "files"+ ],+ "title": "Body_upload_files_api_conversations__conversation_id__upload_files_post"+ },+ "Branch": {"properties": {- "full_name": {- "type": "string"+ "name": {+ "type": "string",+ "title": "Name"+ },+ "commit_sha": {+ "type": "string",+ "title": "Commit Sha"+ },+ "protected": {+ "type": "boolean",+ "title": "Protected"+ },+ "last_push_date": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Last Push Date"+ }+ },+ "type": "object",+ "required": [+ "name",+ "commit_sha",+ "protected"+ ],+ "title": "Branch"+ },+ "ConversationInfo": {+ "properties": {+ "conversation_id": {+ "type": "string",+ "title": "Conversation Id"+ },+ "title": {+ "type": "string",+ "title": "Title"+ },+ "last_updated_at": {+ "anyOf": [+ {+ "type": "string",+ "format": "date-time"+ },+ {+ "type": "null"+ }+ ],+ "title": "Last Updated At"+ },+ "status": {+ "$ref": "#/components/schemas/ConversationStatus",+ "default": "STOPPED"+ },+ "runtime_status": {+ "anyOf": [+ {+ "$ref": "#/components/schemas/RuntimeStatus"+ },+ {+ "type": "null"+ }+ ]+ },+ "selected_repository": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Selected Repository"+ },+ "selected_branch": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Selected Branch"+ },+ "git_provider": {+ "anyOf": [+ {+ "$ref": "#/components/schemas/ProviderType"+ },+ {+ "type": "null"+ }+ ]+ },+ "trigger": {+ "anyOf": [+ {+ "$ref": "#/components/schemas/ConversationTrigger"+ },+ {+ "type": "null"+ }+ ]+ },+ "num_connections": {+ "type": "integer",+ "title": "Num Connections",+ "default": 0+ },+ "url": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Url"+ },+ "session_api_key": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Session Api Key"+ },+ "created_at": {+ "type": "string",+ "format": "date-time",+ "title": "Created At"+ },+ "pr_number": {+ "items": {+ "type": "integer"+ },+ "type": "array",+ "title": "Pr Number"+ }+ },+ "type": "object",+ "required": [+ "conversation_id",+ "title"+ ],+ "title": "ConversationInfo"+ },+ "ConversationInfoResultSet": {+ "properties": {+ "results": {+ "items": {+ "$ref": "#/components/schemas/ConversationInfo"+ },+ "type": "array",+ "title": "Results"+ },+ "next_page_id": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Next Page Id"+ }+ },+ "type": "object",+ "title": "ConversationInfoResultSet"+ },+ "ConversationResponse": {+ "properties": {+ "status": {+ "type": "string",+ "title": "Status"+ },+ "conversation_id": {+ "type": "string",+ "title": "Conversation Id"+ },+ "message": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Message"+ },+ "conversation_status": {+ "anyOf": [+ {+ "$ref": "#/components/schemas/ConversationStatus"+ },+ {+ "type": "null"+ }+ ]+ }+ },+ "type": "object",+ "required": [+ "status",+ "conversation_id"+ ],+ "title": "ConversationResponse"+ },+ "ConversationStatus": {+ "type": "string",+ "enum": [+ "STARTING",+ "RUNNING",+ "STOPPED"+ ],+ "title": "ConversationStatus"+ },+ "ConversationTrigger": {+ "type": "string",+ "enum": [+ "resolver",+ "gui",+ "suggested_task",+ "openhands_api",+ "slack",+ "microagent_management",+ "jira",+ "jira_dc",+ "linear"+ ],+ "title": "ConversationTrigger"+ },+ "CreateMicroagent": {+ "properties": {+ "repo": {+ "type": "string",+ "title": "Repo"+ },+ "git_provider": {+ "anyOf": [+ {+ "$ref": "#/components/schemas/ProviderType"+ },+ {+ "type": "null"+ }+ ]+ },+ "title": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Title"+ }+ },+ "type": "object",+ "required": [+ "repo"+ ],+ "title": "CreateMicroagent"+ },+ "CustomSecretModel": {+ "properties": {+ "name": {+ "type": "string",+ "title": "Name"},"description": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Description"+ },+ "value": {+ "type": "string",+ "format": "password",+ "title": "Value",+ "writeOnly": true+ }+ },+ "type": "object",+ "required": [+ "name",+ "value"+ ],+ "title": "CustomSecretModel",+ "description": "Custom secret model with value"+ },+ "CustomSecretWithoutValueModel": {+ "properties": {+ "name": {"type": "string",- "nullable": true+ "title": "Name"+ },+ "description": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Description"+ }+ },+ "type": "object",+ "required": [+ "name"+ ],+ "title": "CustomSecretWithoutValueModel",+ "description": "Custom secret model without value"+ },+ "EventFilter": {+ "properties": {+ "exclude_hidden": {+ "type": "boolean",+ "title": "Exclude Hidden",+ "default": false+ },+ "query": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Query"+ },+ "include_types": {+ "anyOf": [+ {+ "items": {},+ "type": "array"+ },+ {+ "type": "null"+ }+ ],+ "title": "Include Types"+ },+ "exclude_types": {+ "anyOf": [+ {+ "items": {},+ "type": "array"+ },+ {+ "type": "null"+ }+ ],+ "title": "Exclude Types"+ },+ "source": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Source"+ },+ "start_date": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Start Date"+ },+ "end_date": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "End Date"+ }+ },+ "type": "object",+ "title": "EventFilter"+ },+ "ExperimentConfig": {+ "properties": {+ "config": {+ "anyOf": [+ {+ "additionalProperties": {+ "type": "string"+ },+ "type": "object"+ },+ {+ "type": "null"+ }+ ],+ "title": "Config"+ }+ },+ "type": "object",+ "title": "ExperimentConfig"+ },+ "GETCustomSecrets": {+ "properties": {+ "custom_secrets": {+ "anyOf": [+ {+ "items": {+ "$ref": "#/components/schemas/CustomSecretWithoutValueModel"+ },+ "type": "array"+ },+ {+ "type": "null"+ }+ ],+ "title": "Custom Secrets"+ }+ },+ "type": "object",+ "title": "GETCustomSecrets",+ "description": "Custom secrets names"+ },+ "GETSettingsModel": {+ "properties": {+ "language": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Language"+ },+ "agent": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Agent"+ },+ "max_iterations": {+ "anyOf": [+ {+ "type": "integer"+ },+ {+ "type": "null"+ }+ ],+ "title": "Max Iterations"+ },+ "security_analyzer": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Security Analyzer"+ },+ "confirmation_mode": {+ "anyOf": [+ {+ "type": "boolean"+ },+ {+ "type": "null"+ }+ ],+ "title": "Confirmation Mode"+ },+ "llm_model": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Llm Model"+ },+ "llm_api_key": {+ "anyOf": [+ {+ "type": "string",+ "format": "password",+ "writeOnly": true+ },+ {+ "type": "null"+ }+ ],+ "title": "Llm Api Key"+ },+ "llm_base_url": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Llm Base Url"+ },+ "remote_runtime_resource_factor": {+ "anyOf": [+ {+ "type": "integer"+ },+ {+ "type": "null"+ }+ ],+ "title": "Remote Runtime Resource Factor"+ },+ "secrets_store": {+ "$ref": "#/components/schemas/UserSecrets-Output"+ },+ "enable_default_condenser": {+ "type": "boolean",+ "title": "Enable Default Condenser",+ "default": true+ },+ "enable_sound_notifications": {+ "type": "boolean",+ "title": "Enable Sound Notifications",+ "default": false+ },+ "enable_proactive_conversation_starters": {+ "type": "boolean",+ "title": "Enable Proactive Conversation Starters",+ "default": true+ },+ "enable_solvability_analysis": {+ "type": "boolean",+ "title": "Enable Solvability Analysis",+ "default": true+ },+ "user_consents_to_analytics": {+ "anyOf": [+ {+ "type": "boolean"+ },+ {+ "type": "null"+ }+ ],+ "title": "User Consents To Analytics"+ },+ "sandbox_base_container_image": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Sandbox Base Container Image"+ },+ "sandbox_runtime_container_image": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Sandbox Runtime Container Image"+ },+ "mcp_config": {+ "anyOf": [+ {+ "$ref": "#/components/schemas/MCPConfig"+ },+ {+ "type": "null"+ }+ ]+ },+ "search_api_key": {+ "anyOf": [+ {+ "type": "string",+ "format": "password",+ "writeOnly": true+ },+ {+ "type": "null"+ }+ ],+ "title": "Search Api Key"+ },+ "sandbox_api_key": {+ "anyOf": [+ {+ "type": "string",+ "format": "password",+ "writeOnly": true+ },+ {+ "type": "null"+ }+ ],+ "title": "Sandbox Api Key"+ },+ "max_budget_per_task": {+ "anyOf": [+ {+ "type": "number"+ },+ {+ "type": "null"+ }+ ],+ "title": "Max Budget Per Task"},- "html_url": {- "type": "string"+ "email": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Email"+ },+ "email_verified": {+ "anyOf": [+ {+ "type": "boolean"+ },+ {+ "type": "null"+ }+ ],+ "title": "Email Verified"+ },+ "git_user_name": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Git User Name"+ },+ "git_user_email": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Git User Email"+ },+ "provider_tokens_set": {+ "anyOf": [+ {+ "additionalProperties": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ]+ },+ "propertyNames": {+ "$ref": "#/components/schemas/ProviderType"+ },+ "type": "object"+ },+ {+ "type": "null"+ }+ ],+ "title": "Provider Tokens Set"},- "private": {- "type": "boolean"+ "llm_api_key_set": {+ "type": "boolean",+ "title": "Llm Api Key Set"},- "fork": {- "type": "boolean"+ "search_api_key_set": {+ "type": "boolean",+ "title": "Search Api Key Set",+ "default": false+ }+ },+ "type": "object",+ "required": [+ "llm_api_key_set"+ ],+ "title": "GETSettingsModel",+ "description": "Settings with additional token data for the frontend"+ },+ "HTTPValidationError": {+ "properties": {+ "detail": {+ "items": {+ "$ref": "#/components/schemas/ValidationError"+ },+ "type": "array",+ "title": "Detail"+ }+ },+ "type": "object",+ "title": "HTTPValidationError"+ },+ "InitSessionRequest": {+ "properties": {+ "repository": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Repository"+ },+ "git_provider": {+ "anyOf": [+ {+ "$ref": "#/components/schemas/ProviderType"+ },+ {+ "type": "null"+ }+ ]+ },+ "selected_branch": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Selected Branch"+ },+ "initial_user_msg": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Initial User Msg"+ },+ "image_urls": {+ "anyOf": [+ {+ "items": {+ "type": "string"+ },+ "type": "array"+ },+ {+ "type": "null"+ }+ ],+ "title": "Image Urls"+ },+ "replay_json": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Replay Json"+ },+ "suggested_task": {+ "anyOf": [+ {+ "$ref": "#/components/schemas/SuggestedTask"+ },+ {+ "type": "null"+ }+ ]+ },+ "create_microagent": {+ "anyOf": [+ {+ "$ref": "#/components/schemas/CreateMicroagent"+ },+ {+ "type": "null"+ }+ ]+ },+ "conversation_instructions": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Conversation Instructions"+ },+ "mcp_config": {+ "anyOf": [+ {+ "$ref": "#/components/schemas/MCPConfig"+ },+ {+ "type": "null"+ }+ ]},- "updated_at": {+ "conversation_id": {"type": "string",- "format": "date-time"+ "title": "Conversation Id"+ }+ },+ "additionalProperties": false,+ "type": "object",+ "title": "InitSessionRequest"+ },+ "MCPConfig": {+ "properties": {+ "sse_servers": {+ "items": {+ "$ref": "#/components/schemas/MCPSSEServerConfig"+ },+ "type": "array",+ "title": "Sse Servers"},- "owner_type": {+ "stdio_servers": {+ "items": {+ "$ref": "#/components/schemas/MCPStdioServerConfig"+ },+ "type": "array",+ "title": "Stdio Servers"+ },+ "shttp_servers": {+ "items": {+ "$ref": "#/components/schemas/MCPSHTTPServerConfig"+ },+ "type": "array",+ "title": "Shttp Servers"+ }+ },+ "additionalProperties": false,+ "type": "object",+ "title": "MCPConfig",+ "description": "Configuration for MCP (Message Control Protocol) settings.\n\nAttributes:\n sse_servers: List of MCP SSE server configs\n stdio_servers: List of MCP stdio server configs. These servers will be added to the MCP Router running inside runtime container.\n shttp_servers: List of MCP HTTP server configs."+ },+ "MCPSHTTPServerConfig": {+ "properties": {+ "url": {"type": "string",- "enum": ["user", "organization"],- "nullable": true+ "title": "Url"+ },+ "api_key": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Api Key"}- }+ },+ "type": "object",+ "required": [+ "url"+ ],+ "title": "MCPSHTTPServerConfig"},- "User": {+ "MCPSSEServerConfig": {+ "properties": {+ "url": {+ "type": "string",+ "title": "Url"+ },+ "api_key": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Api Key"+ }+ },"type": "object",+ "required": [+ "url"+ ],+ "title": "MCPSSEServerConfig",+ "description": "Configuration for a single MCP server.\n\nAttributes:\n url: The server URL\n api_key: Optional API key for authentication"+ },+ "MCPStdioServerConfig": {"properties": {- "login": {- "type": "string"- },"name": {"type": "string",- "nullable": true+ "title": "Name"},- "email": {+ "command": {"type": "string",- "nullable": true+ "title": "Command"},- "avatar_url": {- "type": "string",- "nullable": true+ "args": {+ "items": {+ "type": "string"+ },+ "type": "array",+ "title": "Args"+ },+ "env": {+ "additionalProperties": {+ "type": "string"+ },+ "type": "object",+ "title": "Env"}- }- },- "SuggestedTask": {+ },"type": "object",+ "required": [+ "name",+ "command"+ ],+ "title": "MCPStdioServerConfig",+ "description": "Configuration for a MCP server that uses stdio.\n\nAttributes:\n name: The name of the server\n command: The command to run the server\n args: The arguments to pass to the server\n env: The environment variables to set for the server"+ },+ "MicroagentContentResponse": {"properties": {- "title": {- "type": "string"- },- "url": {- "type": "string"+ "content": {+ "type": "string",+ "title": "Content"},- "repository": {- "type": "string"+ "path": {+ "type": "string",+ "title": "Path"},- "type": {- "type": "string"+ "triggers": {+ "items": {+ "type": "string"+ },+ "type": "array",+ "title": "Triggers",+ "default": []},- "created_at": {- "type": "string",- "format": "date-time"+ "git_provider": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Git Provider"}- }- },- "ConversationInfo": {+ },"type": "object",+ "required": [+ "content",+ "path"+ ],+ "title": "MicroagentContentResponse",+ "description": "Response model for individual microagent content endpoint."+ },+ "MicroagentResponse": {"properties": {- "conversation_id": {- "type": "string"- },- "title": {- "type": "string"- },- "last_updated_at": {- "type": "string",- "format": "date-time"- },- "created_at": {- "type": "string",- "format": "date-time"- },- "selected_repository": {+ "name": {"type": "string",- "nullable": true+ "title": "Name"},- "status": {+ "path": {"type": "string",- "enum": ["RUNNING", "STOPPED"]+ "title": "Path"},- "trigger": {+ "created_at": {"type": "string",- "enum": ["GUI", "API"]+ "format": "date-time",+ "title": "Created At"}- }+ },+ "type": "object",+ "required": [+ "name",+ "path",+ "created_at"+ ],+ "title": "MicroagentResponse",+ "description": "Response model for microagents endpoint.\n\nNote: This model only includes basic metadata that can be determined\nwithout parsing microagent content. Use the separate content API\nto get detailed microagent information."},- "ConversationInfoResultSet": {+ "OwnerType": {+ "type": "string",+ "enum": [+ "user",+ "organization"+ ],+ "title": "OwnerType"+ },+ "POSTProviderModel": {+ "properties": {+ "mcp_config": {+ "anyOf": [+ {+ "$ref": "#/components/schemas/MCPConfig"+ },+ {+ "type": "null"+ }+ ]+ },+ "provider_tokens": {+ "additionalProperties": {+ "$ref": "#/components/schemas/ProviderToken"+ },+ "propertyNames": {+ "$ref": "#/components/schemas/ProviderType"+ },+ "type": "object",+ "title": "Provider Tokens",+ "default": {}+ }+ },"type": "object",+ "title": "POSTProviderModel",+ "description": "Settings for POST requests"+ },+ "POSTUploadFilesModel": {"properties": {- "results": {- "type": "array",+ "file_urls": {"items": {- "$ref": "#/components/schemas/ConversationInfo"- }+ "type": "string"+ },+ "type": "array",+ "title": "File Urls"},- "next_page_id": {- "type": "string",- "nullable": true+ "skipped_files": {+ "items": {+ "type": "string"+ },+ "type": "array",+ "title": "Skipped Files"}- }+ },+ "type": "object",+ "required": [+ "file_urls",+ "skipped_files"+ ],+ "title": "POSTUploadFilesModel",+ "description": "Upload files response model"+ },+ "ProviderToken": {+ "properties": {+ "token": {+ "anyOf": [+ {+ "type": "string",+ "format": "password",+ "writeOnly": true+ },+ {+ "type": "null"+ }+ ],+ "title": "Token"+ },+ "user_id": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "User Id"+ },+ "host": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Host"+ }+ },+ "type": "object",+ "title": "ProviderToken"},- "FeedbackDataModel": {+ "ProviderType": {+ "type": "string",+ "enum": [+ "github",+ "gitlab",+ "bitbucket",+ "enterprise_sso"+ ],+ "title": "ProviderType"+ },+ "ProvidersSetModel": {+ "properties": {+ "providers_set": {+ "anyOf": [+ {+ "items": {+ "$ref": "#/components/schemas/ProviderType"+ },+ "type": "array"+ },+ {+ "type": "null"+ }+ ],+ "title": "Providers Set"+ }+ },"type": "object",+ "title": "ProvidersSetModel"+ },+ "Repository": {"properties": {- "email": {+ "id": {"type": "string",- "format": "email"+ "title": "Id"},- "version": {- "type": "string"- },- "permissions": {+ "full_name": {"type": "string",- "default": "private"- },- "polarity": {- "type": "string"- },- "feedback": {- "type": "string"+ "title": "Full Name"+ },+ "git_provider": {+ "$ref": "#/components/schemas/ProviderType"+ },+ "is_public": {+ "type": "boolean",+ "title": "Is Public"+ },+ "stargazers_count": {+ "anyOf": [+ {+ "type": "integer"+ },+ {+ "type": "null"+ }+ ],+ "title": "Stargazers Count"+ },+ "link_header": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Link Header"+ },+ "pushed_at": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Pushed At"},- "trajectory": {- "type": "array",- "items": {- "type": "object"- }+ "owner_type": {+ "anyOf": [+ {+ "$ref": "#/components/schemas/OwnerType"+ },+ {+ "type": "null"+ }+ ]+ },+ "main_branch": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Main Branch"}- }+ },+ "type": "object",+ "required": [+ "id",+ "full_name",+ "git_provider",+ "is_public"+ ],+ "title": "Repository"+ },+ "RuntimeStatus": {+ "type": "string",+ "enum": [+ "STATUS$STOPPED",+ "STATUS$BUILDING_RUNTIME",+ "STATUS$STARTING_RUNTIME",+ "STATUS$RUNTIME_STARTED",+ "STATUS$SETTING_UP_WORKSPACE",+ "STATUS$SETTING_UP_GIT_HOOKS",+ "STATUS$READY",+ "STATUS$ERROR",+ "STATUS$ERROR_RUNTIME_DISCONNECTED",+ "STATUS$ERROR_LLM_AUTHENTICATION",+ "STATUS$ERROR_LLM_SERVICE_UNAVAILABLE",+ "STATUS$ERROR_LLM_INTERNAL_SERVER_ERROR",+ "STATUS$ERROR_LLM_OUT_OF_CREDITS",+ "STATUS$ERROR_LLM_CONTENT_POLICY_VIOLATION",+ "CHAT_INTERFACE$AGENT_RATE_LIMITED_STOPPED_MESSAGE",+ "STATUS$GIT_PROVIDER_AUTHENTICATION_ERROR",+ "STATUS$LLM_RETRY",+ "STATUS$ERROR_MEMORY"+ ],+ "title": "RuntimeStatus"},"Settings": {- "type": "object","properties": {"language": {- "type": "string"+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Language"},"agent": {- "type": "string"+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Agent"+ },+ "max_iterations": {+ "anyOf": [+ {+ "type": "integer"+ },+ {+ "type": "null"+ }+ ],+ "title": "Max Iterations"},"security_analyzer": {- "type": "string"+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Security Analyzer"},"confirmation_mode": {- "type": "boolean"+ "anyOf": [+ {+ "type": "boolean"+ },+ {+ "type": "null"+ }+ ],+ "title": "Confirmation Mode"},"llm_model": {- "type": "string"+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Llm Model"},"llm_api_key": {- "type": "string"+ "anyOf": [+ {+ "type": "string",+ "format": "password",+ "writeOnly": true+ },+ {+ "type": "null"+ }+ ],+ "title": "Llm Api Key"},"llm_base_url": {- "type": "string",- "nullable": true+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Llm Base Url"},"remote_runtime_resource_factor": {- "type": "number"+ "anyOf": [+ {+ "type": "integer"+ },+ {+ "type": "null"+ }+ ],+ "title": "Remote Runtime Resource Factor"+ },+ "secrets_store": {+ "$ref": "#/components/schemas/UserSecrets-Input"},"enable_default_condenser": {- "type": "boolean"+ "type": "boolean",+ "title": "Enable Default Condenser",+ "default": true},"enable_sound_notifications": {- "type": "boolean"+ "type": "boolean",+ "title": "Enable Sound Notifications",+ "default": false+ },+ "enable_proactive_conversation_starters": {+ "type": "boolean",+ "title": "Enable Proactive Conversation Starters",+ "default": true+ },+ "enable_solvability_analysis": {+ "type": "boolean",+ "title": "Enable Solvability Analysis",+ "default": true},"user_consents_to_analytics": {- "type": "boolean"+ "anyOf": [+ {+ "type": "boolean"+ },+ {+ "type": "null"+ }+ ],+ "title": "User Consents To Analytics"+ },+ "sandbox_base_container_image": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Sandbox Base Container Image"+ },+ "sandbox_runtime_container_image": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Sandbox Runtime Container Image"+ },+ "mcp_config": {+ "anyOf": [+ {+ "$ref": "#/components/schemas/MCPConfig"+ },+ {+ "type": "null"+ }+ ]+ },+ "search_api_key": {+ "anyOf": [+ {+ "type": "string",+ "format": "password",+ "writeOnly": true+ },+ {+ "type": "null"+ }+ ],+ "title": "Search Api Key"+ },+ "sandbox_api_key": {+ "anyOf": [+ {+ "type": "string",+ "format": "password",+ "writeOnly": true+ },+ {+ "type": "null"+ }+ ],+ "title": "Sandbox Api Key"+ },+ "max_budget_per_task": {+ "anyOf": [+ {+ "type": "number"+ },+ {+ "type": "null"+ }+ ],+ "title": "Max Budget Per Task"+ },+ "email": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Email"+ },+ "email_verified": {+ "anyOf": [+ {+ "type": "boolean"+ },+ {+ "type": "null"+ }+ ],+ "title": "Email Verified"+ },+ "git_user_name": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Git User Name"+ },+ "git_user_email": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Git User Email"}- }- },- "GETSettingsModel": {+ },"type": "object",+ "title": "Settings",+ "description": "Persisted settings for OpenHands sessions"+ },+ "SuggestedTask": {"properties": {- "language": {- "type": "string"- },- "agent": {- "type": "string"- },- "security_analyzer": {- "type": "string"- },- "confirmation_mode": {- "type": "boolean"- },- "llm_model": {- "type": "string"+ "git_provider": {+ "$ref": "#/components/schemas/ProviderType"},- "llm_api_key_set": {- "type": "boolean"+ "task_type": {+ "$ref": "#/components/schemas/TaskType"},- "llm_base_url": {+ "repo": {"type": "string",- "nullable": true- },- "remote_runtime_resource_factor": {- "type": "number"- },- "enable_default_condenser": {- "type": "boolean"- },- "enable_sound_notifications": {- "type": "boolean"+ "title": "Repo"},- "user_consents_to_analytics": {- "type": "boolean"+ "issue_number": {+ "type": "integer",+ "title": "Issue Number"},- "provider_tokens_set": {- "type": "object",- "additionalProperties": {- "type": "boolean"- }+ "title": {+ "type": "string",+ "title": "Title"}- }+ },+ "type": "object",+ "required": [+ "git_provider",+ "task_type",+ "repo",+ "issue_number",+ "title"+ ],+ "title": "SuggestedTask"+ },+ "TaskType": {+ "type": "string",+ "enum": [+ "MERGE_CONFLICTS",+ "FAILING_CHECKS",+ "UNRESOLVED_COMMENTS",+ "OPEN_ISSUE",+ "OPEN_PR",+ "CREATE_MICROAGENT"+ ],+ "title": "TaskType"},- "POSTSettingsModel": {+ "UpdateConversationRequest": {+ "properties": {+ "title": {+ "type": "string",+ "maxLength": 200,+ "minLength": 1,+ "title": "Title",+ "description": "New conversation title"+ }+ },+ "additionalProperties": false,"type": "object",+ "required": [+ "title"+ ],+ "title": "UpdateConversationRequest",+ "description": "Request model for updating conversation metadata."+ },+ "User": {"properties": {- "language": {- "type": "string"- },- "agent": {- "type": "string"- },- "security_analyzer": {- "type": "string"- },- "confirmation_mode": {- "type": "boolean"- },- "llm_model": {- "type": "string"- },- "llm_api_key": {- "type": "string"+ "id": {+ "type": "string",+ "title": "Id"},- "llm_base_url": {+ "login": {"type": "string",- "nullable": true+ "title": "Login"},- "remote_runtime_resource_factor": {- "type": "number"+ "avatar_url": {+ "type": "string",+ "title": "Avatar Url"},- "enable_default_condenser": {- "type": "boolean"+ "company": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Company"},- "enable_sound_notifications": {- "type": "boolean"+ "name": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Name"},- "user_consents_to_analytics": {- "type": "boolean"+ "email": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "null"+ }+ ],+ "title": "Email"+ }+ },+ "type": "object",+ "required": [+ "id",+ "login",+ "avatar_url"+ ],+ "title": "User"+ },+ "UserSecrets-Input": {+ "properties": {+ "provider_tokens": {+ "additionalProperties": {+ "type": "string"+ },+ "type": "object",+ "title": "Provider Tokens"},+ "custom_secrets": {+ "additionalProperties": {+ "type": "string"+ },+ "type": "object",+ "title": "Custom Secrets"+ }+ },+ "type": "object",+ "title": "UserSecrets"+ },+ "UserSecrets-Output": {+ "properties": {"provider_tokens": {+ "additionalProperties": {+ "additionalProperties": {+ "anyOf": [+ {+ "type": "string"+ },+ {}+ ]+ },+ "type": "object"+ },"type": "object",+ "title": "Provider Tokens"+ },+ "custom_secrets": {"additionalProperties": {"type": "string"- }+ },+ "type": "object",+ "title": "Custom Secrets"}- }+ },+ "type": "object",+ "title": "UserSecrets"+ },+ "ValidationError": {+ "properties": {+ "loc": {+ "items": {+ "anyOf": [+ {+ "type": "string"+ },+ {+ "type": "integer"+ }+ ]+ },+ "type": "array",+ "title": "Location"+ },+ "msg": {+ "type": "string",+ "title": "Message"+ },+ "type": {+ "type": "string",+ "title": "Error Type"+ }+ },+ "type": "object",+ "required": [+ "loc",+ "msg",+ "type"+ ],+ "title": "ValidationError"}},"securitySchemes": {- "bearerAuth": {- "type": "http",- "scheme": "bearer",- "bearerFormat": "JWT"+ "APIKeyHeader": {+ "type": "apiKey",+ "in": "header",+ "name": "X-Session-API-Key"}}},- "security": [+ "servers": [+ {+ "url": "https://app.all-hands.dev",+ "description": "Production server"+ },{- "bearerAuth": []+ "url": "http://localhost:3000",+ "description": "Local development server"}]-}+}\ No newline at end of filediff --git a/scripts/update_openapi.py b/scripts/update_openapi.pynew file mode 100755index 0000000000..0336924f11--- /dev/null+++ b/scripts/update_openapi.py@@ -0,0 +1,226 @@+#!/usr/bin/env python3+"""+Update OpenHands OpenAPI documentation.++Generates the OpenAPI specification from the FastAPI application and writes it+to docs/openapi.json.++Usage:+ python scripts/update_openapi.py++Behavior:+- Uses openhands.server.app.app.openapi() to build the spec.+- Preserves existing "servers" from docs/openapi.json if present; otherwise+ writes sensible defaults.+- Sets info.version to openhands.__version__.+- Sanitizes endpoint descriptions to remove code blocks and internal-only sections.+- Excludes operational/UI-only convenience endpoints:+ - /server_info+ - /api/conversations/{conversation_id}/vscode-url+ - /api/conversations/{conversation_id}/web-hosts+- Creates a backup docs/openapi.json.backup before overwriting.++Output:+- Prints OpenAPI and API versions, endpoint count, servers count, and sample endpoints.+"""++import json+import logging+import os+import sys+import warnings+from pathlib import Path++# Suppress warnings and logs during import+logging.getLogger().setLevel(logging.CRITICAL)+warnings.filterwarnings('ignore')+os.environ['OPENHANDS_LOG_LEVEL'] = 'CRITICAL'++# Add the project root to the Python path+project_root = Path(__file__).parent.parent+sys.path.insert(0, str(project_root))++try:+ from openhands import __version__+ from openhands.server.app import app+except ImportError as e:+ print(f'Error importing OpenHands modules: {e}')+ print(+ "Make sure you're running this script from the project root and dependencies are installed."+ )+ sys.exit(1)+++def _sanitize_description(text: str) -> str:+ """Remove internal, code-centric, or redundant sections from endpoint descriptions.++ - Strip fenced code blocks+ - Remove Args/Returns/Raises/Example/Examples/Notes sections+ - Remove inline curl examples+ - Avoid provider-implementation specifics like LiteLLM/Bedrock+ """+ import re++ if not text:+ return text++ # Remove fenced code blocks+ text = re.sub(r'```[\s\S]*?```', '', text, flags=re.MULTILINE)++ # Remove common docstring sections (until next blank line or end)+ for header in [+ r'Args?:',+ r'Returns?:',+ r'Raises?:',+ r'Example[s]?:',+ r'Notes?:',+ ]:+ text = re.sub(rf'(?ms)^\s*{header}.*?(?:\n\s*\n|\Z)', '', text)++ # Remove lines that contain curl examples+ text = re.sub(r'(?im)^.*\bcurl\b.*$', '', text)++ # Generalize provider-implementation specifics+ text = re.sub(r'\bLiteLLM\b', 'configured model providers', text)+ text = re.sub(r'\blitellm\b', 'configured providers', text)+ text = re.sub(r'\bBedrock\b', '', text)++ # Collapse excessive blank lines and trim+ text = re.sub(r'\n{3,}', '\n\n', text).strip()+ return text+++def _sanitize_spec(spec: dict) -> dict:+ """Sanitize descriptions and summaries to be public-API friendly."""+ path_summary_overrides = {+ '/api/options/models': 'List Supported Models',+ '/api/options/agents': 'List Agents',+ '/api/options/security-analyzers': 'List Security Analyzers',+ '/api/conversations/{conversation_id}/list-files': 'List Workspace Files',+ '/api/conversations/{conversation_id}/select-file': 'Get File Content',+ '/api/conversations/{conversation_id}/zip-directory': 'Download Workspace Archive',+ }+ path_description_overrides = {+ '/api/options/models': 'List model identifiers available on this server based on configured providers.',+ '/api/options/agents': 'List available agent types supported by this server.',+ '/api/options/security-analyzers': 'List supported security analyzers.',+ '/api/conversations/{conversation_id}/list-files': 'List workspace files visible to the conversation runtime. Applies .gitignore and internal ignore rules.',+ '/api/conversations/{conversation_id}/select-file': 'Return the content of the given file from the conversation workspace.',+ '/api/conversations/{conversation_id}/zip-directory': 'Return a ZIP archive of the current conversation workspace.',+ }++ for path, methods in list(spec.get('paths', {}).items()):+ for method, meta in list(methods.items()):+ if not isinstance(meta, dict):+ continue+ # Override overly specific summaries where helpful+ if path in path_summary_overrides:+ meta['summary'] = path_summary_overrides[path]+ # Override description if provided; otherwise sanitize+ if path in path_description_overrides:+ meta['description'] = path_description_overrides[path]+ elif 'description' in meta and isinstance(meta['description'], str):+ meta['description'] = _sanitize_description(meta['description'])++ return spec+++def generate_openapi_spec():+ """Generate the OpenAPI specification from the FastAPI app."""+ spec = app.openapi()++ # Explicitly exclude certain endpoints that are operational, experimental, or UI-only convenience+ excluded_endpoints = [+ '/api/conversations/{conversation_id}/exp-config', # Internal experimentation endpoint+ '/server_info', # Operational/system diagnostics+ '/api/conversations/{conversation_id}/vscode-url', # UI/runtime convenience+ '/api/conversations/{conversation_id}/web-hosts', # UI/runtime convenience+ ]++ if 'paths' in spec:+ for endpoint in excluded_endpoints:+ if endpoint in spec['paths']:+ del spec['paths'][endpoint]+ print(f'Excluded endpoint: {endpoint}')++ # Sanitize descriptions and summaries+ spec = _sanitize_spec(spec)++ return spec+++def load_current_spec(spec_path):+ """Load the current OpenAPI specification if it exists."""+ if spec_path.exists():+ with open(spec_path, 'r') as f:+ return json.load(f)+ return {}+++def update_openapi_spec(spec_path, backup=True):+ """Update the OpenAPI specification file."""+ # Generate new spec+ new_spec = generate_openapi_spec()++ # Load current spec for server information+ current_spec = load_current_spec(spec_path)++ # Preserve server information from current spec if it exists+ if 'servers' in current_spec:+ new_spec['servers'] = current_spec['servers']+ else:+ # Default servers if none exist+ new_spec['servers'] = [+ {'url': 'https://app.all-hands.dev', 'description': 'Production server'},+ {'url': 'http://localhost:3000', 'description': 'Local server'},+ ]++ # Update version to match the package version+ new_spec['info']['version'] = __version__++ # Backup current file if requested+ if backup and spec_path.exists():+ backup_path = spec_path.with_suffix('.json.backup')+ spec_path.rename(backup_path)+ print(f'Backed up current spec to {backup_path}')++ # Write new spec+ with open(spec_path, 'w') as f:+ json.dump(new_spec, f, indent=2)++ return new_spec+++def main():+ """Main function."""+ spec_path = project_root / 'docs' / 'openapi.json'++ print('Updating OpenAPI specification...')+ print(f'Target file: {spec_path}')++ try:+ new_spec = update_openapi_spec(spec_path)++ print('β Successfully updated OpenAPI specification!')+ print(f' OpenAPI version: {new_spec.get("openapi", "N/A")}')+ print(f' API version: {new_spec.get("info", {}).get("version", "N/A")}')+ print(f' Total endpoints: {len(new_spec.get("paths", {}))}')+ print(f' Servers: {len(new_spec.get("servers", []))}')++ # List some key endpoints+ paths = list(new_spec.get('paths', {}).keys())+ if paths:+ print(' Sample endpoints:')+ for path in sorted(paths)[:5]:+ methods = list(new_spec['paths'][path].keys())+ print(f' {path}: {methods}')+ if len(paths) > 5:+ print(f' ... and {len(paths) - 5} more')++ except Exception as e:+ print(f'β Error updating OpenAPI specification: {e}')+ sys.exit(1)+++if __name__ == '__main__':+ main()