> ## 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.

# Search for libraries

> Search for libraries by name with intelligent LLM-powered ranking based on your query context.



## OpenAPI

````yaml https://context7.com/openapi.json get /v2/libs/search
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/libs/search:
    get:
      tags:
        - Search
      summary: Search for libraries
      description: >-
        Search for libraries by name with intelligent LLM-powered ranking based
        on your query context.
      operationId: searchLibraries
      parameters:
        - $ref: '#/components/parameters/LibraryNameParam'
        - $ref: '#/components/parameters/QueryParam'
        - $ref: '#/components/parameters/FastParam'
      responses:
        '200':
          description: Search results ranked by relevance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
              example:
                results:
                  - id: /facebook/react
                    title: React
                    description: A JavaScript library for building user interfaces
                    branch: main
                    lastUpdateDate: '2025-01-15T10:30:00.000Z'
                    state: finalized
                    totalTokens: 500000
                    totalSnippets: 2500
                    stars: 220000
                    trustScore: 10
                    benchmarkScore: 95.5
                    versions:
                      - v18.2.0
                      - v17.0.2
                searchFilterApplied: false
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '402':
          $ref: '#/components/responses/SpendingLimitError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/RateLimitError'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
      security:
        - {}
        - bearerAuth: []
components:
  parameters:
    LibraryNameParam:
      name: libraryName
      in: query
      description: Library name to search for (e.g., 'react', 'nextjs', 'express')
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 500
      example: react
    QueryParam:
      name: query
      in: query
      description: >-
        User's original question or task - used for intelligent relevance
        ranking
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 500
      example: How to manage state with hooks
    FastParam:
      name: fast
      in: query
      description: >-
        When `true`, skip LLM reranking and return top vector-search results
        directly. Trades relevance quality for lower latency.
      required: false
      schema:
        type: string
        enum:
          - 'true'
          - 'false'
        default: 'false'
      example: 'true'
  schemas:
    SearchResponse:
      type: object
      description: Search results response
      properties:
        results:
          type: array
          description: Array of matching libraries ranked by relevance
          items:
            $ref: '#/components/schemas/Library'
        searchFilterApplied:
          type: boolean
          description: >-
            Indicates whether the search results were filtered by the
            teamspace's public library access settings. When true, some
            libraries may be excluded from results based on the teamspace's
            configuration (e.g., only verified libraries, selected libraries, or
            private repos only).
      required:
        - results
        - searchFilterApplied
    Library:
      type: object
      description: Library metadata
      properties:
        id:
          type: string
          description: >-
            Library ID — the URL path of the library on context7.com.
            `/owner/repo` for GitHub repositories, or `/<source>/<id>` for other
            sources (e.g., `/vercel/next.js`, `/websites/uploadcare_com`). See
            [Library ID format](/api-guide#library-id-format).
          example: /vercel/next.js
        title:
          type: string
          description: Display name of the library
          example: Next.js
        description:
          type: string
          description: Short description
          example: The React Framework
        branch:
          type: string
          description: Git branch being tracked
          example: canary
        lastUpdateDate:
          type: string
          format: date-time
          description: ISO 8601 timestamp of last update
          example: '2025-01-15T10:30:00.000Z'
        state:
          type: string
          enum:
            - finalized
            - initial
            - processing
            - error
            - delete
          description: Processing state of the library
          example: finalized
        totalTokens:
          type: integer
          description: Total tokens in documentation
          example: 607822
        totalSnippets:
          type: integer
          description: Number of code snippets
          example: 3629
        stars:
          type: integer
          description: GitHub stars count
          example: 131745
        trustScore:
          type: integer
          description: Source reputation score (0-10)
          minimum: 0
          maximum: 10
          example: 10
        benchmarkScore:
          type: number
          description: Quality indicator score (0-100)
          minimum: 0
          maximum: 100
          example: 95.5
        versions:
          type: array
          description: Available version tags
          items:
            type: string
          example:
            - v15.1.8
            - v14.3.0
    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:
    BadRequestError:
      description: Bad Request - Invalid input parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            validationError:
              summary: Validation error
              value:
                error: validation_error
                message: Library name is required
            invalidLibraryId:
              summary: Invalid library ID format
              value:
                error: invalid_library_id
                message: >-
                  Invalid library ID format. Expected: `/owner/repo` for GitHub
                  repositories, or `/<source>/<id>` for other sources (the URL
                  path of the library on context7.com)
    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.
    SpendingLimitError:
      description: >-
        Payment Required - the teamspace's configured monthly spending limit has
        been reached. A teamspace owner or admin can raise the limit in billing
        settings, or the cap will reset at the start of the next billing month.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: spending_limit_exceeded
            message: >-
              Monthly spending limit of $5.00 reached for this teamspace. An
              owner or admin can raise the limit at
              https://context7.com/dashboard/billing, or the cap will reset at
              the start of next month.
    NotFoundError:
      description: Not Found - Resource doesn't exist
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            libraryNotFound:
              summary: Library not found
              value:
                error: library_not_found
                message: >-
                  Library "/owner/repo" not found. Please check the library ID
                  or your access permissions.
            versionNotFound:
              summary: Version not found
              value:
                error: version_not_found
                message: >-
                  Version "canary" not found for library "/owner/repo".
                  Available versions: v2.0.0, v1.5.0
            noSnippetsFound:
              summary: No snippets found
              value:
                error: no_snippets_found
                message: Could not fetch documentation snippets from the library.
            noRelevantSnippets:
              summary: No snippets matched the query
              value:
                error: no_relevant_snippets
                message: >-
                  No documentation in "/owner/repo" matched this query. Try a
                  more specific query with different terms, or search for
                  another library that covers this topic.
            teamNotFound:
              summary: Team not found
              value:
                error: team_not_found
                message: Team not found or access denied
            userNotFound:
              summary: User not found
              value:
                error: user_not_found
                message: User not found
            noLibrariesFound:
              summary: No libraries matched search query
              value:
                error: no_libraries_found
                message: >-
                  No libraries found for "nonexistent-lib". Try a different
                  search term.
    RateLimitError:
      description: Too Many Requests - Rate limit exceeded
      headers:
        Retry-After:
          description: Seconds until rate limit resets
          schema:
            type: integer
        RateLimit-Limit:
          description: Request limit
          schema:
            type: integer
        RateLimit-Remaining:
          description: Remaining requests
          schema:
            type: integer
        RateLimit-Reset:
          description: Unix timestamp when limit resets
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: rate_limit_exceeded
            message: Rate limit exceeded. Please try again later.
    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
    ServiceUnavailableError:
      description: Service Unavailable - Search service is temporarily unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: search_failed
            message: 'Search failed: Service temporarily unavailable'
  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.