Skip to content
DashboardGet API key

List documents

View .md
GET

List documents in a knowledge base.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • senderIdstringrequired
  • kbIdstringrequired

Query parameters

  • limitinteger
    Default50
    Limitsmax 100
  • cursorstring

Responses

200List of documents.
  • itemsobject[]required
    8 properties
    • idstringrequired
    • knowledgeBaseIdstringrequired
    • titlestringrequired
    • contentLengthintegerrequired

      Length of the document content in characters.

    • chunkCountintegerrequired

      Number of chunks created from this document.

    • isProcessedbooleanrequired

      Whether the document has been processed for RAG.

    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
  • nextCursorstringnullable
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Knowledge base not found.
  • codestringrequired
  • messagestringrequired
  • detailsobject