import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-collections/{collection_id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-collections/{collection_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-collections/{collection_id}/ \
--header 'Authorization: Bearer <token>'{
"name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"document_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "Not found."
}Retrieve a document collection
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-collections/{collection_id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-collections/{collection_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-collections/{collection_id}/ \
--header 'Authorization: Bearer <token>'{
"name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"document_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "Not found."
}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..
Response
Successful response
A named grouping of documents within a project. Membership is the
Document.collection foreign key (single collection per document); a mirrored
["tag", slug] pair is also kept on each document's metadata so the
retrieval/extraction layers can scope to a collection.
Human-readable label (editable).
Stable identifier documents are linked by. Derived from name at creation
and immutable afterwards (renaming changes only name).
Number of active documents in this collection (server-annotated).