Gitpod · Controlled Vocabulary
Gitpod API Vocabulary
Core terms and concepts from the Gitpod cloud development environment API
40 Terms
Updated
Gitpod Vocabulary is a controlled vocabulary published by Gitpod on the APIs.io network, defining 40 terms.
Defined terms include Account, AccountMembership, ActionableErrorDetails, AdditionalScopesUpdate, and AdmissionLevel.
A controlled vocabulary pins the words an API’s schemas, parameters and documentation use to one agreed definition each — the shared language a human or an agent needs to read the API the same way its authors do.
Terms
Account
Gitpod Account entity
AccountMembership
Gitpod AccountMembership entity
ActionableErrorDetails
ActionableErrorDetails provides structured error information that can be attached to any Connect RPC error via err.AddDetail(). The frontend uses this to render actionable UI (buttons, links, guidan
AdditionalScopesUpdate
AdditionalScopesUpdate wraps a list of OIDC scopes so that the update request can distinguish "not changing scopes" (field absent) from "clearing all scopes" (field present, empty list).
AdmissionLevel
Admission level describes who can access an environment instance and its ports.
Agent
Gitpod Agent entity
AgentCodeContext
Gitpod AgentCodeContext entity
AgentExecution
Gitpod AgentExecution entity
AgentExecutionFailureReason
AgentExecutionFailureReason represents the reason why an agent execution failed
AgentExecutionRole
AgentExecutionRole represents the role of an agent execution
AgentMessage
AgentMessage is a message sent between agents (e.g. from a parent agent to a child agent execution, or vice versa).
AgentMetadata
Gitpod AgentMetadata entity
AgentMode
AgentMode defines the operational mode of an agent
AgentPolicy
AgentPolicy contains agent-specific policy settings for an organization
AgentTraceModelBreakdown
AgentTraceModelBreakdown contains stats for a single LLM model.
AgentTraceSummary
AgentTraceSummary contains aggregate totals for a date range.
AgentTraceTimeBucket
AgentTraceTimeBucket contains stats for a single time period.
AnnouncementBanner
Gitpod AnnouncementBanner entity
AutoTopupSettings
AutoTopupSettings configures automatic credit top-ups for an organization.
AutomationTrigger
An AutomationTrigger represents a trigger for an automation action. The `manual` field shows a start button in the UI for manually triggering the automation. The `post_machine_start` field indicates
AutomationsFile
WARN: Do not remove any field here, as it will break reading automation yaml files. We error if there are any unknown fields in the yaml (to ensure the yaml is correct), but would break if we removed
AvailableRunnerManager
Gitpod AvailableRunnerManager entity
BPFDebugLevel
BPFDebugLevel controls the verbosity of BPF trace_pipe output (bpf_printk). Applies to all BPF-based agents (veto exec, future agents).
BillingAddress
BillingAddress represents a billing address for an organization
BillingPlanKind
Gitpod BillingPlanKind entity
BillingPlanSpec
Gitpod BillingPlanSpec entity
BillingPlanStatus
Gitpod BillingPlanStatus entity
BillingRealm
Gitpod BillingRealm entity
BillingRecord
Gitpod BillingRecord entity
BillingRecordMetadata
Gitpod BillingRecordMetadata entity
BillingRecordSpec
Gitpod BillingRecordSpec entity
BillingRecordStatus
Gitpod BillingRecordStatus entity
Breadcrumb
Breadcrumb information (Sentry-compatible)
CallCheckAuthenticationForHost
Gitpod CallCheckAuthenticationForHost entity
CallCheckRepositoryAccess
Gitpod CallCheckRepositoryAccess entity
CallImprovePromptForAgent
Gitpod CallImprovePromptForAgent entity
CallListSCMOrganizations
Gitpod CallListSCMOrganizations entity
CallParseContext
Gitpod CallParseContext entity
CallPing
Gitpod CallPing entity
CallSearchRepositories
Gitpod CallSearchRepositories entity