All pages

API reference

Get a source

GET /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}

View as Markdown

One source, and where it is in indexing — read it again until it says indexed or failed. Needs knowledge:read.

Parameters

Name In Type Required Description
knowledge_base_id path string (uuid) Yes
document_id path string (uuid) Yes

Answer

200 with KnowledgeDocument.

Errors

Every error is a problem document with a stable code.

Status When
401 The key is missing, mistyped, unknown, revoked or expired.
403 The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something.
404 This key reaches no such source.
422 Validation Error
429 Too many requests for this key or its organization; see Retry-After.
500 Something went wrong on our side. Quote the request_id to support.

Examples

Read a source's indexing status
#!/bin/sh
# Read a source's indexing status
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/knowledge-bases/6e8a0c2d-4f6b-4d8e-a0c2-4e6a8c0e2a4c/documents/7f9b1d3e-5a7c-4e9f-b1d3-5f7b9d1f3b5d" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY"

Try it

Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.