JAjasper
Knowledge

Retrieve knowledge items

Changed on

Returns a list of knowledge items available to your workspace, sorted from most recently created

get/v1/knowledge

Request

  • Base URL
    https://api.jasper.ai
  • URL
    https://api.jasper.ai/v1/knowledge
  • 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

Query parameters

qstring
Example:metadata[key]:value

You can use the q parameter to run a query parameter search. Query parameter search supports the following fields: name, tags, metadata, and settings.

Supported operators: AND

The AND operator can be used to combine multiple search criteria.

NOTE: The AND operator supports a maximum of 10 operators

Available field examples:

name: value

tags: value

metadata[key]:value

settings[appVisibility]:visible

metadata[key1]:value1 AND metadata[key2]:value2

pagenumber
Example:1

The desired page number of Knowledge items

sizenumber
Example:10

The number of Knowledge items per page to return in the response

Response

Retrieve knowledge items

requestIdstring
resourcestring

Example response

{
  "requestId": "bce766ea-a4ef-48e5-9da1-d9602bfecf2d",
  "resource": "knowledge",
  "data": [
    {
      "name": "Product Release Monthly Webinar - May 2023",
      "file": "jasperbrandvoice.pdf",
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "id": "kno_2ee766eaa4ef48e59da1d9602bfecf2d",
      "createdAt": "2023-09-21T15:38:00.474Z",
      "updatedAt": "2023-09-21T15:38:00.474Z",
      "processingState": "InProgress",
      "tags": [
        "tag1",
        "tag2"
      ],
      "appUrl": "https://app.jasper.ai/jasper-iq/knowledge-base/kno_2ee766eaa4ef48e59da1d9602bfecf2d",
      "url": "https://giving.uchicago.edu"
    }
  ],
  "pagination": {
    "totalRecords": 1,
    "page": 1,
    "size": 10
  }
}

Changes

  • 3d5be7408661Revision changes
    • breaking

      the / response's property type changed from string to object for status

    • breaking

      the / response's property type changed from string to object for status

    • info

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

    • info

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