import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/chunks-extractors/{extractor_id}/"
payload = { "name": "Default chunker (rebranded)" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Default chunker",
"brief": "Smart chunker with h1/h2 separators.",
"document_ids": [],
"maximum_chunk_size": 1500,
"minimum_chunk_size": 200,
"page_as_separator": true,
"title_section_separator_mode": "h1_h2",
"excluded_block_types": [
"page_header",
"page_footer"
],
"chunking_mode": "smart",
"is_project_default": false,
"pre_execution_filter": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"extracted_chunks_table": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"versions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_default": true,
"maximum_chunk_size": 1500,
"minimum_chunk_size": 200,
"page_as_separator": true,
"title_section_separator_mode": "h1_h2",
"excluded_block_types": [
"page_header",
"page_footer"
],
"chunking_mode": "smart"
}
],
"default_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_default": true,
"maximum_chunk_size": 1500,
"minimum_chunk_size": 200,
"page_as_separator": true,
"title_section_separator_mode": "h1_h2",
"excluded_block_types": [
"page_header",
"page_footer"
],
"chunking_mode": "smart"
},
"latest_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_default": true,
"maximum_chunk_size": 1500,
"minimum_chunk_size": 200,
"page_as_separator": true,
"title_section_separator_mode": "h1_h2",
"excluded_block_types": [
"page_header",
"page_footer"
],
"chunking_mode": "smart"
}
}{
"error": "User not found"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Chunks Extractors
Update chunks extractor (auto-creates new version)
Partial update. Version-bearing fields: maximum_chunk_size,
minimum_chunk_size, page_as_separator,
title_section_separator_mode, excluded_block_types,
chunking_mode.
Pass set_latest_as_default: true to promote the new version.
PATCH
/
projects
/
{project_id}
/
chunks-extractors
/
{extractor_id}
/
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/chunks-extractors/{extractor_id}/"
payload = { "name": "Default chunker (rebranded)" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Default chunker",
"brief": "Smart chunker with h1/h2 separators.",
"document_ids": [],
"maximum_chunk_size": 1500,
"minimum_chunk_size": 200,
"page_as_separator": true,
"title_section_separator_mode": "h1_h2",
"excluded_block_types": [
"page_header",
"page_footer"
],
"chunking_mode": "smart",
"is_project_default": false,
"pre_execution_filter": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"extracted_chunks_table": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"versions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_default": true,
"maximum_chunk_size": 1500,
"minimum_chunk_size": 200,
"page_as_separator": true,
"title_section_separator_mode": "h1_h2",
"excluded_block_types": [
"page_header",
"page_footer"
],
"chunking_mode": "smart"
}
],
"default_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_default": true,
"maximum_chunk_size": 1500,
"minimum_chunk_size": 200,
"page_as_separator": true,
"title_section_separator_mode": "h1_h2",
"excluded_block_types": [
"page_header",
"page_footer"
],
"chunking_mode": "smart"
},
"latest_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_default": true,
"maximum_chunk_size": 1500,
"minimum_chunk_size": 200,
"page_as_separator": true,
"title_section_separator_mode": "h1_h2",
"excluded_block_types": [
"page_header",
"page_footer"
],
"chunking_mode": "smart"
}
}{
"error": "User not found"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Authorizations
BearerAuthTokenAuth
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
UUID of the extractor
Body
application/json
Segments parsed documents into chunks for downstream processing.
Example:
"Default chunker"
Example:
"Smart chunker with h1/h2 separators."
Example:
[]
Example:
1500
Example:
200
Example:
true
Example:
"h1_h2"
Example:
["page_header", "page_footer"]
Example:
"smart"
Response
Updated
Segments parsed documents into chunks for downstream processing.
Example:
"Default chunker"
Example:
"Smart chunker with h1/h2 separators."
Example:
[]
Example:
1500
Example:
200
Example:
true
Example:
"h1_h2"
Example:
["page_header", "page_footer"]
Example:
"smart"
Show child attributes
Show child attributes
Immutable snapshot of a ChunksExtractor's version-bearing configuration.
Show child attributes
Show child attributes
Immutable snapshot of a ChunksExtractor's version-bearing configuration.
Show child attributes
Show child attributes