API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Editors

ListEditors

client.editors.list(EditorListParams { token, pageSize, filter, pagination } params, RequestOptionsoptions?): EditorsPage<Editor { id, installationInstructions, name, 5 more } >

POST/gitpod.v1.EditorService/ListEditors

ResolveEditorURL

client.editors.resolveURL(EditorResolveURLParams { editorId, environmentId, organizationId, version } body, RequestOptionsoptions?): EditorResolveURLResponse { url }

POST/gitpod.v1.EditorService/ResolveEditorURL

GetEditor

client.editors.retrieve(EditorRetrieveParams { id } body, RequestOptionsoptions?): EditorRetrieveResponse { editor }

POST/gitpod.v1.EditorService/GetEditor

ModelsExpand Collapse

Editor { id, installationInstructions, name, 5 more }

id: string

formatuuid

installationInstructions: string

name: string

urlTemplate: string

alias?: string

iconUrl?: string

shortDescription?: string

versions?: Array<EditorVersion { version } >

versions contains the list of available versions for this editor

version: string

version is the version string of the editor Examples for JetBrains: 2025.2

EditorVersion { version }

version: string

version is the version string of the editor Examples for JetBrains: 2025.2

EditorResolveURLResponse { url }

url: string

url is the resolved editor URL

EditorRetrieveResponse { editor }

editor: Editor { id, installationInstructions, name, 5 more }

editor contains the editor

id: string

formatuuid

installationInstructions: string

name: string

urlTemplate: string

alias?: string

iconUrl?: string

shortDescription?: string

versions?: Array<EditorVersion { version } >

versions contains the list of available versions for this editor

version: string

version is the version string of the editor Examples for JetBrains: 2025.2