Derive GitHub API

openapi: 3.2.0
info:
  title: Derive GitHub API
  version: 1.0.0
  description: 'Derive''s HTTP API. Every response shape here is the single source of truth for the web client — generated from the same Zod schemas that back this reference, so the docs never drift from the running API.


    **Auth:** a session cookie (browser) or a bearer token (agents and the CLI). Most write routes are scoped to the caller''s active workspace. The `/v1` paths are the stable product surface; `/openapi.json` serves this spec and `/docs` renders it.'
tags:
- name: Github
  description: Install-backed GitHub access for reading pull requests and posting comments.
paths:
  /v1/github:
    get:
      tags:
      - Github
      summary: GitHub standard-integration status for the current workspace
      responses:
        '200':
          description: App availability, connection health, and connected GitHub accounts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GithubStatus'
      operationId: getV1Github
      x-operation-id-source: derived
  /v1/github/connections/{id}/repositories:
    get:
      tags:
      - Github
      summary: Read repositories available to this workspace's GitHub installation
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      - schema:
          type: integer
          minimum: 1
          maximum: 10000
          default: 1
        required: false
        name: page
        in: query
      responses:
        '200':
          description: One page of accessible repositories, verified with an installation token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GithubRepositories'
      operationId: getV1GithubConnectionsByIdRepositories
      x-operation-id-source: derived
  /v1/github/connections/{id}:
    delete:
      tags:
      - Github
      summary: Disconnect one GitHub installation from agent use (Admin only)
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      responses:
        '204':
          description: The GitHub connection was disconnected.
      operationId: deleteV1GithubConnectionsById
      x-operation-id-source: derived
components:
  schemas:
    GithubStatus:
      type: object
      properties:
        available:
          type: boolean
          description: Whether this instance has a live GitHub App configured
        connected:
          type: boolean
          description: Whether this workspace has at least one active GitHub connection
        app_slug:
          type:
          - string
          - 'null'
        app_owner_login:
          type:
          - string
          - 'null'
        app_permissions_state:
          type:
          - string
          - 'null'
          enum:
          - ready
          - update_required
          - unknown
          - null
          description: Whether the instance App has every current permission; null when no live App exists
        app_settings_url:
          type:
          - string
          - 'null'
        can_manage_app:
          type: boolean
          description: Whether the caller is an instance operator who can configure the shared App
        accounts:
          type: array
          items:
            type: object
            properties:
              installation_id:
                type: string
              account_login:
                type:
                - string
                - 'null'
              account_type:
                type:
                - string
                - 'null'
                enum:
                - organization
                - user
                - null
              connection_id:
                type: string
              state:
                type: string
                enum:
                - active
                - needs_reauth
              permissions_state:
                type: string
                enum:
                - ready
                - approval_required
                - unknown
              permissions_url:
                type:
                - string
                - 'null'
              installation_url:
                type:
                - string
                - 'null'
            required:
            - installation_id
            - account_login
            - account_type
            - connection_id
            - state
            - permissions_state
            - permissions_url
            - installation_url
      required:
      - available
      - connected
      - app_slug
      - app_owner_login
      - app_permissions_state
      - app_settings_url
      - can_manage_app
      - accounts
    GithubRepositories:
      type: object
      properties:
        total_count:
          type: number
        repositories:
          type: array
          items:
            type: object
            properties:
              id:
                type: number
              full_name:
                type: string
              private:
                type: boolean
              html_url:
                type: string
            required:
            - id
            - full_name
            - private
            - html_url
        has_more:
          type: boolean
      required:
      - total_count
      - repositories
      - has_more