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

# Verify a claim

> Read the published `context7.json`. When its `url` and `public_key` match, the library becomes owned by this teamspace. Libraries on shared hosting platforms cannot be claimed automatically.



## OpenAPI

````yaml https://context7.com/openapi.json post /v2/teamspaces/{teamspaceId}/libraries/{owner}/{repo}/claim
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
security: []
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, which reaches only its
      own teamspace and can make changes or read personal data only when it was
      created with write access (other keys can only read and get 403
      `write_access_required` on writes and on personal data), 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. Every API key can read rules, policies,
      usage and the spending limit. Changes, and reading members, invitations,
      the invite link and library requests (they name people), need an API key
      created with **Write access** ticked (other keys get 403
      `write_access_required`), or the Context7 Admin MCP sign-in.
  - 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. Every API key can read. Changes need an API key created with
      **Write access** ticked (other keys get 403 `write_access_required`), or
      the Context7 Admin MCP sign-in.
  - 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.
      Every API key can read, except feature requests and the GitHub account
      behind a build (personal data). Changes, and those reads, need an API key
      created with **Write access** ticked (other keys get 403
      `write_access_required`), or the Context7 Admin MCP sign-in.
  - 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. Every API key can read the visitor, crawler and path reports.
      Searches, questions, conversations, feedback and the raw records
      (`explore`) are personal data and need an API key created with **Write
      access** ticked, or the Context7 Admin MCP sign-in.
  - name: Ask Sites
    description: >-
      Manage a teamspace's Context7 Ask sites: add, verify, remove, and read
      their analytics and question log. Every API key can read the sites.
      Changes, and reading the analytics and question log (visitor questions),
      need an API key created with **Write access** ticked (other keys get 403
      `write_access_required`), or the Context7 Admin MCP sign-in.
paths:
  /v2/teamspaces/{teamspaceId}/libraries/{owner}/{repo}/claim:
    parameters:
      - name: teamspaceId
        in: path
        required: true
        description: Teamspace id (uuid).
        schema:
          type: string
          format: uuid
      - name: owner
        in: path
        required: true
        description: >-
          First segment of the library id `/owner/repo` (for example `vercel` in
          `/vercel/next.js`, `websites` in `/websites/docs_example_com`).
          Case-insensitive.
        schema:
          type: string
      - name: repo
        in: path
        required: true
        description: Second segment of the library id `/owner/repo`. Case-insensitive.
        schema:
          type: string
    post:
      tags:
        - Teamspace Libraries
      summary: Verify a claim
      description: >-
        Read the published `context7.json`. When its `url` and `public_key`
        match, the library becomes owned by this teamspace. Libraries on shared
        hosting platforms cannot be claimed automatically.
      operationId: verifyTeamspaceLibraryClaim
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TeamspaceLibraryClaimVerifyRequest'
      responses:
        '200':
          description: Claimed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TeamspaceLibraryClaimResult'
        '400':
          description: >-
            The file is missing, invalid or in the wrong place;
            `validationErrors`, `found` can explain more
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: invalid_request
                message: >-
                  URL mismatch The url in context7.json must be
                  "https://context7.com/acme/docs"
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          description: The file's public key is not this teamspace's
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: forbidden
                message: >-
                  The public_key in context7.json does not match your team's
                  public key
        '404':
          description: The library does not exist or the caller cannot see it
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: library_not_found
                message: Library not found.
        '409':
          description: 'Another teamspace has claimed the library (`alreadyClaimed: true`)'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: conflict
                message: This library is already claimed by another teamspace
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    TeamspaceLibraryClaimVerifyRequest:
      type: object
      properties:
        context7JsonUrl:
          type: string
          format: uri
          description: >-
            URL of the published file. Required for `hostedFile`, and for a
            repository on a host other than GitHub, GitLab or Bitbucket (the raw
            file URL).
        configSource:
          type: string
          enum:
            - dashboard
            - context7json
          description: >-
            Repositories: where the parser reads settings from after the claim.
            Default `dashboard`.
    TeamspaceLibraryClaimResult:
      type: object
      required:
        - success
        - message
        - libraryName
        - ownership
      properties:
        success:
          type: boolean
        message:
          type: string
        libraryName:
          type: string
        ownership:
          type: object
          required:
            - id
            - libraryName
            - createdAt
          properties:
            id:
              type: string
            libraryName:
              type: string
            createdAt:
              type: string
              format: date-time
    Error:
      type: object
      description: Standard error response
      properties:
        error:
          type: string
          description: Error code identifier
        message:
          type: string
          description: Human-readable error message
      required:
        - error
        - message
  responses:
    UnauthorizedError:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: invalid_api_key
            message: >-
              Invalid API key. Please check your API key. API keys should start
              with 'ctx7sk' prefix.
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: internal_error
            message: An error occurred while processing your request
  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. Every key can read the
        management API (`/v2/teamspaces/*`), except personal data: member and
        invitation emails, library requesters, visitor questions, Docs7 reader
        searches, conversations, feedback and feature requests, and the GitHub
        account behind a build. To read those or make changes there, the key
        must be created with **Write access** ticked; other keys get 403
        `write_access_required`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.