Knowledge

Update document

Changed on

Update a knowledge document. At least one of name or content must be provided.

patch/v1/documents/{id}

Request

  • Base URL
    https://api.dev.runwayml.com
  • URL
    https://api.dev.runwayml.com/v1/documents/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The document ID.

Headers

X-Runway-Version'2024-11-06' required

The version of the RunwayML API being used. You can read more about versioning here.

Request body

namestring

A new name for the document.

contentstring

New markdown or plain text content for the document.

Example request

{
  "name": "Updated Product FAQ",
  "content": "# Updated FAQ\n\n..."
}

Response

Success

Changes