import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/local-documents/import-to-documents/"
payload = {
"local_document_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
local_document_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
collection_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/local-documents/import-to-documents/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/local-documents/import-to-documents/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"local_document_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'{
"imported_count": 123,
"documents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"file": "<string>",
"content_type": "application/pdf",
"computed_pdf_file": "<string>",
"source": "upload",
"source_metadata": {},
"page_count": 123,
"file_size": 123,
"metadata": [
[
"category",
"Finance"
],
[
"region",
"EMEA"
]
],
"collection": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>"
},
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]"
}
}
],
"skipped": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"reason": "<string>"
}
]
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}Import conversation files into the document library
Promote conversation files (LocalDocuments attached to a coach
conversation or an agent session, uploaded or agent-generated) into
project documents. Admin only.
Each file’s content is copied into a new document and extraction-flow
processing is scheduled; the source files stay attached to their
conversation. Unreadable files are skipped and reported rather than
failing the batch. At most 20 files per call.
Used by the Work-with-Clara import_files_to_sources tool.
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/local-documents/import-to-documents/"
payload = {
"local_document_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
local_document_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
collection_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/local-documents/import-to-documents/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/local-documents/import-to-documents/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"local_document_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'{
"imported_count": 123,
"documents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"file": "<string>",
"content_type": "application/pdf",
"computed_pdf_file": "<string>",
"source": "upload",
"source_metadata": {},
"page_count": 123,
"file_size": 123,
"metadata": [
[
"category",
"Finance"
],
[
"region",
"EMEA"
]
],
"collection": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>"
},
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]"
}
}
],
"skipped": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"reason": "<string>"
}
]
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}Authorizations
Use Authorization: Bearer <token>. The token is either a user token / OAuth access
token, or a service-account API key (cfk_...). A key is valid on every endpoint and
acts as its service account, an organization member with per-store permissions.
Refused keys answer 403 with Invalid API key., API key revoked.,
API key expired. or API key disabled..
Path Parameters
UUID of the project
Body
Response
Import completed (skipped files reported per item). A 201 does not mean every
file landed: when all of them are skipped, imported_count is 0 and every id
appears in skipped, so clients must read skipped rather than treating any
2xx as a full success.