curl --request GET \
--url https://paradigm.lighton.ai/api/v3/files/{file_id}/facets \
--header 'Authorization: Bearer <token>'import requests
url = "https://paradigm.lighton.ai/api/v3/files/{file_id}/facets"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://paradigm.lighton.ai/api/v3/files/{file_id}/facets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"content_types": [
{
"path": "<string>",
"code": "<string>",
"label": "<string>",
"attributes": [
{
"name": "<string>",
"value": "<string>",
"type": "<string>",
"required": true,
"label": "",
"description": "",
"choices": []
}
],
"labels": []
}
],
"can_edit": true,
"unlinked": []
}{
"id": null,
"code": 401,
"error": "unauthorized",
"detail": "Authentication credentials were not provided or are invalid.",
"doc_url": "https://developers.lighton.ai/errors#unauthorized"
}{
"id": null,
"code": 404,
"error": "not_found",
"detail": "Document not found.",
"doc_url": "https://developers.lighton.ai/errors#not_found"
}{
"detail": "System is under maintenance.",
"error": "service_maintenance",
"mode": "full_shutdown",
"reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"endpoint_category_names": [
"<string>"
]
}List file classifications and attribute values
See what content types a file is classified under and what attribute values have been set on it.
A file can be classified under multiple content types (e.g., both
legal:contract:nda and compliance:audit-report). Each classification
comes with its own set of attribute values, the metadata fields defined
in your content-type schema.
Response structure:
Each content type entry includes:
path: the content type (e.g.,legal:contract:nda)label: human-readable namelabels: breadcrumb from root to leaf (["Legal", "Contract", "NDA"])
Each attribute value includes:
name/label: identifier and display namevalue: the current value (shape depends on type)type: the attribute type (text,number,date,boolean,select,multi-select)choices: available options forselect/multi-selectrequired: whether the attribute is required by the schema
The response includes can_edit, which indicates whether you have permission
to modify this file’s classifications and attribute values.
To modify: use POST /api/v3/files/{file_id}/facets to classify,
set attribute values, or remove classifications.
To set up content types first: see GET /api/v3/content-types/templates
(browse starter templates) and POST /api/v3/content-types (adopt or create).
curl --request GET \
--url https://paradigm.lighton.ai/api/v3/files/{file_id}/facets \
--header 'Authorization: Bearer <token>'import requests
url = "https://paradigm.lighton.ai/api/v3/files/{file_id}/facets"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://paradigm.lighton.ai/api/v3/files/{file_id}/facets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"content_types": [
{
"path": "<string>",
"code": "<string>",
"label": "<string>",
"attributes": [
{
"name": "<string>",
"value": "<string>",
"type": "<string>",
"required": true,
"label": "",
"description": "",
"choices": []
}
],
"labels": []
}
],
"can_edit": true,
"unlinked": []
}{
"id": null,
"code": 401,
"error": "unauthorized",
"detail": "Authentication credentials were not provided or are invalid.",
"doc_url": "https://developers.lighton.ai/errors#unauthorized"
}{
"id": null,
"code": 404,
"error": "not_found",
"detail": "Document not found.",
"doc_url": "https://developers.lighton.ai/errors#not_found"
}{
"detail": "System is under maintenance.",
"error": "service_maintenance",
"mode": "full_shutdown",
"reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"endpoint_category_names": [
"<string>"
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.