Skip to main content
GET
/
v1
/
orgs
/
{org_id}
/
knowledge
/
documents
List Knowledge Documents
curl --request GET \
  --url https://api.letpiper.com/v1/orgs/{org_id}/knowledge/documents \
  --header 'Authorization: Bearer <token>'
{
  "documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "collectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "filename": "<string>",
      "mimeType": "<string>",
      "bytesIngested": 123,
      "processingStatus": "<string>",
      "processingProgress": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "relativePath": "<string>",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "processingError": "<string>",
      "language": "<string>",
      "bookmarkMode": "none"
    }
  ],
  "total": 123
}

Authorizations

Authorization
string
header
required

Platform token (starts with pat_)

Path Parameters

org_id
string<uuid>
required

Query Parameters

collectionId
string<uuid>
required
limit
integer
default:100
Required range: 1 <= x <= 500
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

Paginated response for listing knowledge documents.

documents
KnowledgeDocumentRead · object[]
required
total
integer
required