API reference · Knowledge

Get a document

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

Returns one document and the questions and answers that were taken from it.

Needs a workspace API key.

Path parameters

idstringRequired

The document’s ID, such as kd_4b1f0c9d2e7a6f53.

Errors

404

No document in your workspace has that ID.

Every request can also answer 401, 429 and 500: see Errors.

Notes

  • GET /v1/knowledge/documents/:id/file returns the uploaded file itself, when it was kept.
curl "https://goblins-call-api.onrender.com/v1/knowledge/documents/kd_4b1f0c9d2e7a6f53" \
  -H "Authorization: Bearer $CRACKLE_API_KEY"
Response · 200 OK
{
  "document": { "id": "kd_4b1f0c9d2e7a6f53", "status": "ready", "cardCount": 6, … },
  "cards": [
    {
      "question": "How long does a refund take?",
      "answer": "A refund for a cancelled order is paid within seven working days to the card that was used."
    }
  ]
}