import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-filter-extractors/{extractor_id}/"
payload = { "name": "Legal docs filter (renamed)" }
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": "Legal docs only",
"brief": "Filter to documents tagged as legal department.",
"filter": {
"tag_key": "department",
"values": [
"legal"
]
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"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,
"filter": {
"tag_key": "department",
"values": [
"legal"
]
}
}
],
"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,
"filter": {
"tag_key": "department",
"values": [
"legal"
]
}
},
"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,
"filter": {
"tag_key": "department",
"values": [
"legal"
]
}
}
}{
"error": "User not found"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Update document filter extractor (auto-creates new version)
Partial update. Version-bearing field: filter.
Pass set_latest_as_default: true to promote the new version.
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-filter-extractors/{extractor_id}/"
payload = { "name": "Legal docs filter (renamed)" }
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": "Legal docs only",
"brief": "Filter to documents tagged as legal department.",
"filter": {
"tag_key": "department",
"values": [
"legal"
]
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"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,
"filter": {
"tag_key": "department",
"values": [
"legal"
]
}
}
],
"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,
"filter": {
"tag_key": "department",
"values": [
"legal"
]
}
},
"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,
"filter": {
"tag_key": "department",
"values": [
"legal"
]
}
}
}{
"error": "User not found"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"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..
Path Parameters
UUID of the project
UUID of the extractor
Body
Restricts a downstream pipeline branch to a subset of documents matching a filter.
Response
Updated
Restricts a downstream pipeline branch to a subset of documents matching a filter.
"Legal docs only"
"Filter to documents tagged as legal department."
{
"tag_key": "department",
"values": ["legal"]
}
Show child attributes
Show child attributes
Immutable snapshot of a DocumentFilterExtractor's version-bearing configuration.
Show child attributes
Show child attributes
Immutable snapshot of a DocumentFilterExtractor's version-bearing configuration.
Show child attributes
Show child attributes