Skip to main content

Get Document

Retrieve a document by ID.

GET /v1/documents/:id

Path Parameters

ParameterTypeDescription
idstringDocument ID

Query Parameters

ParameterTypeDefaultDescription
versionintegerlatestSpecific version to retrieve
include_contentbooleantrueInclude document content

Example Request

curl https://api.inherent.systems/v1/documents/doc_abc123 \
-H "Authorization: Bearer $INHERENT_API_KEY"

Response

{
"id": "doc_abc123",
"version": 3,
"status": "completed",
"content": "# API Authentication\n\nAll API requests require...",
"metadata": {
"title": "API Authentication Guide",
"category": "documentation",
"version": "2.0"
},
"stats": {
"chunks": 24,
"tokens": 8192,
"size_bytes": 32768
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-18T14:20:00Z"
}

Get Specific Version

curl "https://api.inherent.systems/v1/documents/doc_abc123?version=2" \
-H "Authorization: Bearer $INHERENT_API_KEY"

Response Fields

FieldTypeDescription
idstringDocument ID
versionintegerDocument version
statusstringProcessing status
contentstringFull document content
metadataobjectDocument metadata
stats.chunksintegerNumber of chunks
stats.tokensintegerTotal tokens
stats.size_bytesintegerContent size
created_atdatetimeCreation timestamp
updated_atdatetimeLast update timestamp

Errors

CodeDescription
404Document not found
404Version not found