Gitpod gitpod.v1.AgentService API
The gitpod.v1.AgentService API from Gitpod — 25 operation(s) for gitpod.v1.agentservice.
OpenAPI Specification
openapi: 3.0.0
info:
title: gitpod.v1 gitpod.v1.AccountService gitpod.v1.AgentService API
version: v1.0.0
servers:
- url: https://api.gitpod.io
description: Gitpod API
tags:
- name: gitpod.v1.AgentService
x-displayName: gitpod.v1.AgentService
paths:
/gitpod.v1.AgentService/CreateAgent:
servers: []
post:
description: "Creates a new agent.\n\n Use this method to:\n - Define new agents with custom prompts and tools"
operationId: gitpod.v1.AgentService.CreateAgent
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateAgentRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateAgentResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CreateAgent
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/CreateAgentExecutionConversationToken:
servers: []
post:
description: "Creates a token for conversation access with a specific agent run.\n\n This method generates a temporary token that can be used to securely\n connect to an ongoing agent conversation, for example in a web UI.\n\n ### Examples\n\n - Create a token to join an agent run conversation in a front-end application:\n\n ```yaml\n agentExecutionId: \"6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35\"\n ```"
operationId: gitpod.v1.AgentService.CreateAgentExecutionConversationToken
parameters: []
requestBody:
content:
application/json:
examples:
create_a_token_to_join_an_agent_run_conversation_in_a_front_end_application:
description: 'agentExecutionId: "6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35"
'
value:
agentExecutionId: 6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35
schema:
$ref: '#/components/schemas/gitpod.v1.CreateAgentExecutionConversationTokenRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateAgentExecutionConversationTokenResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CreateAgentExecutionConversationToken
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/CreateLLMAccessToken:
servers: []
post:
description: Creates a token for LLM access with a specific agent run.
operationId: gitpod.v1.AgentService.CreateLLMAccessToken
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateLLMAccessTokenRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateLLMAccessTokenResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CreateLLMAccessToken
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/CreateMCPAccessToken:
servers: []
post:
description: "Creates a token for MCP access.\n\n Use this method to generate an access token for MCP integrations."
operationId: gitpod.v1.AgentService.CreateMCPAccessToken
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateMCPAccessTokenRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateMCPAccessTokenResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CreateMCPAccessToken
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/CreatePrompt:
servers: []
post:
description: "Creates a new prompt.\n\n Use this method to:\n - Define new prompts for templates or commands\n - Set up organization-wide prompt libraries"
operationId: gitpod.v1.AgentService.CreatePrompt
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreatePromptRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreatePromptResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CreatePrompt
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/CreateSearchAccessToken:
servers: []
post:
description: "Creates a token for search access.\n\n Use this method to generate an access token for search proxy integrations."
operationId: gitpod.v1.AgentService.CreateSearchAccessToken
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateSearchAccessTokenRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateSearchAccessTokenResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CreateSearchAccessToken
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/DeleteAgent:
servers: []
post:
description: "Deletes an agent.\n\n Use this method to:\n - Remove custom agents"
operationId: gitpod.v1.AgentService.DeleteAgent
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteAgentRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteAgentResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: DeleteAgent
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/DeleteAgentExecution:
servers: []
post:
description: "Deletes an agent run.\n\n Use this method to:\n - Clean up agent runs that are no longer needed\n\n ### Examples\n\n - Delete an agent run by ID:\n\n ```yaml\n agentExecutionId: \"6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35\"\n ```"
operationId: gitpod.v1.AgentService.DeleteAgentExecution
parameters: []
requestBody:
content:
application/json:
examples:
delete_an_agent_run_by_id:
description: 'agentExecutionId: "6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35"
'
value:
agentExecutionId: 6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteAgentExecutionRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteAgentExecutionResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: DeleteAgentExecution
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/DeletePrompt:
servers: []
post:
description: "Deletes a prompt.\n\n Use this method to:\n - Remove unused prompts"
operationId: gitpod.v1.AgentService.DeletePrompt
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.DeletePromptRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.DeletePromptResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: DeletePrompt
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/EmitAgentSessionActivity:
servers: []
post:
description: "Emits an activity to the external agent session (e.g., Linear) associated\n with this agent execution. The backend resolves the session ID from the\n execution's annotations and uses the org's app token to authenticate."
operationId: gitpod.v1.AgentService.EmitAgentSessionActivity
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.EmitAgentSessionActivityRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.EmitAgentSessionActivityResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: EmitAgentSessionActivity
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/GetAgent:
servers: []
post:
description: "Gets details about a specific agent including description,\n and required models.\n\n Use this method to:\n - Check if an agent is defined correctly\n - Understand which models are required for this agent\n\n ### Examples\n\n - Get agent details:\n\n ```yaml\n agentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n ```"
operationId: gitpod.v1.AgentService.GetAgent
parameters: []
requestBody:
content:
application/json:
examples:
get_agent_details:
description: 'agentId: "07e03a28-65a5-4d98-b532-8ea67b188048"
'
value:
agentId: 07e03a28-65a5-4d98-b532-8ea67b188048
schema:
$ref: '#/components/schemas/gitpod.v1.GetAgentRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetAgentResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetAgent
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/GetAgentExecution:
servers: []
post:
description: "Gets details about a specific agent run, including its metadata, specification,\n and status (phase, error messages, and usage statistics).\n\n Use this method to:\n - Monitor the run's progress\n - Retrieve the agent's conversation URL\n - Check if an agent run is actively producing output\n\n ### Examples\n\n - Get agent run details by ID:\n\n ```yaml\n agentExecutionId: \"6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35\"\n ```"
operationId: gitpod.v1.AgentService.GetAgentExecution
parameters: []
requestBody:
content:
application/json:
examples:
get_agent_run_details_by_id:
description: 'agentExecutionId: "6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35"
'
value:
agentExecutionId: 6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35
schema:
$ref: '#/components/schemas/gitpod.v1.GetAgentExecutionRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetAgentExecutionResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetAgentExecution
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/GetPrompt:
servers: []
post:
description: "Gets details about a specific prompt including name, description,\n and prompt content.\n\n Use this method to:\n - Retrieve prompt details for editing\n - Get prompt content for execution\n\n ### Examples\n\n - Get prompt details:\n\n ```yaml\n promptId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n ```"
operationId: gitpod.v1.AgentService.GetPrompt
parameters: []
requestBody:
content:
application/json:
examples:
get_prompt_details:
description: 'promptId: "07e03a28-65a5-4d98-b532-8ea67b188048"
'
value:
promptId: 07e03a28-65a5-4d98-b532-8ea67b188048
schema:
$ref: '#/components/schemas/gitpod.v1.GetPromptRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetPromptResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetPrompt
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/ImprovePromptForAgent:
servers: []
post:
description: "Improves an agent's prompt.\n\n Use this method to:\n - Enhance the agent's understanding of the user's request\n - Refine the agent's response to be more accurate and relevant"
operationId: gitpod.v1.AgentService.ImprovePromptForAgent
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.ImprovePromptForAgentRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.ImprovePromptForAgentResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: ImprovePromptForAgent
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/ListAgentExecutions:
servers: []
post:
description: "Lists all agent runs matching the specified filter.\n\n Use this method to track multiple agent runs and their associated resources. Results are ordered by their creation time with the newest first.\n\n ### Examples\n\n - List agent runs by agent ID:\n\n ```yaml\n filter:\n agentIds: [\"b8a64cfa-43e2-4b9d-9fb3-07edc63f5971\"]\n pagination:\n pageSize: 10\n ```"
operationId: gitpod.v1.AgentService.ListAgentExecutions
parameters:
- in: query
name: pageSize
schema:
default: 25
maximum: 100
minimum: 0
type: integer
- in: query
name: token
schema:
default: ''
type: string
requestBody:
content:
application/json:
examples:
list_agent_runs_by_agent_id:
description: "filter:\n agentIds: [\"b8a64cfa-43e2-4b9d-9fb3-07edc63f5971\"]\npagination:\n pageSize: 10\n"
value:
filter:
agentIds:
- b8a64cfa-43e2-4b9d-9fb3-07edc63f5971
pagination:
pageSize: 10
schema:
$ref: '#/components/schemas/gitpod.v1.ListAgentExecutionsRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.ListAgentExecutionsResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: ListAgentExecutions
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/ListAgents:
servers: []
post:
description: "Lists all agents matching the specified criteria.\n\n Use this method to find and monitor agents across your organization.\n Results are ordered by their creation time with the newest first.\n\n ### Examples\n\n - List all agents:\n\n Retrieves all agents with pagination.\n\n ```yaml\n pagination:\n pageSize: 10\n ```"
operationId: gitpod.v1.AgentService.ListAgents
parameters:
- in: query
name: pageSize
schema:
default: 25
maximum: 100
minimum: 0
type: integer
- in: query
name: token
schema:
default: ''
type: string
requestBody:
content:
application/json:
examples:
list_all_agents:
description: Retrieves all agents with pagination.
value:
pagination:
pageSize: 10
schema:
$ref: '#/components/schemas/gitpod.v1.ListAgentsRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.ListAgentsResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: ListAgents
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/ListMCPIntegrations:
servers: []
post:
description: "Lists all MCP integrations.\n\n Use this method to retrieve all configured MCP integrations.\n\n ### Examples\n\n - List all MCP integrations:\n\n ```yaml\n pagination:\n pageSize: 10\n ```"
operationId: gitpod.v1.AgentService.ListMCPIntegrations
parameters:
- in: query
name: pageSize
schema:
default: 25
maximum: 100
minimum: 0
type: integer
- in: query
name: token
schema:
default: ''
type: string
requestBody:
content:
application/json:
examples:
list_all_mcp_integrations:
description: "pagination:\n pageSize: 10\n"
value:
pagination:
pageSize: 10
schema:
$ref: '#/components/schemas/gitpod.v1.ListMCPIntegrationsRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.ListMCPIntegrationsResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: ListMCPIntegrations
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/ListPrompts:
servers: []
post:
description: "Lists all prompts matching the specified criteria.\n\n Use this method to find and browse prompts across your organization.\n Results are ordered by their creation time with the newest first.\n\n ### Examples\n\n - List all prompts:\n\n Retrieves all prompts with pagination.\n\n ```yaml\n pagination:\n pageSize: 10\n ```"
operationId: gitpod.v1.AgentService.ListPrompts
parameters:
- in: query
name: pageSize
schema:
default: 25
maximum: 100
minimum: 0
type: integer
- in: query
name: token
schema:
default: ''
type: string
requestBody:
content:
application/json:
examples:
list_all_prompts:
description: Retrieves all prompts with pagination.
value:
pagination:
pageSize: 10
schema:
$ref: '#/components/schemas/gitpod.v1.ListPromptsRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.ListPromptsResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: ListPrompts
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/ReportAgentExecutionOutputs:
servers: []
post:
description: "Reports outputs for an agent execution.\n\n This method allows agents to report key-value outputs during execution.\n Similar to task execution outputs, but with typed values for structured data.\n Outputs are merged with any existing outputs. The API automatically infers\n the type (int, float, bool, or string) from the value.\n\n Use this method to:\n - Record execution outcomes and metrics\n - Track test results, coverage, or success indicators\n - Store any execution-related data as key-value pairs\n\n Type inference rules:\n - \"true\" or \"false\" → bool\n - Valid integer (e.g., \"42\", \"-10\") → int\n - Valid float (e.g., \"85.5\", \"3.14\") → float\n - Everything else → string\n\n Validation limits (matching task execution outputs):\n - Keys: 1-128 characters\n - String values: max 4096 characters\n\n ### Examples\n\n - Report execution outputs (types will be inferred from string_value):\n\n ```yaml\n agentExecutionId: \"6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35\"\n outputs:\n tests_passed:\n stringValue: \"42\" # inferred as int\n coverage:\n stringValue: \"85.5\" # inferred as float\n success:\n stringValue: \"true\" # inferred as bool\n message:\n stringValue: \"All tests passed\" # stored as string\n ```"
operationId: gitpod.v1.AgentService.ReportAgentExecutionOutputs
parameters: []
requestBody:
content:
application/json:
examples:
report_execution_outputs_(types_will_be_inferred_from_string_:
description: "agentExecutionId: \"6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35\"\noutputs:\n tests_passed:\n stringValue: \"42\" # inferred as int\n coverage:\n stringValue: \"85.5\" # inferred as float\n success:\n stringValue: \"true\" # inferred as bool\n message:\n stringValue: \"All tests passed\" # stored as string\n"
value:
agentExecutionId: 6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35
outputs:
coverage:
stringValue: '85.5'
message:
stringValue: All tests passed
success:
stringValue: 'true'
tests_passed:
stringValue: '42'
schema:
$ref: '#/components/schemas/gitpod.v1.ReportAgentExecutionOutputsRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.ReportAgentExecutionOutputsResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: ReportAgentExecutionOutputs
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/SendToAgentExecution:
servers: []
post:
description: "Sends user input to an active agent run.\n\n This method is used to provide interactive or conversation-based input\n to an agent. The agent can respond with output blocks containing\n text, file changes, or tool usage requests.\n\n ### Examples\n\n - Send a text message to an agent:\n\n ```yaml\n agentExecutionId: \"6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35\"\n userInput:\n text:\n content: \"Generate a report based on the latest logs.\"\n ```"
operationId: gitpod.v1.AgentService.SendToAgentExecution
parameters: []
requestBody:
content:
application/json:
examples:
send_a_text_message_to_an_agent:
description: "agentExecutionId: \"6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35\"\nuserInput:\n text:\n content: \"Generate a report based on the latest logs.\"\n"
value:
agentExecutionId: 6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35
userInput:
text:
content: Generate a report based on the latest logs.
schema:
$ref: '#/components/schemas/gitpod.v1.SendToAgentExecutionRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.SendToAgentExecutionResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: SendToAgentExecution
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/StartAgent:
servers: []
post:
description: "Starts (or triggers) an agent run using a provided agent.\n\n Use this method to:\n - Launch an agent based on a known agent\n\n ### Examples\n\n - Start an agent with a project ID:\n\n ```yaml\n agentId: \"b8a64cfa-43e2-4b9d-9fb3-07edc63f5971\"\n codeContext:\n projectId: \"2d22e4eb-31da-467f-882c-27e21550992f\"\n ```"
operationId: gitpod.v1.AgentService.StartAgent
parameters: []
requestBody:
content:
application/json:
examples:
start_an_agent_with_a_project_id:
description: "agentId: \"b8a64cfa-43e2-4b9d-9fb3-07edc63f5971\"\ncodeContext:\n projectId: \"2d22e4eb-31da-467f-882c-27e21550992f\"\n"
value:
agentId: b8a64cfa-43e2-4b9d-9fb3-07edc63f5971
codeContext:
projectId: 2d22e4eb-31da-467f-882c-27e21550992f
schema:
$ref: '#/components/schemas/gitpod.v1.StartAgentRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.StartAgentResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: StartAgent
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/StopAgentExecution:
servers: []
post:
description: "Stops an active agent execution.\n\n Use this method to:\n - Stop an agent that is currently running\n - Prevent further processing or resource usage\n\n ### Examples\n\n - Stop an agent execution by ID:\n\n ```yaml\n agentExecutionId: \"6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35\"\n ```"
operationId: gitpod.v1.AgentService.StopAgentExecution
parameters: []
requestBody:
content:
application/json:
examples:
stop_an_agent_execution_by_id:
description: 'agentExecutionId: "6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35"
'
value:
agentExecutionId: 6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35
schema:
$ref: '#/components/schemas/gitpod.v1.StopAgentExecutionRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.StopAgentExecutionResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: StopAgentExecution
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/UpdateAgent:
servers: []
post:
description: "Updates an existing agent.\n\n Use this method to:\n - Modify agent configuration\n - Update prompts or required tools"
operationId: gitpod.v1.AgentService.UpdateAgent
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.UpdateAgentRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.UpdateAgentResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: UpdateAgent
tags:
- gitpod.v1.AgentService
/gitpod.v1.AgentService/UpdateAgentExecution:
servers: []
post:
description: "Updates an agent execution's spec.\n\n Use this method to:\n - Set or update loop conditions on an agent execution"
operationId: gitpod.v1.AgentService.UpdateAgentExecution
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.UpdateAgentExecutionRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.UpdateAgentExecutionResponse'
description: Success
default:
content:
application/json:
schema:
# --- truncated at 32 KB (138 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gitpod/refs/heads/main/openapi/gitpod-gitpod-v1-agentservice-api-openapi.yml