> ## Documentation index
> Fetch the complete documentation index at: https://context7.com/docs/llms.txt
> Ask it with GET https://context7.com/docs/ask?q=<keywords or question>. Short keywords rank best.
> Use these to discover all available pages before exploring further.
> Feature requests: https://context7.com/docs/resources/feature-requests.md lists what users asked for and how to vote for a request or add one.
> Page rating: `GET https://context7.com/docs/feedback?path=/docs/api-reference/docs7-sites/add-a-docs7-site&helpful=true` (or `false`) records whether this page helped. An optional `comment` (URL-encoded, at most 500 characters) says what was missing or wrong. It is anonymous and needs no key. Comments hold no code, secrets or personal data.

# Add a Docs7 site

> Connect a GitHub repository. Docs7 checks that both the Docs7 GitHub App and the caller's own GitHub account can read the repository. The caller must have connected GitHub in the Context7 dashboard once (the dashboard stores the GitHub authorization); without it the answer is 400 `github_access_missing`. A repository with `docs.json` or `mint.json` is published (`hosting: "on"`) and its first build starts; without one the site is added for the agents only (`hosting: "off"`). Developers can set only `repoUrl`, `branch`, `docsPath` and `context7Index`. Docs7 Free includes 3 sites and public repositories only.

`POST /v2/teamspaces/{teamspaceId}/sites`

## OpenAPI

````yaml https://context7.com/openapi.json post /v2/teamspaces/{teamspaceId}/sites
openapi: 3.0.0
info:
  title: Context7 Public API
  description: The Context7 Public API provides programmatic access to library
    documentation and search functionality. Get up-to-date documentation and
    code examples for any library.
  version: 2.0.0
  contact:
    name: Context7 Support
    url: https://context7.com
    email: support@context7.com
servers:
  - url: https://context7.com/api
    description: Production server
tags:
  - name: Search
    description: Search for libraries in the Context7 database
  - name: Context
    description: Retrieve documentation context for queries
  - name: Ask
    description: Answer questions from a website registered with Context7 Ask
  - name: Refresh
    description: Refresh existing libraries to fetch latest documentation
  - name: Policies
    description: Manage teamspace access policies and filters
  - name: Add Library
    description: Submit new libraries for documentation processing
  - name: Metrics
    description: Retrieve usage metrics for libraries
  - name: Usage
    description: See member and teamspace API usage
  - name: Teamspaces
    description: Teamspaces the caller is a member of. The management API
      (`/v2/teamspaces/*`) accepts a Context7 API key created with management
      access (other keys get 403 `management_access_required`), which reaches
      only its own teamspace, or an OAuth token issued for the Context7 Admin
      MCP server (`https://admin.mcp.context7.com/mcp`), which reaches every
      teamspace of the user. A browser session is not accepted.
  - name: Teamspace Admin
    description: Members, invitations, rules, library policies and requests, usage
      and the spending limit of a teamspace.
  - name: Teamspace Libraries
    description: "A teamspace's libraries: its private sources and the libraries it
      has claimed. Add, refresh, configure, version, claim and remove them, and
      read their parse state and usage. A library id `/owner/repo` is two path
      segments."
  - name: Docs7 Sites
    description: 'Docs7 documentation sites of a teamspace: settings, custom
      domains, deployments, previews and the Docs7 agents. Any member can read;
      owners and admins can change; developers can add a site, publish one added
      for the agents only, and rebuild. Sites deployed with the `docs7 deploy`
      CLI have `source: "local"`; operations marked GitHub-only answer 404 for
      them.'
  - name: Docs7 Analytics
    description: "Traffic of one Docs7 site: visitors, AI crawlers, searches,
      assistant questions and page feedback. Docs7 Free reads the last 7 days,
      Docs7 Pro the last 90."
  - name: Ask Sites
    description: "Manage a teamspace's Context7 Ask sites: add, verify, remove, and
      read their analytics and question log"
paths:
  /v2/teamspaces/{teamspaceId}/sites:
    post:
      tags:
        - Docs7 Sites
      summary: Add a Docs7 site
      description: "Connect a GitHub repository. Docs7 checks that both the Docs7
        GitHub App and the caller's own GitHub account can read the repository.
        The caller must have connected GitHub in the Context7 dashboard once
        (the dashboard stores the GitHub authorization); without it the answer
        is 400 `github_access_missing`. A repository with `docs.json` or
        `mint.json` is published (`hosting: \"on\"`) and its first build starts;
        without one the site is added for the agents only (`hosting: \"off\"`).
        Developers can set only `repoUrl`, `branch`, `docsPath` and
        `context7Index`. Docs7 Free includes 3 sites and public repositories
        only."
      operationId: createDocsSite
      parameters:
        - name: teamspaceId
          in: path
          required: true
          description: Teamspace id.
          schema:
            type: string
            format: uuid
      security:
        - bearerAuth: []
      responses:
        "201":
          description: The new site
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: "#/components/schemas/Docs7Site"
                  deploymentId:
                    type: string
                    format: uuid
                    nullable: true
                    description: The first build, when one started.
        "400":
          description: Invalid body (`invalid_payload`, with `details`), docs folder
            missing (`docs_path_missing`), a custom domain on a repository
            without docs config (`docs_config_missing`), or no GitHub access
            (`github_access_missing`)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Docs7Error"
              example:
                error: github_access_missing
                message: Give your GitHub account and the Docs7 GitHub App access to this
                  repository, then try again
        "401":
          description: Missing or invalid bearer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Docs7Error"
              example:
                error: unauthorized
                message: Authentication required.
        "403":
          description: Role not allowed (`forbidden`), or the plan does not allow it
            (`docs7_pro_required`)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Docs7Error"
              example:
                error: docs7_pro_required
                message: Docs7 Free includes 3 sites. Upgrade to Docs7 Pro to add another.
        "404":
          description: No such site in this teamspace
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Docs7Error"
              example:
                error: not_found
                message: Site not found.
        "409":
          description: The repository, slug or domain is taken (`site_conflict`), or the
            teamspace is changing (`project_busy`)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Docs7Error"
              example:
                error: site_conflict
        "500":
          description: Internal error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Docs7Error"
              example:
                error: internal_error
                message: Internal server error.
        "502":
          description: GitHub could not be read
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Docs7Error"
              example:
                error: source_check_failed
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Docs7CreateSiteRequest"
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Get your API key at
        [context7.com/dashboard](https://context7.com/dashboard). Treat your API
        key like a password and store it securely.
  schemas:
    Docs7Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Error code (snake_case).
        message:
          type: string
          description: Human-readable message. Most errors have one.
        details:
          type: object
          description: Validation details on `invalid_payload`.
      description: Docs7 error response
    Docs7DnsRecord:
      type: object
      required:
        - purpose
        - type
        - name
        - value
      properties:
        purpose:
          type: string
          enum:
            - domain_ownership
            - tls_certificate
        type:
          type: string
          enum:
            - CNAME
            - TXT
        name:
          type: string
        value:
          type: string
      description: A DNS record to add for the custom domain.
    Docs7PullRequestReview:
      type: object
      required:
        - enabled
        - response
      properties:
        enabled:
          type: boolean
        response:
          type: string
          enum:
            - comment
            - pull_request
            - commit
          description: What the agent does with its fixes. The findings comment is always
            posted, and every check always runs.
      description: PR Review Agent settings.
    Docs7Site:
      type: object
      required:
        - id
        - projectId
        - repoUrl
        - docsPath
        - hosting
        - platformHostname
        - customDomainStatus
        - context7Index
        - improveSchedule
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          format: uuid
        projectId:
          type: string
          format: uuid
          description: Teamspace id.
        createdBy:
          type: string
          nullable: true
        repoUrl:
          type: string
          format: uri
        repositoryId:
          type: string
          description: GitHub repository id.
        installationId:
          type: integer
          description: GitHub App installation id.
        branch:
          type: string
          description: Pinned production branch. Null follows the default branch.
          nullable: true
        defaultBranch:
          type: string
          nullable: true
        docsPath:
          type: string
          description: Docs folder in the repository; `.` is the root.
        hosting:
          type: string
          enum:
            - off
            - on
          description: "`off`: added for the agents only, nothing is published."
        analyticsUrl:
          type: string
          format: uri
          description: External docs URL for browser analytics of a site that Docs7 does
            not host.
          nullable: true
        workerName:
          type: string
        platformHostname:
          type: string
          example: acme-docs.docs7.io
        customDomain:
          type: string
          nullable: true
        customDomainPath:
          type: string
          description: Path prefix the docs are served under on the custom domain.
          nullable: true
        customDomainRouting:
          type: string
          enum:
            - dns
            - proxy
          nullable: true
        customHostnameId:
          type: string
          nullable: true
        customDomainStatus:
          type: string
          enum:
            - none
            - pending_ownership
            - pending_dns
            - pending_validation
            - pending_certificate
            - pending_proxy
            - active
            - failed
        customDomainError:
          type: string
          nullable: true
        customDomainRecords:
          type: array
          items:
            $ref: "#/components/schemas/Docs7DnsRecord"
        context7Index:
          type: boolean
          description: Whether the repository is indexed in Context7.
        context7LibraryName:
          type: string
          example: /acme/docs
        improveSchedule:
          type: string
          enum:
            - off
            - daily
            - weekly
          description: How often the Context7 Agent runs on its own.
        pullRequestReview:
          $ref: "#/components/schemas/Docs7PullRequestReview"
        codeWatch:
          type: object
          required:
            - enabled
            - repositories
          properties:
            enabled:
              type: boolean
            repositories:
              type: array
              items:
                type: object
                required:
                  - repositoryId
                  - repoUrl
                properties:
                  repositoryId:
                    type: string
                  repoUrl:
                    type: string
                    format: uri
          description: "Code Watch Agent settings: code repositories whose merged pull
            requests can change the docs."
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        buildFixSchedule:
          type: string
          enum:
            - off
            - after_build
            - daily
            - weekly
          description: When the Build Fix Agent fixes the issues of the latest production
            build (hosted sites).
      description: A Docs7 site built from a GitHub repository.
    Docs7CreateSiteRequest:
      type: object
      required:
        - repoUrl
        - docsPath
      properties:
        repoUrl:
          type: string
          format: uri
          example: https://github.com/acme/docs
        branch:
          type: string
          minLength: 1
          maxLength: 255
          description: "Production branch. Default: the repository's default branch."
        docsPath:
          type: string
          description: Docs folder; `.` for the root.
          example: .
        context7Index:
          type: boolean
          description: Also index the repository in Context7.
        slug:
          type: string
          minLength: 3
          maxLength: 40
          pattern: ^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$
          description: "First label of the platform hostname. Default: `owner-repo`. Owner
            or admin."
        customDomain:
          type: string
          description: Owner or admin.
        customDomainPath:
          type: string
          description: Required with `proxy` routing. Owner or admin.
        customDomainRouting:
          type: string
          enum:
            - dns
            - proxy
          description: Required with `customDomain`. Owner or admin.
      additionalProperties: false
````