Knowledge

Create document

Changed on

Create a new knowledge document. Documents can be attached to avatars to provide additional context during conversations.

post/v1/documents

Request

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

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 required

A descriptive name for the document.

contentstring required

The markdown or plain text content of the document.

Example request

{
  "name": "Product FAQ",
  "content": "# Product FAQ\n\n## What is your return policy?\n\nWe offer a 30-day return policy..."
}

Response

Success

idstring uuid required

The unique identifier of the document.

namestring required

The name of the document.

type'text' | 'file' required

The type of document.

contentstring required

The full content of the document.

createdAtstring date-time required

When the document was created.

updatedAtstring date-time required

When the document was last updated.

Changes