JAjasper
Knowledge

Update a knowledge item by ID

Changed on

Update an existing knowledge item by ID

patch/v1/knowledge/{knowledgeId}

Request

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

Path parameters

knowledgeIdstring required
Example:kno_2ee766eaa4ef48e59da1d9602bfecf2d

The Knowledge's unique ID

Request body multipart/form-data

namestring

The friendly name of the Knowledge item. Up to 100 characters.

filestring binary

The file containing content you want to create a Knowledge item from. Supported file types are .txt, .pdf, .doc, .docx, .pptx, .mp3, .wav, .m4a, .aac, .mp4, .mov, .csv, .xlsx, .xls, .png, .jpeg, .jpg, .md, up to 300MB (or 2GB for video files).

metadatastring json

Set of key-value pairs for storing additional structured information.

settingsstring json

Additional configuration options.

summarystring

The manually created Knowledge item summary.

tagsstring[]

The tags associated with the Knowledge item. Tags are searchable via the Jasper app.

Example request

{
  "name": "Product Release Monthly Webinar - May 2023",
  "file": "jasperbrandvoice.pdf",
  "metadata": "{\"NewKey\": \"New Value\", \"AnotherKey\": \"Another Value\"}",
  "settings": "{\"appVisibility\": \"visible\", \"autoSummary\": true}",
  "summary": "This Knowledge item outlines guidelines for using the Jasper logo",
  "tags": [
    "tag1",
    "tag2"
  ]
}

Response

Update an existing Knowledge

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"
  }
}

Changes

  • 3d5be7408661Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status