POST
/
v1
/
apps
/
{app_id}
/
users
/
{user_id}
/
collections
/
{collection_id}
/
documents
/
list
import Honcho from 'honcho-ai';

const client = new Honcho({
  apiKey: process.env['HONCHO_API_KEY'], // This is the default and can be omitted
});

async function main() {
  // Automatically fetches more pages as needed.
  for await (const document of client.apps.users.collections.documents.list(
    'app_id',
    'user_id',
    'collection_id',
  )) {
    console.log(document.id);
  }
}

main();
{
  "items": [
    {
      "id": "<string>",
      "content": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "collection_id": "<string>"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2,
  "pages": 1
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
app_id
string
required

ID of the app

​
user_id
string
required

ID of the user

​
collection_id
string
required

ID of the collection

Query Parameters

​
reverse
boolean | null
default:false

Whether to reverse the order of results

​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Body

application/json

Filtering options for the documents list

​
filter
object | null

Response

200
application/json
Successful Response
​
items
object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1
​
pages
integer
Required range: x >= 0