> ## Documentation Index
> Fetch the complete documentation index at: https://docs.langchain.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Forge Github Install Link Endpoint

> Create a Forge GitHub App installation link.



## OpenAPI

````yaml https://api.host.langchain.com/openapi.json post /v2/integrations/forge-github/installation-link
openapi: 3.1.0
info:
  title: LangSmith Deployment Control Plane API
  description: >
    The LangSmith Deployment Control Plane API is used to programmatically
    create and manage

    Agent Server deployments. For example, the APIs can be orchestrated to

    create custom CI/CD workflows.


    ## Host

    https://api.host.langchain.com


    ## Authentication

    To authenticate with the LangSmith Deployment Control Plane API, set the
    `X-Api-Key` header

    to a valid [LangSmith API
    key](https://docs.langchain.com/langsmith/create-account-api-key#create-an-api-key).


    ## Versioning

    Each endpoint path is prefixed with a version (e.g. `v1`, `v2`).


    ## Quick Start

    1. Call `POST /v2/deployments` to create a new Deployment. The response body
    contains the Deployment ID (`id`) and the ID of the latest (and first)
    revision (`latest_revision_id`).

    1. Call `GET /v2/deployments/{deployment_id}` to retrieve the Deployment.
    Set `deployment_id` in the URL to the value of Deployment ID (`id`).

    1. Poll for revision `status` until `status` is `DEPLOYED` by calling `GET
    /v2/deployments/{deployment_id}/revisions/{latest_revision_id}`.

    1. Call `PATCH /v2/deployments/{deployment_id}` to update the deployment.
  version: 0.1.0
servers: []
security: []
paths:
  /v2/integrations/forge-github/installation-link:
    post:
      tags:
        - Integrations (v2)
      summary: Get Forge Github Install Link Endpoint
      description: Create a Forge GitHub App installation link.
      operationId: >-
        get_forge_github_install_link_endpoint_v2_integrations_forge_github_installation_link_post
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/GithubInstallLinkRequest'
                - type: 'null'
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EngineInstallLink'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - API Key: []
        - Tenant ID: []
        - Bearer Auth: []
components:
  schemas:
    GithubInstallLinkRequest:
      properties:
        return_to:
          anyOf:
            - type: string
            - type: 'null'
          title: Return To
          description: URL to return to after completing the GitHub App installation.
      type: object
      title: GithubInstallLinkRequest
      description: Request to create a GitHub App installation link.
    EngineInstallLink:
      properties:
        install_url:
          type: string
          title: Install Url
      type: object
      required:
        - install_url
      title: EngineInstallLink
      description: >-
        Engine GitHub App connect-link response. Returned by

        `/forge/github/install`. `install_url` is now the *OAuth authorize* URL
        —

        the user lands on GitHub OAuth first, the callback enumerates what they

        can actually see, and either auto-routes to a fresh install or shows a

        server-rendered picker. Field name kept for backwards compatibility with

        the FE, but the contents changed.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````