GitLab Orbit API

openapi: 3.2.0
info:
  title: GitLab REST Orbit API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: Orbit
  description: 'Use this API to query GitLab Orbit,

    which indexes a group''s software development lifecycle.


    > [!note]

    > The availability of these endpoints is controlled by a feature flag, and GitLab Orbit is in beta.'
  x-displayName: Orbit
  externalDocs:
    url: https://docs.gitlab.com/api/orbit/
paths:
  /api/v4/orbit/query:
    post:
      operationId: postApiV4OrbitQuery
      summary: Execute a query
      description: Executes a query against the Orbit gRPC service.
      tags:
      - Orbit
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4OrbitQueryRequest'
      x-gitlab-tier: premium
      x-gitlab-lifecycle: beta
  /api/v4/orbit/query/{name}:
    post:
      operationId: postApiV4OrbitQueryName
      summary: Execute a named query
      description: 'Executes a server-defined named query against the Orbit gRPC service. Requires a JSON request body: form encoding stringifies nested parameter values, which the per-query parameter schemas reject.'
      tags:
      - Orbit
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: name
        required: true
        description: Named query identifier
        schema:
          type: string
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4OrbitQueryNameRequest'
      x-gitlab-tier: premium
      x-gitlab-lifecycle: beta
  /api/v4/orbit/context:
    post:
      operationId: postApiV4OrbitContext
      summary: Get entity context
      description: Resolves one Orbit token to a PostgreSQL summary and, optionally, its graph neighborhood. Requests that reach token resolution count against the orbit_query rate limit; with expand, they run at most one billable graph query. Requires a JSON request body.
      tags:
      - Orbit
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesOrbitContext'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '429':
          description: Too many requests
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4OrbitContextRequest'
      x-gitlab-tier: premium
      x-gitlab-lifecycle: experiment
  /api/v4/orbit/query/templates:
    get:
      operationId: getApiV4OrbitQueryTemplates
      summary: List named query templates
      description: Lists the server-defined named queries with their query DSL rendered for the current user.
      tags:
      - Orbit
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
      x-gitlab-tier: premium
      x-gitlab-lifecycle: beta
  /api/v4/orbit/schema:
    get:
      operationId: getApiV4OrbitSchema
      summary: Retrieve the schema
      description: Retrieves the Orbit schema.
      tags:
      - Orbit
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
      parameters:
      - name: expand
        required: false
        description: Comma-separated node names to expand
        schema:
          type:
          - string
          - 'null'
        in: query
      - name: response_format
        required: false
        description: 'Response format: raw or llm'
        schema:
          type: string
          enum:
          - raw
          - llm
          default: raw
        in: query
      x-gitlab-tier: premium
      x-gitlab-lifecycle: beta
  /api/v4/orbit/status:
    get:
      operationId: getApiV4OrbitStatus
      summary: Retrieve access and cluster health
      description: Returns whether the user can access Orbit, plus cluster health. Always returns 200, regardless of access.
      tags:
      - Orbit
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
      parameters:
      - name: response_format
        required: false
        description: 'Response format: raw or llm'
        schema:
          type: string
          enum:
          - raw
          - llm
          default: raw
        in: query
      x-gitlab-lifecycle: beta
  /api/v4/orbit/skills:
    get:
      operationId: getApiV4OrbitSkills
      summary: List deployed Orbit skills
      description: Lists the Orbit skills deployed with the connected knowledge graph service.
      tags:
      - Orbit
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesOrbitSkillCollection'
        '401':
          description: Unauthorized
        '404':
          description: Skills are not available
      x-gitlab-lifecycle: beta
  /api/v4/orbit/skills/{name}:
    get:
      operationId: getApiV4OrbitSkillsName
      summary: Retrieve a deployed Orbit skill
      description: Retrieves a complete deployed Orbit skill tree. HEAD requests retrieve only skill metadata.
      tags:
      - Orbit
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesOrbitSkill'
        '401':
          description: Unauthorized
        '404':
          description: Skill not found or skills are not available
        '400':
          description: Bad Request
      parameters:
      - name: name
        required: true
        description: Deployed skill name
        schema:
          type: string
          pattern: ^[a-z0-9][a-z0-9\-]*$
        in: path
      x-gitlab-lifecycle: beta
  /api/v4/orbit/skills/{name}/{path}:
    get:
      operationId: getApiV4OrbitSkillsNamePath
      summary: Retrieve a deployed Orbit skill file
      description: Retrieves a UTF-8 file from a deployed Orbit skill as raw text.
      tags:
      - Orbit
      responses:
        '200':
          description: OK
          content:
            text/markdown:
              schema:
                type: string
            text/plain:
              schema:
                type: string
        '401':
          description: Unauthorized
        '404':
          description: Skill file not found or skills are not available
        '400':
          description: Bad Request
      parameters:
      - name: name
        required: true
        description: Deployed skill name
        schema:
          type: string
          pattern: ^[a-z0-9][a-z0-9\-]*$
        in: path
      - name: path
        required: true
        description: File path relative to the skill root
        schema:
          type: string
          pattern: ^[^\/]+(?:\/[^\/]+)*$
        in: path
        example: references/usage.md
      x-gitlab-lifecycle: beta
  /api/v4/orbit/tools:
    get:
      operationId: getApiV4OrbitTools
      summary: List all tools
      description: Lists all available Orbit operations.
      tags:
      - Orbit
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
      x-gitlab-tier: premium
      x-gitlab-lifecycle: beta
components:
  schemas:
    APIEntitiesOrbitSkill:
      type: object
      properties:
        name:
          type: string
          example: orbit
        version:
          type: string
          example: 0.29.0
        compatibility:
          type: string
          example: Orbit CLI
        server_version:
          type: string
          example: 0.31.0
        files:
          type: array
          items:
            $ref: '#/components/schemas/APIEntitiesOrbitSkillFile'
    postApiV4OrbitContextRequest:
      type: object
      properties:
        tokens:
          type:
          - array
          - 'null'
          items:
            type: string
          description: 'Exactly one token: Type[id], a GID, an instance URL, path!iid, path#iid, or path&iid (epic)'
        expand:
          oneOf:
          - type: boolean
            default: false
          description: Attach the graph neighborhood of the entity
        response_format:
          type: string
          enum:
          - raw
          - llm
          description: 'Response format: raw or llm'
          default: raw
      required:
      - tokens
    APIEntitiesOrbitSkillSummary:
      type: object
      properties:
        name:
          type: string
          example: orbit
        version:
          type: string
          example: 0.29.0
        compatibility:
          type: string
          example: Orbit CLI
        description:
          type: string
          example: Use the glab orbit CLI.
    APIEntitiesOrbitSkillCollection:
      type: object
      properties:
        skills:
          type: array
          items:
            $ref: '#/components/schemas/APIEntitiesOrbitSkillSummary'
        server_version:
          type: string
          example: 0.31.0
    APIEntitiesOrbitContextEntity:
      type: object
      properties:
        token:
          type: string
          example: MergeRequest[123]
        resolved_token:
          type: string
          example: MergeRequest[123]
        type:
          type: string
          example: MergeRequest
        id:
          type: string
          example: '123'
        found:
          type: boolean
        summary:
          type: object
        error:
          type: object
        expansion:
          type: object
    postApiV4OrbitQueryRequest:
      type: object
      properties:
        query:
          oneOf:
          - type:
            - object
            - 'null'
          - type:
            - string
            - 'null'
          description: JSON query object, or GQL text when enabled for the current user
        response_format:
          type: string
          enum:
          - raw
          - llm
          - gql
          description: 'Response format: raw, llm, or gql'
          default: raw
        source_type:
          type:
          - string
          - 'null'
          description: Optional frontend source subtype (e.g. code_intelligence)
      required:
      - query
    APIEntitiesOrbitContext:
      type: object
      properties:
        version:
          type: string
          example: 1.1.0
        entities:
          type: array
          items:
            $ref: '#/components/schemas/APIEntitiesOrbitContextEntity'
    APIEntitiesOrbitSkillFile:
      type: object
      properties:
        path:
          type: string
          example: SKILL.md
        sha256:
          type: string
          example: abc123
        content:
          type: string
          example: '# Orbit skill'
    postApiV4OrbitQueryNameRequest:
      type: object
      properties:
        parameters:
          type: object
          description: Named query parameters
          default: {}
        response_format:
          type: string
          enum:
          - raw
          - llm
          - gql
          description: 'Response format: raw, llm, or gql'
          default: raw
        source_type:
          type:
          - string
          - 'null'
          description: Optional frontend source subtype (e.g. code_intelligence)
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header