JAjasper
Knowledge

Search Knowledge

Changed on

Searches through your Knowledge Base and returns items most relevant to the provided query. This endpoint is designed to support natural language search, allowing you to find Knowledge based on meaning and context—not just exact keyword matches.

post/v1/knowledge/search

Request

  • Base URL
    https://api.jasper.ai
  • URL
    https://api.jasper.ai/v1/knowledge/search
  • Auth
    • API key in header X-API-Key
    • or OAuth 2
      Authorization code: https://api.jasper.ai/oauth2/authorize
      Token URL: https://api.jasper.ai/oauth2/token scopes: user

Request body

querystring required

The search query to find relevant Knowledge items. Supports natural language search.

Example request

{
  "query": "What are my brand guidelines for social media posts?"
}

Response

Successfully retrieved list of Knowledge by relevance to the query.

requestIdstring
resourcestring

Example response

{
  "requestId": "bce766ea-a4ef-48e5-9da1d9602bfecf2d",
  "resource": "knowledge",
  "data": [
    {
      "id": "kno_2ee766eaa4ef48e59da1d9602bfecf2d",
      "name": "Brand Guidelines Document",
      "summary": "Comprehensive brand guidelines including logo usage, color palette, and typography standards.",
      "tags": [
        "branding",
        "guidelines",
        "logo"
      ],
      "appUrl": "https://app.jasper.ai/jasper-iq/knowledge-base/kno_2ee766eaa4ef48e59da1d9602bfecf2d",
      "url": "https://giving.uchicago.edu",
      "relevantChunks": [
        {
          "content": "Brand guidelines specify that our logo should always maintain a minimum clear space equivalent to the height of the \"J\" in our wordmark.",
          "score": 0.85
        }
      ]
    }
  ]
}

Changes

  • 3d5be7408661Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status