Get and list documents

​

Get a document

curl https://api.conare.ai/namespaces/docs/documents/refunds \
  -H "Authorization: Bearer $CONARE_API_KEY"

const doc = await docs.get("refunds"); // null if it doesn't exist

{
  "id": "refunds",
  "text": "Refunds are available for 30 days.",
  "metadata": { "team": "support" },
  "updated_at": "2026-10-06T14:56:39Z",
  "version": 1
}

​

Response

• id, text, metadata: The document.
• updated_at: When it was last written, in UTC, to the second. An unchanged write leaves it as it was.
• version: Its version.
• user: Its user. Left out if it has none.
• seq: Its sequence number. Left out if it has none.

​

List documents

curl "https://api.conare.ai/namespaces/docs/documents?limit=100" \
  -H "Authorization: Bearer $CONARE_API_KEY"

for await (const doc of docs.list()) {
  console.log(doc.id, doc.version);
}

{
  "documents": [
    {
      "id": "refunds",
      "metadata": { "team": "support" },
      "updated_at": "2026-10-06T14:56:39Z",
      "version": 1
    },
    {
      "id": "shipping",
      "metadata": { "team": "ops" },
      "updated_at": "2026-10-06T14:56:39Z",
      "version": 1
    }
  ],
  "next_cursor": null
}

​

Request

• limit (integer, default 50): Documents per page, 1-100.
• cursor (string): The previous page’s next_cursor.

​

Response

• documents: The page: each document as Get returns it, without text.
• next_cursor: Pass it as cursor for the next page. null on the last page.