User who created the file. Null when the file was created by the system.
Show child attributes
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.
content_types
object[]
required
read-only
Facet content types with nested attribute values. Excludable via ?exclude=content_types.
Show child attributes
thumbnail
object
required
Thumbnail preview of the document (256x256 WebP).
Show child attributes
pending_reprocess
enum<string> | null
required
The reprocessing level queued for this document, or null when none is. Non-null means work has been accepted but has not started yet — status and status_vision still describe the previous run. It clears the moment processing starts, from which point the statuses track the new run. update (a file replacement) additionally leaves the file-derived fields (filename, extension, size, total_pages, signature, summaries, content) describing the previous file until then.
Available options:
reparse,
rechunk,
reembed,
reembed_vision,
update
title
string | null
Maximum string length: 255
status
enum<string>
pending - Pending
pending_conversion - Pending Conversion
converting - Converting
parsing - Parsing
parsing_failed - Parsing Failed
embedding - Embedding
embedding_failed - Embedding Failed
embedded - Embedded
parsed - Parsed
fail - Fail
updating - Updating
Available options:
pending,
pending_conversion,
converting,
parsing,
parsing_failed,
embedding,
embedding_failed,
embedded,
parsed,
fail,
updating
status_vision
enum<string>
pending - Pending
processing - Processing
embedded - Embedded
fail - Fail
- - Not available
Available options:
pending,
processing,
embedded,
fail,
-
size
integer | null
read-only
Size of the file in bytes.
content
string | null
deprecated
read-only
Deprecated — use pages[] instead. Full text content of the document, derived from per-page text, as a single flat string. Only included when include_content=true query parameter is provided. Will be removed in a future release.
pages
object[]
read-only
Per-page document text in the canonical { index, markdown } shape shared with /parse and /ocr. Only included when include_content=true. Intended replacement for the flat content string. For documents ingested before per-page text was stored, the full content is returned as a single page (index 1); empty only when there is no content at all.
Show child attributes
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').
external_metadata
object | null
External document metadata
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"LightOn Developers","colors":{"primary":"#1f99bb","light":"#1f99bb","dark":"#1f99bb"},"logo":{"light":"https://mintcdn.com/lighton-developers/dojq_qF_vSGGGm4-/logo/light.svg?fit=max\u0026auto=format\u0026n=dojq_qF_vSGGGm4-\u0026q=85\u0026s=345d3b10124f99971a7737a9f06f2886","dark":"https://mintcdn.com/lighton-developers/dojq_qF_vSGGGm4-/logo/dark.svg?fit=max\u0026auto=format\u0026n=dojq_qF_vSGGGm4-\u0026q=85\u0026s=d1c2d4800c07667359bb3abf2437e7aa"},"favicon":"https://mintcdn.com/lighton-developers/p54dDELPycbNT9ym/favicon.svg?fit=max\u0026auto=format\u0026n=p54dDELPycbNT9ym\u0026q=85\u0026s=c9a4897b47f6d0e0d035509f82d5c847","navbar":{"primary":{"type":"button","label":"Console","href":"https://console.lighton.ai"}},"footer":{"socials":{"x":"https://x.com/lightonio","linkedin":"https://www.linkedin.com/company/lighton","bluesky":"https://bsky.app/profile/lightonai.bsky.social","youtube":"https://www.youtube.com/@lighton4013","website":"https://lighton.ai/newsletter"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Playground","icon":"circle-play","href":"https://console.lighton.ai"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lighton-developers","hasAudioNarration":false,"actualSubdomain":"lighton-developers","customDomains":["developers.lighton.ai"],"gitSource":{"type":"github","owner":"lightonai","repo":"lighton-developers-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae0d933663d8e17af01bd02","clientVersion":"0.0.4263","searchFilterCounts":[{"language":"default","tag":"API Reference","count":50},{"language":"default","tag":"Intelligence","count":30},{"language":"default","tag":"Tutorials","count":15},{"language":"default","tag":"Facets","count":14},{"language":"default","tag":"Administration","count":13},{"language":"default","tag":"MCP Server","count":9},{"language":"default","tag":"Integrations","count":8},{"language":"default","tag":"Classify and organise documents","count":8},{"language":"default","tag":"Workspaces","count":8},{"language":"default","tag":"Budget","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@lighton.ai"}},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/files/add-tags-to-a-file","slug":"/api-reference/files/add-tags-to-a-file","pageMetadata":{"title":"Add tags to a file","description":"Add one or more tags to a file without affecting existing tags.\n\n**Behavior:**\n- Adds new tags to the document while preserving existing ones\n- New tags are marked as manually assigned (`auto_assigned=False`)\n- Duplicate tags are ignored (no error if tag already exists on document)\n\n**Validation:**\n- Returns 400 if tag IDs are invalid or don't belong to user's company\n- Returns 403 if user doesn't have permission to edit the document\n- Returns 404 if document doesn't exist\n","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/files/{id}/tags","href":"/api-reference/files/add-tags-to-a-file","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Add one or more tags to a file without affecting existing tags.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Behavior:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Adds new tags to the document while preserving existing ones\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"New tags are marked as manually assigned (\", _jsx(_components.code, {\n children: \"auto_assigned=False\"\n }), \")\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"Duplicate tags are ignored (no error if tag already exists on document)\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Validation:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Returns 400 if tag IDs are invalid or don’t belong to user’s company\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Returns 403 if user doesn’t have permission to edit the document\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Returns 404 if document doesn’t exist\"\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Add tags to a file","description":"Add one or more tags to a file without affecting existing tags.\n\n**Behavior:**\n- Adds new tags to the document while preserving existing ones\n- New tags are marked as manually assigned (`auto_assigned=False`)\n- Duplicate tags are ignored (no error if tag already exists on document)\n\n**Validation:**\n- Returns 400 if tag IDs are invalid or don't belong to user's company\n- Returns 403 if user doesn't have permission to edit the document\n- Returns 404 if document doesn't exist\n","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/files/{id}/tags","href":"/api-reference/files/add-tags-to-a-file","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"api_v3_files_tags_create","description":"Add one or more tags to a file without affecting existing tags.\n\n**Behavior:**\n- Adds new tags to the document while preserving existing ones\n- New tags are marked as manually assigned (`auto_assigned=False`)\n- Duplicate tags are ignored (no error if tag already exists on document)\n\n**Validation:**\n- Returns 400 if tag IDs are invalid or don't belong to user's company\n- Returns 403 if user doesn't have permission to edit the document\n- Returns 404 if document doesn't exist\n","summary":"Add tags to a file","parameters":["eafcdfb7-2af1-43f2-9dbd-5993c07cc1fa"],"tags":["Files"],"requestBody":"c4c21606-a3d9-44da-8d0e-c0dc37adec28","security":["309de372-c517-4027-bdbe-93e08164b876"],"responses":{"200":"4c312fd2-ccc8-4a67-ad8e-94157f24e908","401":"719c3e2c-5e41-421f-a6ad-c7a72fe88585","403":"1b624481-1515-4712-9b77-2f18f1e6595c","404":"5fe3ffed-7a19-4cd3-ab6b-a030f92b94d1","422":"7e53e3e6-53df-4397-8009-537685141adf","503":"ad6709df-8c04-444b-9f45-ba3528f70da7"},"method":"post","type":"path","servers":["48c3fa0c-537e-4ab8-b62c-fc02ab11f431"],"path":"/api/v3/files/{id}/tags","baseUrlOptions":["https://api.lighton.ai"],"title":"Add tags to a file","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"eafcdfb7-2af1-43f2-9dbd-5993c07cc1fa":{"in":"path","name":"id","schema":{"type":"integer","isRequired":true,"uniqueKey":"","typeLabel":"integer"},"required":true}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Request serializer for adding tags to a file.","properties":{"tags":{"type":"array","items":{"type":"integer","uniqueKey":"tags.items.[INDEX]","typeLabel":"integer"},"description":"List of tag IDs to add to the file","minItems":1,"isRequired":true,"uniqueKey":"tags","typeLabel":"integer[]"}},"required":["tags"],"uniqueKey":"","typeLabel":"object"},"examples":{"AddSingleTag":{"title":"AddSingleTag","summary":"Add single tag","description":"Add one tag to a file","value":{"tags":[1]}},"AddMultipleTags":{"title":"AddMultipleTags","summary":"Add multiple tags","description":"Add multiple tags to a file at once","value":{"tags":[1,2]}}},"exampleType":"examples"},"application/x-www-form-urlencoded":{"schema":{"type":"object","description":"Request serializer for adding tags to a file.","properties":{"tags":{"type":"array","items":{"type":"integer","uniqueKey":"tags.items.[INDEX]","typeLabel":"integer"},"description":"List of tag IDs to add to the file","minItems":1,"isRequired":true,"uniqueKey":"tags","typeLabel":"integer[]"}},"required":["tags"],"uniqueKey":"","typeLabel":"object"},"examples":{"AddSingleTag":{"title":"AddSingleTag","summary":"Add single tag","description":"Add one tag to a file","value":{"tags":[1]}},"AddMultipleTags":{"title":"AddMultipleTags","summary":"Add multiple tags","description":"Add multiple tags to a file at once","value":{"tags":[1,2]}}},"exampleType":"examples"},"multipart/form-data":{"schema":{"type":"object","description":"Request serializer for adding tags to a file.","properties":{"tags":{"type":"array","items":{"type":"integer","uniqueKey":"tags.items.[INDEX]","typeLabel":"integer"},"description":"List of tag IDs to add to the file","minItems":1,"isRequired":true,"uniqueKey":"tags","typeLabel":"integer[]"}},"required":["tags"],"uniqueKey":"","typeLabel":"object"},"examples":{"AddSingleTag":{"title":"AddSingleTag","summary":"Add single tag","description":"Add one tag to a file","value":{"tags":[1]}},"AddMultipleTags":{"title":"AddMultipleTags","summary":"Add multiple tags","description":"Add multiple tags to a file at once","value":{"tags":[1,2]}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"4c312fd2-ccc8-4a67-ad8e-94157f24e908":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"isRequired":true,"uniqueKey":"id","typeLabel":"integer"},"filename":{"type":"string","readOnly":true,"description":"Filename of the document","isRequired":true,"uniqueKey":"filename","typeLabel":"string"},"workspace":{"oneOf":[{"type":"object","description":"Workspace the document belongs to","required":["id","name","workspace_type"],"properties":{"id":{"type":"integer","description":"Workspace ID","isRequired":true,"uniqueKey":"workspace.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","description":"Workspace name","isRequired":true,"uniqueKey":"workspace.oneOf.0.name","typeLabel":"string"},"workspace_type":{"type":"string","description":"Workspace type (shared or personal)","isRequired":true,"uniqueKey":"workspace.oneOf.0.workspace_type","typeLabel":"string"}},"isRequired":true,"uniqueKey":"workspace.oneOf.0","typeLabel":"object"},{"type":"null","description":"Workspace the document belongs to","isRequired":true,"uniqueKey":"workspace.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"workspace","typeLabel":"object | null"},"summaries":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string","description":"Summary of the document.","isRequired":true,"uniqueKey":"summaries.items.[INDEX].summary","typeLabel":"string"},"language":{"type":"string","description":"Language of the summary.\n\n* `en` - English\n* `fr` - French\n* `es` - Spanish\n* `it` - Italian\n* `ar` - Arabic\n* `nl` - Dutch\n* `sv` - Swedish\n* `de` - German\n* `ja` - Japanese\n* `zh` - Chinese\n* `ko` - Korean","enum":["en","fr","es","it","ar","nl","sv","de","ja","zh","ko"],"uniqueKey":"summaries.items.[INDEX].language","typeLabel":"enum\u003cstring>"}},"required":["summary"],"uniqueKey":"summaries.items.[INDEX]","typeLabel":"object"},"readOnly":true,"description":"Document summaries (all languages)","isRequired":true,"uniqueKey":"summaries","typeLabel":"object[]"},"extension":{"type":"string","description":"File extension of the document","isRequired":true,"uniqueKey":"extension","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"Creation date of the resource","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"total_pages":{"type":"integer","readOnly":true,"description":"Total number of pages","isRequired":true,"uniqueKey":"total_pages","typeLabel":"integer"},"tags":{"type":"array","items":{"type":"object","description":"Serializer for tag items in file list response.","properties":{"id":{"type":"integer","description":"Tag ID","isRequired":true,"uniqueKey":"tags.items.[INDEX].id","typeLabel":"integer"},"name":{"type":"string","description":"Tag name","isRequired":true,"uniqueKey":"tags.items.[INDEX].name","typeLabel":"string"},"auto_assigned":{"type":"boolean","description":"True if this tag was automatically assigned by the system, False if manually assigned by a user","isRequired":true,"uniqueKey":"tags.items.[INDEX].auto_assigned","typeLabel":"boolean"}},"required":["auto_assigned","id","name"],"uniqueKey":"tags.items.[INDEX]","typeLabel":"object"},"readOnly":true,"description":"List of tags associated with the document","isRequired":true,"uniqueKey":"tags","typeLabel":"object[]"},"created_by":{"oneOf":[{"type":"object","description":"User who created the file. Null when the file was created by the system.","required":["first_name","id","last_name","username"],"properties":{"id":{"type":"integer","description":"User ID","isRequired":true,"uniqueKey":"created_by.oneOf.0.id","typeLabel":"integer"},"first_name":{"type":"string","description":"First name","isRequired":true,"uniqueKey":"created_by.oneOf.0.first_name","typeLabel":"string"},"last_name":{"type":"string","description":"Last name","isRequired":true,"uniqueKey":"created_by.oneOf.0.last_name","typeLabel":"string"},"username":{"type":"string","description":"Username","isRequired":true,"uniqueKey":"created_by.oneOf.0.username","typeLabel":"string"}},"isRequired":true,"uniqueKey":"created_by.oneOf.0","typeLabel":"object"},{"type":"null","description":"User who created the file. Null when the file was created by the system.","isRequired":true,"uniqueKey":"created_by.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"created_by","typeLabel":"object | null"},"upload_session_uuid":{"oneOf":[{"type":"string","format":"uuid","readOnly":true,"description":"Upload session UUID associated with this document","isRequired":true,"uniqueKey":"upload_session_uuid.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","readOnly":true,"description":"Upload session UUID associated with this document","isRequired":true,"uniqueKey":"upload_session_uuid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"upload_session_uuid","typeLabel":"string\u003cuuid> | null"},"signature":{"oneOf":[{"type":"string","readOnly":true,"description":"TLSH hash for duplicate detection.","isRequired":true,"uniqueKey":"signature.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"description":"TLSH hash for duplicate detection.","isRequired":true,"uniqueKey":"signature.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"signature","typeLabel":"string | null"},"content_types":{"type":"array","items":{"type":"object","description":"OpenAPI schema for compact content type response (Tier 1 — list default).","properties":{"path":{"type":"string","description":"Colon-separated content type path (e.g. legal:contract:nda)","isRequired":true,"uniqueKey":"content_types.items.[INDEX].path","typeLabel":"string"},"label":{"type":"string","description":"User-readable label (leaf node)","isRequired":true,"uniqueKey":"content_types.items.[INDEX].label","typeLabel":"string"},"attribute_values":{"type":"object","additionalProperties":{"type":"object","description":"OpenAPI schema for a compact attribute value entry.","properties":{"value":{"description":"Attribute value (type depends on attribute definition)","isRequired":true,"uniqueKey":"content_types.items.[INDEX].attribute_values.additionalProperties.value","typeLabel":"any"},"type":{"type":"string","description":"Attribute type (text, number, date, boolean, select, multi_select)","isRequired":true,"uniqueKey":"content_types.items.[INDEX].attribute_values.additionalProperties.type","typeLabel":"string"},"label":{"type":"string","description":"User-readable attribute label (present when include_details=true)","uniqueKey":"content_types.items.[INDEX].attribute_values.additionalProperties.label","typeLabel":"string"}},"required":["type","value"],"uniqueKey":"content_types.items.[INDEX].attribute_values.additionalProperties","typeLabel":"object"},"description":"Map of attribute name to {value, type}. Only present when include_details=true.","uniqueKey":"content_types.items.[INDEX].attribute_values","typeLabel":"object"}},"required":["label","path"],"uniqueKey":"content_types.items.[INDEX]","typeLabel":"object"},"readOnly":true,"description":"Facet content types with nested attribute values. Excludable via ?exclude=content_types.","isRequired":true,"uniqueKey":"content_types","typeLabel":"object[]"},"thumbnail":{"type":"object","description":"Thumbnail preview of the document (256x256 WebP).","required":["status","url"],"properties":{"status":{"type":"string","description":"Thumbnail generation status: MISSING (not available), PROCESSING (being generated), READY (available)\n\n* `MISSING` - MISSING\n* `PROCESSING` - PROCESSING\n* `READY` - READY","enum":["MISSING","PROCESSING","READY"],"isRequired":true,"uniqueKey":"thumbnail.status","typeLabel":"enum\u003cstring>"},"url":{"oneOf":[{"type":"string","description":"Relative URL to the thumbnail image (WebP, 256x256). Null when status is not READY.","isRequired":true,"uniqueKey":"thumbnail.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Relative URL to the thumbnail image (WebP, 256x256). Null when status is not READY.","isRequired":true,"uniqueKey":"thumbnail.url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"thumbnail.url","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"thumbnail","typeLabel":"object"},"pending_reprocess":{"oneOf":[{"type":"string","description":"The reprocessing level queued for this document, or null when none is. Non-null means work has been accepted but has not started yet — `status` and `status_vision` still describe the previous run. It clears the moment processing starts, from which point the statuses track the new run. `update` (a file replacement) additionally leaves the file-derived fields (`filename`, `extension`, `size`, `total_pages`, `signature`, `summaries`, `content`) describing the previous file until then.","enum":["reparse","rechunk","reembed","reembed_vision","update"],"isRequired":true,"uniqueKey":"pending_reprocess.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The reprocessing level queued for this document, or null when none is. Non-null means work has been accepted but has not started yet — `status` and `status_vision` still describe the previous run. It clears the moment processing starts, from which point the statuses track the new run. `update` (a file replacement) additionally leaves the file-derived fields (`filename`, `extension`, `size`, `total_pages`, `signature`, `summaries`, `content`) describing the previous file until then.","isRequired":true,"uniqueKey":"pending_reprocess.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"pending_reprocess","typeLabel":"enum\u003cstring> | null"},"title":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"enum":["pending","pending_conversion","converting","parsing","parsing_failed","embedding","embedding_failed","embedded","parsed","fail","updating"],"type":"string","description":"* `pending` - Pending\n* `pending_conversion` - Pending Conversion\n* `converting` - Converting\n* `parsing` - Parsing\n* `parsing_failed` - Parsing Failed\n* `embedding` - Embedding\n* `embedding_failed` - Embedding Failed\n* `embedded` - Embedded\n* `parsed` - Parsed\n* `fail` - Fail\n* `updating` - Updating","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"status_vision":{"enum":["pending","processing","embedded","fail","-"],"type":"string","description":"* `pending` - Pending\n* `processing` - Processing\n* `embedded` - Embedded\n* `fail` - Fail\n* `-` - Not available","uniqueKey":"status_vision","typeLabel":"enum\u003cstring>"},"size":{"oneOf":[{"type":"integer","readOnly":true,"description":"Size of the file in bytes.","uniqueKey":"size.oneOf.0","typeLabel":"integer"},{"type":"null","readOnly":true,"description":"Size of the file in bytes.","uniqueKey":"size.oneOf.1","typeLabel":"null"}],"uniqueKey":"size","typeLabel":"integer | null"},"content":{"oneOf":[{"type":"string","deprecated":true,"readOnly":true,"description":"Deprecated — use `pages[]` instead. Full text content of the document, derived from per-page text, as a single flat string. Only included when include_content=true query parameter is provided. Will be removed in a future release.","uniqueKey":"content.oneOf.0","typeLabel":"string"},{"type":"null","deprecated":true,"readOnly":true,"description":"Deprecated — use `pages[]` instead. Full text content of the document, derived from per-page text, as a single flat string. Only included when include_content=true query parameter is provided. Will be removed in a future release.","uniqueKey":"content.oneOf.1","typeLabel":"null"}],"uniqueKey":"content","typeLabel":"string | null"},"pages":{"type":"array","items":{"type":"object","description":"Canonical per-page document text object.\n\nOriginates with /parse and is reused by /ocr and /files (the latter imports it\nfrom here) so a client can switch between live parsing and reading an\nalready-ingested file without reshaping page data. Defined once and reused\neverywhere — never redefine this shape per app.\n\nExtensible: future per-page fields (tables, images, confidence, ...) can be\nadded here without breaking callers that only consume ``index`` + ``markdown``.","properties":{"index":{"type":"integer","description":"Page number within the document (1-based).","isRequired":true,"uniqueKey":"pages.items.[INDEX].index","typeLabel":"integer"},"markdown":{"type":"string","description":"Page text rendered as Markdown.","isRequired":true,"uniqueKey":"pages.items.[INDEX].markdown","typeLabel":"string"}},"required":["index","markdown"],"uniqueKey":"pages.items.[INDEX]","typeLabel":"object"},"readOnly":true,"description":"Per-page document text in the canonical `{ index, markdown }` shape shared with /parse and /ocr. Only included when include_content=true. Intended replacement for the flat `content` string. For documents ingested before per-page text was stored, the full `content` is returned as a single page (index 1); empty only when there is no content at all.","uniqueKey":"pages","typeLabel":"object[]"},"status_detail":{"oneOf":[{"type":"string","description":"Detailed error information. Only present when document processing has failed.","uniqueKey":"status_detail.oneOf.0","typeLabel":"string"},{"type":"null","description":"Detailed error information. Only present when document processing has failed.","uniqueKey":"status_detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"status_detail","typeLabel":"string | null"},"parser":{"oneOf":[{"type":"string","description":"Parser/ingestion pipeline used for document processing (e.g., 'v2.1', 'v3.0'). ","uniqueKey":"parser.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parser/ingestion pipeline used for document processing (e.g., 'v2.1', 'v3.0'). ","uniqueKey":"parser.oneOf.1","typeLabel":"null"}],"uniqueKey":"parser","typeLabel":"string | null"},"external_metadata":{"oneOf":[{"type":"object","description":"External document metadata","required":["additional_metadata","doc_type","external_id"],"properties":{"external_id":{"type":"string","description":"External document ID","isRequired":true,"uniqueKey":"external_metadata.oneOf.0.external_id","typeLabel":"string"},"doc_type":{"type":"string","description":"External document type","isRequired":true,"uniqueKey":"external_metadata.oneOf.0.doc_type","typeLabel":"string"},"additional_metadata":{"description":"Additional metadata associated with the document","isRequired":true,"uniqueKey":"external_metadata.oneOf.0.additional_metadata","typeLabel":"any"}},"uniqueKey":"external_metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"External document metadata","uniqueKey":"external_metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_metadata","typeLabel":"object | null"}},"required":["content_types","created_at","created_by","extension","filename","id","pending_reprocess","signature","summaries","tags","thumbnail","total_pages","updated_at","upload_session_uuid","workspace"],"uniqueKey":"","typeLabel":"object"},"examples":{"TagsAddedSuccessfully":{"title":"TagsAddedSuccessfully","summary":"Tags added successfully","value":{"id":123,"filename":"project_proposal.pdf","workspace":{"id":1,"name":"Engineering Team"},"summaries":[{"language":"en","summary":"This document outlines Q4 initiatives..."}],"title":"Q4 Project Proposal","extension":"pdf","status":"embedded","status_vision":"embedded","created_at":"2024-01-15T10:30:00Z","updated_at":"2024-01-15T11:45:00Z","total_pages":25,"size":2458624,"tags":[{"id":1,"name":"Compliance","auto_assigned":false},{"id":2,"name":"Legal","auto_assigned":false}],"created_by":{"id":42,"first_name":"Jane","last_name":"Doe","username":"jdoe"},"signature":"T1A1B2C3D4E5F6G7H8I9J0K1L2M3N4O5P6Q7R8S9T0U1V2W3X4Y5Z6A7B8C9D0E1F2","parser":"v2.2.1","message":"Added 2 tag(s) to file (duplicates ignored)"}}},"exampleType":"examples"}},"description":"Tags added successfully","exampleType":"examples"},"719c3e2c-5e41-421f-a6ad-c7a72fe88585":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"id","typeLabel":"string | null"},"code":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"error":{"type":"string","description":"Error code used by the UI as a translation key","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable error message for developers","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"doc_url":{"type":"string","description":"Link to the error-code documentation page","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string"}},"required":["code","detail","doc_url","error","id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Unauthorized":{"title":"Unauthorized","value":{"id":null,"code":401,"error":"unauthorized","detail":"Authentication credentials were not provided or are invalid.","doc_url":"https://developers.lighton.ai/errors#unauthorized"}}},"exampleType":"examples"}},"description":"Authentication credentials were not provided or are invalid","exampleType":"examples"},"1b624481-1515-4712-9b77-2f18f1e6595c":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"id","typeLabel":"string | null"},"code":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"error":{"type":"string","description":"Error code used by the UI as a translation key","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable error message for developers","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"doc_url":{"type":"string","description":"Link to the error-code documentation page","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string"}},"required":["code","detail","doc_url","error","id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Forbidden":{"title":"Forbidden","value":{"id":null,"code":403,"error":"insufficient_permissions","detail":"You do not have permission to perform this action.","doc_url":"https://developers.lighton.ai/errors#insufficient_permissions"}}},"exampleType":"examples"}},"description":"Insufficient permissions","exampleType":"examples"},"5fe3ffed-7a19-4cd3-ab6b-a030f92b94d1":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"id","typeLabel":"string | null"},"code":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"error":{"type":"string","description":"Error code used by the UI as a translation key","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable error message for developers","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"doc_url":{"type":"string","description":"Link to the error-code documentation page","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string"}},"required":["code","detail","doc_url","error","id"],"uniqueKey":"","typeLabel":"object"},"examples":{"NotFound":{"title":"NotFound","summary":"Not Found","value":{"id":null,"code":404,"error":"not_found","detail":"The requested resource was not found.","doc_url":"https://developers.lighton.ai/errors#not_found"}}},"exampleType":"examples"}},"description":"The requested resource was not found","exampleType":"examples"},"7e53e3e6-53df-4397-8009-537685141adf":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Job/resource id when one already exists (useful for async error diagnosis); null otherwise.","isRequired":true,"uniqueKey":"id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"id","typeLabel":"string | null"},"code":{"type":"integer","description":"HTTP status code","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"error":{"type":"string","description":"Error code used by the UI as a translation key","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable error message for developers","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"doc_url":{"type":"string","description":"Link to the error-code documentation page","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string"},"fields":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"error":{"type":"string","description":"Error code / translation key","isRequired":true,"uniqueKey":"fields.additionalProperties.items.[INDEX].error","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable description of the field error","isRequired":true,"uniqueKey":"fields.additionalProperties.items.[INDEX].detail","typeLabel":"string"}},"required":["detail","error"],"uniqueKey":"fields.additionalProperties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fields.additionalProperties","typeLabel":"object[]"},"description":"Field-level validation errors keyed by field name","uniqueKey":"fields","typeLabel":"object"}},"required":["code","detail","doc_url","error","id"],"uniqueKey":"","typeLabel":"object"},"examples":{"ValidationError":{"title":"ValidationError","summary":"Validation Error","value":{"id":null,"code":422,"error":"validation_error","detail":"One or more fields failed validation.","doc_url":"https://developers.lighton.ai/errors#validation_error","fields":{"\u003cfield_name>":[{"error":"required","detail":"This field is required."}]}}}},"exampleType":"examples"}},"description":"Request body is valid JSON but one or more fields failed validation","exampleType":"examples"},"ad6709df-8c04-444b-9f45-ba3528f70da7":{"description":"API is under maintenance. Check `GET /api/v3/system/status` for active periods and retry.","content":{"application/json":{"schema":{"type":"object","description":"Returned by the maintenance middleware when the requested endpoint is blocked.","required":["detail","error","mode"],"properties":{"detail":{"type":"string","example":"System is under maintenance.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"error":{"type":"string","example":"service_maintenance","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"mode":{"type":"string","enum":["full_shutdown","warning_banner"],"description":"`full_shutdown` blocks all traffic; `warning_banner` also blocks and shows a dismissible toast.","isRequired":true,"uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","description":"Operator-supplied maintenance reason, if any.","uniqueKey":"reason","typeLabel":"string"},"started_at":{"type":"string","format":"date-time","uniqueKey":"started_at","typeLabel":"string\u003cdate-time>"},"endpoint_category_names":{"type":"array","items":{"type":"string","uniqueKey":"endpoint_category_names.items.[INDEX]","typeLabel":"string"},"description":"Non-empty only for category-scoped periods. Empty means all endpoints are affected.","uniqueKey":"endpoint_category_names","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"System is under maintenance.","error":"service_maintenance","mode":"full_shutdown","reason":"\u003cstring>","started_at":"2023-11-07T05:31:56Z","endpoint_category_names":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"309de372-c517-4027-bdbe-93e08164b876":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","scopes":[]}}},"servers":{"48c3fa0c-537e-4ab8-b62c-fc02ab11f431":{"url":"https://api.lighton.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/api-console.yaml"},"subdomain":"lighton-developers","siteName":"LightOn Developers","title":"Add tags to a file - LightOn Developers","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-16T07:50:02.876Z","originalFileLocation":"api-reference/files/add-tags-to-a-file.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Add one or more tags to a file without affecting existing tags. Behavior: - Adds new tags to the document while preserving existing ones - New tags are marked as manually assigned (auto_assigned=False) - Duplicate tags are ignored (no error if tag already exists on document) Validation: - Returns 400 if tag IDs are invalid or don\u0026#x27;t belong to user\u0026#x27;s company - Returns 403 if user doesn\u0026#x27;t have permission to edit the document - Returns 404 if document doesn\u0026#x27;t exist\">\u003cmeta data-mint-head name=\"application-name\" content=\"LightOn Developers\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add tags to a file - LightOn Developers\">\u003cmeta data-mint-head property=\"og:description\" content=\"Add one or more tags to a file without affecting existing tags. Behavior: - Adds new tags to the document while preserving existing ones - New tags are marked as manually assigned (auto_assigned=False) - Duplicate tags are ignored (no error if tag already exists on document) Validation: - Returns 400 if tag IDs are invalid or don\u0026#x27;t belong to user\u0026#x27;s company - Returns 403 if user doesn\u0026#x27;t have permission to edit the document - Returns 404 if document doesn\u0026#x27;t exist\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"LightOn Developers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.lighton.ai/api-reference/files/add-tags-to-a-file\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lighton-developers.mintlify.site/_mintlify/api/og/v2?division=Tags\u0026amp;title=Add+tags+to+a+file\u0026amp;description=Add+one+or+more+tags+to+a+file+without+affecting+existing+tags.%0A%0A**Behavior%3A**%0A-+Adds+new+tags+to+the+document+while+preserving+existing+ones%0A-+New+tags+are+mar\u0026amp;theme=42de0de5beb070a7d2770d17\u0026amp;signature=e65962462e88454ea0a4d192046198c3c0aba5d09c2cf2d79f1c00dd18da7748\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Add tags to a file - LightOn Developers\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Add one or more tags to a file without affecting existing tags. Behavior: - Adds new tags to the document while preserving existing ones - New tags are marked as manually assigned (auto_assigned=False) - Duplicate tags are ignored (no error if tag already exists on document) Validation: - Returns 400 if tag IDs are invalid or don\u0026#x27;t belong to user\u0026#x27;s company - Returns 403 if user doesn\u0026#x27;t have permission to edit the document - Returns 404 if document doesn\u0026#x27;t exist\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lighton-developers.mintlify.site/_mintlify/api/og/v2?division=Tags\u0026amp;title=Add+tags+to+a+file\u0026amp;description=Add+one+or+more+tags+to+a+file+without+affecting+existing+tags.%0A%0A**Behavior%3A**%0A-+Adds+new+tags+to+the+document+while+preserving+existing+ones%0A-+New+tags+are+mar\u0026amp;theme=42de0de5beb070a7d2770d17\u0026amp;signature=e65962462e88454ea0a4d192046198c3c0aba5d09c2cf2d79f1c00dd18da7748\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/lighton-developers/2Zh9Mbvo5QQal47m/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"LightOn Developers\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1f99bb\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.lighton.ai/api-reference/files/add-tags-to-a-file\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/files/add-tags-to-a-file.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.lighton.ai/#organization\",\"name\":\"LightOn Developers\",\"url\":\"https://developers.lighton.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lighton-developers/dojq_qF_vSGGGm4-/logo/light.svg?fit=max\u0026auto=format\u0026n=dojq_qF_vSGGGm4-\u0026q=85\u0026s=345d3b10124f99971a7737a9f06f2886\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.lighton.ai#website\",\"name\":\"LightOn Developers\",\"url\":\"https://developers.lighton.ai\",\"publisher\":{\"@id\":\"https://developers.lighton.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.lighton.ai/api-reference/files/add-tags-to-a-file#webpage\",\"url\":\"https://developers.lighton.ai/api-reference/files/add-tags-to-a-file\",\"name\":\"Add tags to a file\",\"description\":\"Add one or more tags to a file without affecting existing tags. Behavior: - Adds new tags to the document while preserving existing ones - New tags are marked as manually assigned (auto_assigned=False) - Duplicate tags are ignored (no error if tag already exists on document) Validation: - Returns 400 if tag IDs are invalid or don't belong to user's company - Returns 403 if user doesn't have permission to edit the document - Returns 404 if document doesn't exist\",\"dateModified\":\"2026-09-16T07:50:02.876Z\",\"isPartOf\":{\"@id\":\"https://developers.lighton.ai#website\"},\"breadcrumb\":{\"@id\":\"https://developers.lighton.ai/api-reference/files/add-tags-to-a-file#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.lighton.ai/api-reference/files/add-tags-to-a-file#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Intelligence\",\"item\":\"https://developers.lighton.ai/api-reference/ask/ask-a-question-over-your-documents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Tags\",\"item\":\"https://developers.lighton.ai/api-reference/tags/list-all-tags-for-the-authenticated-users-company\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Add tags to a file\",\"item\":\"https://developers.lighton.ai/api-reference/files/add-tags-to-a-file\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.lighton.ai/api-reference/files/add-tags-to-a-file#apireference\",\"headline\":\"Add tags to a file\",\"name\":\"Add tags to a file\",\"description\":\"Add one or more tags to a file without affecting existing tags. Behavior: - Adds new tags to the document while preserving existing ones - New tags are marked as manually assigned (auto_assigned=False) - Duplicate tags are ignored (no error if tag already exists on document) Validation: - Returns 400 if tag IDs are invalid or don't belong to user's company - Returns 403 if user doesn't have permission to edit the document - Returns 404 if document doesn't exist\",\"url\":\"https://developers.lighton.ai/api-reference/files/add-tags-to-a-file\",\"mainEntityOfPage\":{\"@id\":\"https://developers.lighton.ai/api-reference/files/add-tags-to-a-file#webpage\"},\"dateModified\":\"2026-09-16T07:50:02.876Z\",\"publisher\":{\"@id\":\"https://developers.lighton.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.lighton.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"LightOn Developers\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"LightOn Developers\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/files/add-tags-to-a-file.md","siteName":"LightOn Developers","nav":{"global":{"anchors":[{"anchor":"Playground","icon":"circle-play","href":"https://console.lighton.ai"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/introduction"},{"title":"API Errors","href":"/api-reference/v3-error-codes"}]},{"group":"Intelligence","pages":[{"title":"Ask a question over your documents","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/ask","href":"/api-reference/ask/ask-a-question-over-your-documents"},{"title":"Search document chunks","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/search","href":"/api-reference/search/search-document-chunks"},{"group":"Files","pages":[{"title":"List files accessible to the authenticated user","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/files","href":"/api-reference/files/list-files-accessible-to-the-authenticated-user"},{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/files","href":"/api-reference/files/upload-a-file"},{"title":"Delete multiple files in a single request","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/files/bulk-delete","href":"/api-reference/files/delete-multiple-files-in-a-single-request"},{"title":"Retrieve a single file by ID","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/files/{id}","href":"/api-reference/files/retrieve-a-single-file-by-id"},{"title":"Update file metadata or replace its file","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml patch /api/v3/files/{id}","href":"/api-reference/files/update-file-metadata-or-replace-its-file"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml delete /api/v3/files/{id}","href":"/api-reference/files/delete-a-file"},{"title":"Download a document file","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/files/{id}/download","href":"/api-reference/files/download-a-document-file"},{"title":"Get document thumbnail","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/files/{id}/thumbnail","href":"/api-reference/files/get-document-thumbnail"}]},{"group":"Facets","pages":[{"title":"List content types","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/content-types","href":"/api-reference/facets/list-content-types"},{"title":"Define content types and attributes","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/content-types","href":"/api-reference/facets/define-content-types-and-attributes"},{"title":"Batch define content types and attributes","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/content-types/batch","href":"/api-reference/facets/batch-define-content-types-and-attributes"},{"title":"Resolve search scope","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/content-types/scope","href":"/api-reference/facets/resolve-search-scope"},{"title":"List content type templates","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/content-types/templates","href":"/api-reference/facets/list-content-type-templates"},{"title":"Resolve search scope","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/content-types/scope","href":"/api-reference/facets/resolve-search-scope"},{"title":"List file classifications and attribute values","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/files/{file_id}/facets","href":"/api-reference/facets/list-file-classifications-and-attribute-values"},{"title":"Classify file and set attribute values","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/files/{file_id}/facets","href":"/api-reference/facets/classify-file-and-set-attribute-values"},{"title":"Batch classify and set attribute values","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/files/{file_id}/facets/batch","href":"/api-reference/facets/batch-classify-and-set-attribute-values"}]},{"group":"Tags","pages":[{"title":"List all tags for the authenticated user's company","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/tags","href":"/api-reference/tags/list-all-tags-for-the-authenticated-users-company"},{"title":"Create a new tag for the company","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/tags","href":"/api-reference/tags/create-a-new-tag-for-the-company"},{"title":"Delete a company tag","description":"Delete a company tag.\nThis will also remove all Document-Tag associations with this tag.\nRequires tag deletion permission.","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml delete /api/v3/tags/{id}","href":"/api-reference/tags/delete-a-company-tag"},{"title":"Add tags to a file","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/files/{id}/tags","href":"/api-reference/files/add-tags-to-a-file"},{"title":"Remove a tag from a file","description":"Remove a specific tag from a file.\n\n**Behavior:**\n- Removes the specified tag from the document\n- Works for both manually assigned and auto-assigned tags\n- Idempotent: returns 204 even if tag was not on the document\n\n**Validation:**\n- Returns 403 if user doesn't have permission to edit the document\n- Returns 404 if document doesn't exist\n- Returns 404 if tag doesn't exist or doesn't belong to user's company\n","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml delete /api/v3/files/{id}/tags/{tag_id}","href":"/api-reference/files/remove-a-tag-from-a-file"}]},{"group":"Workspaces","pages":[{"title":"List workspaces","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/workspaces","href":"/api-reference/workspaces/list-workspaces"},{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/workspaces","href":"/api-reference/workspaces/create-a-workspace"},{"title":"Retrieve a workspace","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/workspaces/{id}","href":"/api-reference/workspaces/retrieve-a-workspace"},{"title":"Update a workspace","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml patch /api/v3/workspaces/{id}","href":"/api-reference/workspaces/update-a-workspace"},{"title":"Delete a workspace","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml delete /api/v3/workspaces/{id}","href":"/api-reference/workspaces/delete-a-workspace"},{"title":"Browse datasource folders","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/workspaces/datasource/browse","href":"/api-reference/workspaces/browse-datasource-folders"},{"title":"Test datasource credentials","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/workspaces/datasource/test","href":"/api-reference/workspaces/test-datasource-credentials"}]}]},{"group":"Document Processing","pages":[{"group":"Parse","pages":[{"title":"Parse a document to Markdown","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/parse","href":"/api-reference/parse/parse-a-document-to-markdown"},{"title":"Get the status and result of an async parse job","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/parse/{id}","href":"/api-reference/parse/get-the-status-and-result-of-an-async-parse-job"},{"title":"Render a document as PDF","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/preview","href":"/api-reference/parse/render-a-document-as-pdf"}]},{"group":"Extract","pages":[{"title":"Extract structured data from a document","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/extract","href":"/api-reference/extract/extract-structured-data-from-a-document"},{"title":"Get the status and result of an async extract job","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/extract/{job_id}","href":"/api-reference/extract/get-the-status-and-result-of-an-async-extract-job"}]}]},{"group":"Administration","pages":[{"group":"API Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create API key","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/keys","href":"/api-reference/api-keys/create-api-key"},{"title":"Retrieve API key","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/keys/{id}","href":"/api-reference/api-keys/retrieve-api-key"},{"title":"Update API key","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml patch /api/v3/keys/{id}","href":"/api-reference/api-keys/update-api-key"},{"title":"Revoke API key","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml delete /api/v3/keys/{id}","href":"/api-reference/api-keys/revoke-api-key"}]},{"group":"Budget","pages":[{"title":"Get company budget","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/billing/budget","href":"/api-reference/budget/get-company-budget"},{"title":"Create or update company budget","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml put /api/v3/billing/budget","href":"/api-reference/budget/create-or-update-company-budget"},{"title":"Delete company budget","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml delete /api/v3/billing/budget","href":"/api-reference/budget/delete-company-budget"},{"title":"List budget alerts","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml get /api/v3/billing/budget/alerts","href":"/api-reference/budget/list-budget-alerts"},{"title":"Create budget alert","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml post /api/v3/billing/budget/alerts","href":"/api-reference/budget/create-budget-alert"},{"title":"Toggle all budget alerts","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml patch /api/v3/billing/budget/alerts","href":"/api-reference/budget/toggle-all-budget-alerts"},{"title":"Update budget alert","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml patch /api/v3/billing/budget/alerts/{id}","href":"/api-reference/budget/update-budget-alert"},{"title":"Delete budget alert","deprecated":null,"version":null,"openapi":"/api-reference/api-console.yaml delete /api/v3/billing/budget/alerts/{id}","href":"/api-reference/budget/delete-budget-alert"}]}]}]},{"tab":"Tutorials","pages":[{"title":"Tutorials","href":"/tutorials"}]},{"tab":"Settings","pages":[{"title":"Settings","href":"/untitled-page"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations"}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/mcp-server/quickstart"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks"}]},{"tab":"Use Cases","pages":[{"title":"Use Cases","href":"/use-cases"}]},{"tab":"Legal","pages":[{"title":"Legal","href":"/legal/terms-of-use"}]},{"tab":"Support","pages":[{"title":"Support","href":"/support"}]}]},"basePath":"","title":"Add tags to a file - LightOn Developers","deploymentId":"dpl_7AgmPo2RyRWZ68ZGceW618SWGEAz","buildId":"dpl_7AgmPo2RyRWZ68ZGceW618SWGEAz","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-wzXgrCiA.js","snippetPresets-Ctn0LgL5.js","utils-knxdv-fi.js","style-to-object-BY3JEAdk.js","utils-Szn2cJIN.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CYggQ38U.js","conditional-requirements-CFM0id0Q.js","cloneDeep-a_SFy_bM.js","_Uint8Array-CYON-SEw.js","isObject-FP1Yky1u.js","ApiExamples-Bp2XNIJ2.js","usePlaygroundInputsStore-Bv5ea2yO.js","shallow-BeX-jZPB.js","isEqual-DiyXA5rL.js","CodeSnippets-DXnnQSz3.js","CodeSnippet-Ba_bs1zd.js","getApiPlaygroundDisplay-D0IrdxIN.js","Page-Dn3dap3J.js","DynamicMarkdown-T8UDalrO.js","SectionHeading-DANTRrnD.js","icon-Mqg-z9_o.js","MethodPill-gS6fR7OH.js","getPastedJson-B3wZ4biI.js","Check2Icon-BT0wGl3r.js","axios-CsQoIw0U.js","Markdown-DUz08Fig.js","AssistantPageLink-D3sNlIci.js","dist-BbIWfytJ.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}