Gitpod gitpod.v1.AgentService API
The gitpod.v1.AgentService API from Gitpod — 25 operation(s) for gitpod.v1.agentservice.
Gitpod gitpod.v1.AgentService API is one of 34 APIs that Gitpod publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 25 operations across 25 paths, and defines 153 schemas. It is described by OpenAPI 3.0.0, at version v1.0.0.
Requests are made against a single base URL, https://api.gitpod.io.
25 operations
25 paths
153 schemas
25 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Gitpod gitpod.v1.AgentService API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
Paths & Operations 25
Across 25 paths, the API surfaces 25 operations — 25 POST. Each is listed below with its method, path, parameters, and response codes.
gitpod.v1.AgentService 25
POST
/gitpod.v1.AgentService/CreateAgent
CreateAgent
POST
/gitpod.v1.AgentService/CreateAgentExecutionConversationToken
CreateAgentExecutionConversationToken
POST
/gitpod.v1.AgentService/CreateLLMAccessToken
CreateLLMAccessToken
POST
/gitpod.v1.AgentService/CreateMCPAccessToken
CreateMCPAccessToken
POST
/gitpod.v1.AgentService/CreatePrompt
CreatePrompt
POST
/gitpod.v1.AgentService/CreateSearchAccessToken
CreateSearchAccessToken
POST
/gitpod.v1.AgentService/DeleteAgent
DeleteAgent
POST
/gitpod.v1.AgentService/DeleteAgentExecution
DeleteAgentExecution
POST
/gitpod.v1.AgentService/DeletePrompt
DeletePrompt
POST
/gitpod.v1.AgentService/EmitAgentSessionActivity
EmitAgentSessionActivity
POST
/gitpod.v1.AgentService/GetAgent
GetAgent
POST
/gitpod.v1.AgentService/GetAgentExecution
GetAgentExecution
POST
/gitpod.v1.AgentService/GetPrompt
GetPrompt
POST
/gitpod.v1.AgentService/ImprovePromptForAgent
ImprovePromptForAgent
POST
/gitpod.v1.AgentService/ListAgentExecutions
ListAgentExecutions
POST
/gitpod.v1.AgentService/ListAgents
ListAgents
POST
/gitpod.v1.AgentService/ListMCPIntegrations
ListMCPIntegrations
POST
/gitpod.v1.AgentService/ListPrompts
ListPrompts
POST
/gitpod.v1.AgentService/ReportAgentExecutionOutputs
ReportAgentExecutionOutputs
POST
/gitpod.v1.AgentService/SendToAgentExecution
SendToAgentExecution
POST
/gitpod.v1.AgentService/StartAgent
StartAgent
POST
/gitpod.v1.AgentService/StopAgentExecution
StopAgentExecution
POST
/gitpod.v1.AgentService/UpdateAgent
UpdateAgent
POST
/gitpod.v1.AgentService/UpdateAgentExecution
UpdateAgentExecution
POST
/gitpod.v1.AgentService/UpdatePrompt
UpdatePrompt
Schemas 153
The contract defines 153 schemas that model the data the API accepts and returns. The most detailed are gitpod.v1.AgentExecution.Status (26 properties), gitpod.v1.AgentResponseBlock (21 properties), gitpod.v1.PullRequest (9 properties), gitpod.v1.AgentExecution.Metadata (9 properties). Each schema is shown below with its type and property counts.
gitpod.v1.ListMCPIntegrationsRequest
object
1 property
gitpod.v1.WakeEvent.EnvironmentPhaseReached
object
3 properties
gitpod.v1.RunsOn
object
3 properties
gitpod.v1.UpdatePromptRequest.Spec
object
5 properties
gitpod.v1.CreateLLMAccessTokenRequest
object
2 properties
gitpod.v1.AgentResponseBlock.TextOutput.Type
string
gitpod.v1.AgentResponseBlock.TextOutput
object
3 properties
gitpod.v1.UpdateAgentRequest.Metadata
object
2 properties
gitpod.v1.Subject
object
2 properties
gitpod.v1.GetAgentRequest
object
1 property
gitpod.v1.DeleteAgentExecutionResponse
object
gitpod.v1.ListAgentExecutionsResponse
object
2 properties
gitpod.v1.UpdateAgentExecutionResponse
object
1 property
gitpod.v1.WakeEvent.LoopRetrigger
object
2 properties
gitpod.v1.EmitAgentSessionActivityResponse
object
gitpod.v1.GetAgentResponse
object
1 property
gitpod.v1.PromptMetadata
object
6 properties
gitpod.v1.AgentCodeContext.ContextURL
object
2 properties
gitpod.v1.EnvironmentVariableItem
object
EnvironmentVariableItem represents an environment variable that can be set either from a literal value or from a secret reference.
3 properties
gitpod.v1.StopAgentExecutionResponse
object
gitpod.v1.AgentExecution.Status.EnvironmentUsage
object
2 properties
gitpod.v1.ReportAgentExecutionOutputsRequest
object
2 properties
gitpod.v1.WakeEvent
object
WakeEvent is sent by the backend to wake an agent when a registered interest fires. Delivered via SendToAgentExecution as a new oneof variant.
4 properties
gitpod.v1.InEnvironmentAgentSpec
object
2 properties
gitpod.v1.PullRequest.Repository
object
Repository information
4 properties
gitpod.v1.ServicePhase
string
gitpod.v1.AgentCodeContext
object
4 properties
gitpod.v1.WakeEvent.TimerFired
object
1 property
gitpod.v1.StopAgentExecutionRequest
object
1 property
gitpod.v1.UpdateAgentExecutionRequest.Metadata
object
1 property
gitpod.v1.SupportedModel
string
gitpod.v1.MCPIntegrationPhase
string
MCPIntegrationPhase represents the status of an MCP integration connection
gitpod.v1.AgentExecution.WaitingInfo.UserMessageInterest
object
gitpod.v1.AgentResponseBlock.ActionCompleted
object
3 properties
gitpod.v1.AgentExecution.WaitingInfo
object
WaitingInfo describes what an agent is waiting for when in PHASEWAITINGFORINPUT.
3 properties
gitpod.v1.RunsOn.Machine
object
Machine runs the service/task directly on the VM/machine level.
gitpod.v1.UpdatePromptRequest.Metadata
object
2 properties
gitpod.v1.Principal
string
gitpod.v1.AgentExecution.Status
object
26 properties
gitpod.v1.PullRequest.State
string
Current state of the pull request
gitpod.v1.DeleteAgentRequest
object
1 property
gitpod.v1.UserInputBlock.TextInput
object
1 property
gitpod.v1.CreateAgentRequest
object
4 properties
gitpod.v1.GetAgentExecutionResponse
object
1 property
gitpod.v1.CreateSearchAccessTokenResponse
object
1 property
gitpod.v1.AgentExecution.Spec.LoopCondition
object
3 properties
gitpod.v1.AgentResponseBlock.Thought
object
1 property
gitpod.v1.AgentExecution.Status.CurrentOperation
object
4 properties
connect.error
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/http-representation
2 properties
gitpod.v1.UpdateAgentExecutionRequest
object
3 properties
gitpod.v1.AgentExecution.Status.ToolUse
object
2 properties
gitpod.v1.AgentResponseBlock
object
21 properties
gitpod.v1.AgentExecution.WaitingInfo.Interest
object
5 properties
gitpod.v1.CreateLLMAccessTokenResponse
object
2 properties
gitpod.v1.AgentResponseBlock.ActionStarted
object
2 properties
gitpod.v1.MCPIntegration
object
3 properties
gitpod.v1.ListAgentsRequest
object
1 property
gitpod.v1.AgentResponseBlock.AvailableCommands
object
1 property
gitpod.v1.AgentResponseBlock.AgentModeChange.State
string
gitpod.v1.CreateAgentExecutionConversationTokenRequest
object
1 property
gitpod.v1.DeleteAgentResponse
object
gitpod.v1.EnvironmentVariableSource
object
EnvironmentVariableSource specifies a source for an environment variable value.
1 property
gitpod.v1.StartAgentResponse
object
1 property
gitpod.v1.AgentMetadata
object
2 properties
gitpod.v1.SendToAgentExecutionRequest
object
4 properties
gitpod.v1.UpdateAgentExecutionRequest.Spec
object
1 property
gitpod.v1.AgentResponseBlock.HostAuthenticationRequired
object
3 properties
gitpod.v1.AgentExecutionFailureReason
string
AgentExecutionFailureReason represents the reason why an agent execution failed
gitpod.v1.AgentResponseBlock.TodoItem
object
3 properties
gitpod.v1.ClarifyingQuestions.Choice
object
3 properties
gitpod.v1.RunnerSideAgentSpec
object
3 properties
gitpod.v1.DeletePromptRequest
object
1 property
gitpod.v1.AgentExecution.WaitingInfo.TimerInterest
object
3 properties
gitpod.v1.AgentExecution.Status.OutputValue
object
4 properties
gitpod.v1.ListAgentExecutionsRequest.Filter
object
8 properties
gitpod.v1.ImprovePromptForAgentResponse
object
1 property
gitpod.v1.AgentMessage.Role
string
Role identifies the sender's relationship in the parent/child hierarchy.
gitpod.v1.ReportAgentExecutionOutputsResponse
object
1 property
gitpod.v1.UpdateAgentResponse
object
1 property
gitpod.v1.AgentResponseBlock.TodoItem.Phase
string
gitpod.v1.AgentExecution.Status.LLM
object
1 property
gitpod.v1.Agent
object
5 properties
gitpod.v1.AgentResponseBlock.AgentModeChange
object
AgentModeChange signals a mode transition in autonomous agent modes (e.g., Ralph mode). This provides structured signaling instead of parsing magic tokens from…
2 properties
gitpod.v1.NextStepsProposal
object
1 property
gitpod.v1.AgentExecution.Status.LoopConditionResult
object
4 properties
gitpod.v1.UpdatePromptRequest
object
3 properties
gitpod.v1.GetPromptResponse
object
1 property
gitpod.v1.EmitAgentSessionActivityRequest
object
5 properties
gitpod.v1.UserInputBlock
object
5 properties
gitpod.v1.CreateMCPAccessTokenRequest
object
1 property
gitpod.v1.CreateAgentExecutionConversationTokenResponse
object
1 property
gitpod.v1.GetAgentExecutionRequest
object
1 property
gitpod.v1.CreatePromptRequest
object
7 properties
gitpod.v1.UpdateAgentRequest
object
3 properties
gitpod.v1.RunsOn.Terminal
object
Terminal runs the service inside a managed PTY terminal in the devcontainer. Users can attach to the terminal interactively via the terminal API.
gitpod.v1.WakeEvent.LoopRetrigger.UnmetCondition
object
6 properties
gitpod.v1.AgentMessage
object
AgentMessage is a message sent between agents (e.g. from a parent agent to a child agent execution, or vice versa).
4 properties
gitpod.v1.AgentMessage.Type
string
gitpod.v1.AgentResponseBlock.CodeAnnotation
object
5 properties
gitpod.v1.ServiceSpec.Commands
object
3 properties
gitpod.v1.ListAgentsResponse
object
2 properties
gitpod.v1.AgentResponseBlock.FileModification.DiffGroup.Type
string
gitpod.v1.CreatePromptResponse
object
1 property
gitpod.v1.AgentResponseBlock.FileModification.Diff
object
Diff provides a structured diff format optimized for dashboard consumption. This format allows the dashboard to render diffs efficiently without parsing the le…
2 properties
gitpod.v1.AgentResponseBlock.FileModification.DiffStats
object
Statistics about the changes in the diff
2 properties
gitpod.v1.ListPromptsRequest.Filter
object
7 properties
gitpod.v1.AgentExecution.WaitingInfo.EnvironmentInterest
object
2 properties
gitpod.v1.AgentExecution.Spec.Limits
object
3 properties
gitpod.v1.GetPromptRequest
object
1 property
gitpod.v1.SendToAgentExecutionResponse
object
gitpod.v1.CreateAgentResponse
object
1 property
1 required
gitpod.v1.NextStepsProposal.Action
object
3 properties
gitpod.v1.AgentResponseBlock.FileModification.DiffGroup
object
DiffGroup represents a contiguous block of lines with the same change type
2 properties
gitpod.v1.AgentExecution.Metadata
object
9 properties
gitpod.v1.SecretRef
object
SecretRef references a secret by its ID.
1 property
gitpod.v1.AgentResponseBlock.FileModification
object
5 properties
gitpod.v1.ClarifyingQuestions.Question
object
4 properties
gitpod.v1.AgentExecution.Status.MCPIntegrationStatus
object
MCPIntegrationStatus represents the status of a single MCP integration within an agent execution context
5 properties
gitpod.v1.CreateSearchAccessTokenRequest
object
1 property
gitpod.v1.AgentMode
string
AgentMode defines the operational mode of an agent
gitpod.v1.AgentResponseBlock.TodoGroup
object
3 properties
gitpod.v1.Prompt
object
3 properties
gitpod.v1.AgentResponseBlock.AvailableCommand
object
2 properties
gitpod.v1.AgentExecution
object
4 properties
gitpod.v1.UpdateAgentRequest.Spec
object
2 properties
gitpod.v1.PromptSpec
object
5 properties
gitpod.v1.AgentExecution.WaitingInfo.SubAgentInterest
object
1 property
gitpod.v1.StartAgentRequest
object
8 properties
gitpod.v1.AgentExecution.Phase
string
gitpod.v1.ImprovePromptForAgentRequest
object
2 properties
gitpod.v1.UserInputBlock.Input
object
2 properties
gitpod.v1.ClarifyingQuestions
object
1 property
gitpod.v1.AgentExecution.Spec
object
7 properties
gitpod.v1.PaginationRequest
object
2 properties
gitpod.v1.AgentResponseBlock.EnvironmentCreation
object
2 properties
gitpod.v1.ListMCPIntegrationsResponse
object
2 properties
gitpod.v1.ListPromptsRequest
object
2 properties
gitpod.v1.UserInputBlock.ImageInput
object
ImageInput allows sending images to the agent. Client must provide the MIME type; backend validates against magic bytes.
3 properties
gitpod.v1.RunsOn.Docker
object
2 properties
gitpod.v1.AgentExecutionRole
string
AgentExecutionRole represents the role of an agent execution
gitpod.v1.AgentResponseBlock.Phase
string
gitpod.v1.PaginationResponse
object
1 property
gitpod.v1.PullRequest
object
PullRequest represents pull request metadata from source control systems. This message is used across workflow triggers, executions, and agent contexts to main…
9 properties
google.protobuf.Timestamp
string
A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond res…
gitpod.v1.ServiceSpec
object
6 properties
gitpod.v1.RunnerSideAgentSpec.Prompts
object
5 properties
gitpod.v1.DeletePromptResponse
object
gitpod.v1.ListAgentExecutionsRequest
object
2 properties
gitpod.v1.DeleteAgentExecutionRequest
object
1 property
gitpod.v1.ListPromptsResponse
object
2 properties
gitpod.v1.AgentResponseBlock.UserInputBlockSeen
object
1 property
gitpod.v1.UpdatePromptResponse
object
1 property
gitpod.v1.CreateMCPAccessTokenResponse
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Gitpod 12
Other APIs Gitpod publishes across the network.
Gitpod Organizations API
Gitpod Projects API
Gitpod Accounts and Billing API
Gitpod gitpod.v1.AccountService API
Gitpod gitpod.v1.AgentSecurityService API
Gitpod gitpod.v1.BillingService API
Gitpod gitpod.v1.EditorService API
Gitpod gitpod.v1.EnvironmentAutomationService API
Gitpod gitpod.v1.EnvironmentService API
Gitpod gitpod.v1.ErrorsService API
Gitpod gitpod.v1.EventService API
Gitpod gitpod.v1.GatewayService API
Where this information came from
This is an independent, third-party profile of Gitpod gitpod.v1.AgentService API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.