ANanam
Knowledge

get knowledge document

Changed on

Get a single document by ID

get/v1/knowledge/documents/{id}

Request

  • Base URL
    https://api.anam.ai
  • URL
    https://api.anam.ai/v1/knowledge/documents/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Unique identifier of the knowledge document

Response

Successfully retrieved document

idstring uuid

Unique identifier for the document.

knowledgeFolderIdstring uuid

ID of the knowledge group this document belongs to.

filenamestring

Original filename as uploaded.

fileTypestring

MIME type or extension-derived file type.

fileSizeinteger

Size of the file in bytes.

fileUrlstring uri

Internal URL at which the file is stored.

status'UPLOADED' | 'PROCESSING' | 'READY' | 'FAILED'

Current processing state. Only READY documents are searchable.

errorMessagestring nullable

Failure reason when status is FAILED, otherwise null.

chunkSizeinteger nullable

Chunk size override set at upload, in tokens; null when not overridden. When both chunkSize and chunkOverlap are null, the document uses its group's settings. When only chunkOverlap is set, a null chunkSize means the default of 350.

chunkOverlapinteger nullable

Chunk overlap override set at upload, in tokens; null when not overridden. When both chunkSize and chunkOverlap are null, the document uses its group's settings. When only chunkSize is set, a null chunkOverlap means the default of 0.

createdAtstring date-time

Timestamp when the document was uploaded.

updatedAtstring date-time nullable

Timestamp when the document record was last updated.

Changes

  • e85ef0cd491eRevision changes
    • info

      added the non-success response with the status

  • 06b431316195Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status