Search for libraries

Search locally indexed libraries by name

1 min read

gethttps://your-instance.example.com/api/v2/libs/search

Request example

curl --request GET \
  --url https://your-instance.example.com/api/v2/libs/search?libraryName=react&query=How%20to%20manage%20state%20with%20hooks

Response

{
  "results": [
    {
      "id": "/your-org/your-repo",
      "title": "Your Repo",
      "description": "Internal tooling docs",
      "totalSnippets": 150,
      "source": "Local (Private)",
      "trustScore": 10
    }
  ]
}

gethttps://your-instance.example.com/api/v2/libs/search

Query parameters

libraryNamestringrequired#

Library name to search for (e.g., react, nextjs)

Length: 1–500

querystringrequired#

User's original question or task - used for relevance ranking

Length: 1–500

Responses

application/json

Search results ranked by relevance

resultsobject[]required#

Matching libraries ranked by relevance

Show child attributes

idstring#

Library ID to pass to GET /v2/context

titlestring#

Display name

descriptionstring#

Short description

totalSnippetsinteger#

Number of indexed snippets

sourcestring#

Where the library was indexed from

trustScoreinteger#

Source reputation score (0–10)

Authentication Get documentation context