GitLab Code Suggestions API

openapi: 3.2.0
info:
  title: GitLab REST Code Suggestions 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: Code Suggestions
  description: Operations related to Code Suggestions.
paths:
  /api/v4/code_suggestions/completions:
    post:
      operationId: postApiV4CodeSuggestionsCompletions
      summary: Generate code completions
      description: Generates code completions. Uses the AI abstraction layer to generate code completions. Requests to this endpoint are proxied to the AI Gateway.
      tags:
      - Code Suggestions
      responses:
        '200':
          description: OK
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '413':
          description: Payload too large
        '422':
          description: Unprocessable entity
        '429':
          description: Too many requests
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4CodeSuggestionsCompletionsRequest'
  /api/v4/code_suggestions/direct_access:
    post:
      operationId: postApiV4CodeSuggestionsDirectAccess
      summary: Retrieve direct connection details for the AI Gateway
      description: Retrieves user-specific connection details which can be used by IDEs or clients to send `completion` requests to Code Suggestions directly through the AI Gateway.
      tags:
      - Code Suggestions
      responses:
        '201':
          description: Created
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '429':
          description: Too many requests
        '400':
          description: Bad Request
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4CodeSuggestionsDirectAccessRequest'
  /api/v4/code_suggestions/enabled:
    post:
      operationId: postApiV4CodeSuggestionsEnabled
      summary: Validate status of Code Suggestions
      description: Validates the status Code Suggestions for a specified project. This checks if the project has `code_suggestions` enabled or if an ancestor group has the Code Suggestions add-on enabled.
      tags:
      - Code Suggestions
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: 403 Code Suggestions Disabled
        '404':
          description: Not found
        '400':
          description: Bad Request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4CodeSuggestionsEnabledRequest'
  /api/v4/code_suggestions/connection_details:
    post:
      operationId: postApiV4CodeSuggestionsConnectionDetails
      summary: Retrieve connection details
      description: Retrieves user-specific connection details which can be used by IDEs or clients for telemetry, including an instance-specific application ID, application access token, and clickhouse data plane URL.
      tags:
      - Code Suggestions
      responses:
        '201':
          description: Created
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '429':
          description: Too many requests
        '400':
          description: Bad Request
components:
  schemas:
    postApiV4CodeSuggestionsCompletionsRequest:
      type: object
      properties:
        current_file:
          type:
          - object
          - 'null'
          description: Attributes of the file that suggestions are generated for.
          properties:
            file_name:
              type:
              - string
              - 'null'
              description: Name of the current file.
              maxLength: 255
            content_above_cursor:
              type:
              - string
              - 'null'
              description: Content above cursor.
              maxLength: 400000
            content_below_cursor:
              type:
              - string
              - 'null'
              description: Content below cursor.
              maxLength: 400000
          required:
          - file_name
          - content_above_cursor
        intent:
          type:
          - string
          - 'null'
          enum:
          - completion
          - generation
          - null
          description: Intent of the completion request.
        generation_type:
          type:
          - string
          - 'null'
          enum:
          - comment
          - empty_function
          - small_file
          - null
          description: Type of event for generation requests.
        stream:
          type: boolean
          description: If `true`, streams the response as smaller chunks as they are ready, if applicable.
          default: false
        project_path:
          type:
          - string
          - 'null'
          description: Path of the project.
          example: namespace/project
        user_instruction:
          type:
          - string
          - 'null'
          description: User's instructions for Code Suggestions. [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/462750) in GitLab 18.6. Feature flag `code_suggestions_context` removed.
          maxLength: 600000
        context:
          type:
          - array
          - 'null'
          description: Additional context to use for Code Suggestions. [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/462750) in GitLab 18.6. Feature flag `code_suggestions_context` removed.
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                - file
                - snippet
                description: Type of the context part.
                minLength: 1
              name:
                type:
                - string
                - 'null'
                description: Name of the context part.
                maxLength: 255
              content:
                type:
                - string
                - 'null'
                description: Content of the context part.
                maxLength: 600000
            required:
            - type
            - name
            - content
      required:
      - current_file
    postApiV4CodeSuggestionsDirectAccessRequest:
      type: object
      properties:
        project_path:
          type:
          - string
          - 'null'
          description: Path of the project.
          example: namespace/project
    postApiV4CodeSuggestionsEnabledRequest:
      type: object
      properties:
        project_path:
          type:
          - string
          - 'null'
          description: Path of the project.
          example: namespace/project
      required:
      - project_path
  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