GitLab Ai agent sessions API

openapi: 3.2.0
info:
  title: GitLab REST Ai agent sessions 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: Ai agent sessions
  description: Operations related to ai agent sessions.
paths:
  /api/v4/projects/{id}/ai_agent/sessions:
    post:
      operationId: postApiV4ProjectsIdAiAgentSessions
      summary: Create an external agent session
      description: Creates a new external agent session for the current user and project. Returns an existing record if an idempotency_key is provided and a matching session already exists.
      tags:
      - Ai agent sessions
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesAiExternalAgentsSession'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '429':
          description: Too many requests
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdAiAgentSessionsRequest'
      x-gitlab-lifecycle: experiment
      x-gitlab-tier: premium
    get:
      operationId: getApiV4ProjectsIdAiAgentSessions
      summary: List external agent sessions for a project
      description: Returns a paginated list of external agent sessions for the project.
      tags:
      - Ai agent sessions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesAiExternalAgentsSession'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: agent_type
        required: false
        description: Filter by agent type.
        schema:
          type:
          - string
          - 'null'
          enum:
          - claude-code
          - opencode
          - cursor
          - codex
          - null
        in: query
      - name: status
        required: false
        description: Filter by status.
        schema:
          type:
          - string
          - 'null'
          enum:
          - created
          - running
          - finished
          - failed
          - stopped
          - null
        in: query
      - name: created_after
        required: false
        description: Filter sessions created after this time.
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
      - name: created_before
        required: false
        description: Filter sessions created before this time.
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 1
      x-gitlab-lifecycle: experiment
      x-gitlab-tier: premium
  /api/v4/projects/{id}/ai_agent/sessions/{session_id}:
    patch:
      operationId: patchApiV4ProjectsIdAiAgentSessionsSessionId
      summary: Complete or fail an external agent session
      description: Marks a session as completed or failed. The authenticated user must be the creator of the session.
      tags:
      - Ai agent sessions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesAiExternalAgentsSession'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
      parameters:
      - name: session_id
        required: true
        description: The session ID.
        schema:
          type: integer
        in: path
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
        example: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/patchApiV4ProjectsIdAiAgentSessionsSessionIdRequest'
      x-gitlab-lifecycle: experiment
      x-gitlab-tier: premium
components:
  schemas:
    APIEntitiesAiExternalAgentsSession:
      type: object
      properties:
        id:
          type: integer
          example: 1
        agent_type:
          type: string
          example: claude-code
        user_id:
          type: integer
          example: 1
        status:
          type: string
          example: running
        flow_type:
          type: string
          example: external_agent
        glab_version:
          type: string
          example: glab 1.121.0 (abc1234)
        agent_version:
          type: string
          example: 2.1.295
        external_xid:
          type: string
          example: uuid
        session_started_at:
          type: string
          example: '2026-06-17T00:00:00.000Z'
        session_finished_at:
          type: string
          example: '2026-06-17T00:00:00.000Z'
        created_at:
          type: string
          example: '2026-06-17T00:00:00.000Z'
        updated_at:
          type: string
          example: '2026-06-17T00:00:00.000Z'
    patchApiV4ProjectsIdAiAgentSessionsSessionIdRequest:
      type: object
      properties:
        status:
          type: string
          enum:
          - completed
          - failed
          description: Terminal status.
          minLength: 1
        jsonl_sha256:
          type:
          - string
          - 'null'
          description: SHA-256 of the transcript file.
          pattern: ^\p{AHex}{64}$
          maxLength: 64
      required:
      - status
    postApiV4ProjectsIdAiAgentSessionsRequest:
      type: object
      properties:
        agent_type:
          type: string
          enum:
          - claude-code
          - opencode
          - cursor
          - codex
          description: The type of agent.
          minLength: 1
        agent_identity_id:
          type:
          - integer
          - 'null'
          description: ID of the registered agent identity.
        sync_type:
          type: string
          enum:
          - hook
          - fallback
          - manual
          description: How the session was synced.
          minLength: 1
        goal:
          type:
          - string
          - 'null'
          description: User-provided session description.
        started_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Session start time, supports backfill.
        idempotency_key:
          type:
          - string
          - 'null'
          description: Client-generated UUID for retry safety.
          maxLength: 255
        workflow_definition:
          type:
          - string
          - 'null'
          description: Workflow definition identifier for the session.
        glab_version:
          type:
          - string
          - 'null'
          description: Version of the glab binary that created the session.
          maxLength: 255
        agent_version:
          type:
          - string
          - 'null'
          description: Version of the agent that ran the session.
          maxLength: 255
      required:
      - agent_type
      - agent_identity_id
      - sync_type
  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