AimableDocs
DocsAPI ReferenceRelease Notes
GET/v1/knowledge/thumbnail

Get Thumbnail

Generate a thumbnail image of a specific page from a document. Tenant-scoped: the `file_path`'s first segment is the collection_id and must belong to the caller's tenant. Without this check, any authenticated user could render any tenant's documents.

Query Parameters

NameTypeRequiredDescription
file_pathstringRequired
pageintegerOptional
Default: 1
widthintegerOptional
Default: 300

Headers

NameTypeRequiredDescription
X-API-KeystringOptional
Authentication
X-API-Key: ak.<key_id>.<secret>Authentication & errors →

Request

curl -X GET '/api/v1/knowledge/thumbnail' \
  -H 'X-API-Key: ak.<key_id>.<secret>'

Response

200

No response body documented

Error Responses