Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

Body

Request serializer for adding tags to a file.

tags
integer[]
required

List of tag IDs to add to the file

Minimum array length: 1

Response

Tags added successfully

id
integer
required
read-only
filename
string
required
read-only

Filename of the document

workspace
object | null
required

Workspace the document belongs to

summaries
object[]
required
read-only

Document summaries (all languages)

extension
string
required

File extension of the document

created_at
string<date-time>
required

Creation date of the resource

updated_at
string<date-time>
required
read-only
total_pages
integer
required
read-only

Total number of pages

size
integer | null
required
read-only

Size of the file in bytes.

tags
object[]
required
read-only

List of tags associated with the document

created_by
object | null
required

User who created the file. Null when the file was created by the system.

upload_session_uuid
string<uuid> | null
required
read-only

Upload session UUID associated with this document

signature
string | null
required
read-only

TLSH hash for duplicate detection.

external_metadata
object
required

External document metadata

title
string | null
Maximum string length: 255
status
enum<string>
  • pending - Pending
  • parsing - Parsing
  • parsing_failed - Parsing Failed
  • embedding - Embedding
  • embedding_failed - Embedding Failed
  • embedded - Embedded
  • fail - Fail
  • updating - Updating
Available options:
pending,
parsing,
parsing_failed,
embedding,
embedding_failed,
embedded,
fail,
updating
status_vision
enum<string>
  • pending - Pending
  • processing - Processing
  • embedded - Embedded
  • fail - Fail
  • - - Not available
Available options:
pending,
processing,
embedded,
fail,
-
content
string | null

Full text content of the document. Only included when include_content=true query parameter is provided.

status_detail
string | null

Detailed error information. Only present when document processing has failed.

parser
string | null

Parser/ingestion pipeline used for document processing (e.g., 'v2.1', 'v3.0').