API reference · Knowledge

List documents

GEThttps://goblins-call-api.onrender.com/v1/knowledge/documents

Returns your workspace’s documents, newest first.

Needs a workspace API key.

Query parameters

userIdstringOptional

A workspace ID. A key belongs to one workspace, so this is never needed with one; naming another workspace answers 403.

curl "https://goblins-call-api.onrender.com/v1/knowledge/documents" \
  -H "Authorization: Bearer $CRACKLE_API_KEY"
Response · 200 OK
{
  "documents": [
    {
      "id": "kd_4b1f0c9d2e7a6f53",
      "name": "Refund policy",
      "status": "ready",
      "summary": "The shop’s refund and cancellation rules.",
      "topics": ["refunds", "cancellations"],
      "cardCount": 6,
      …
    }
  ]
}