List object extractors
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/object-extractors/"
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}/object-extractors/', 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}/object-extractors/ \
--header 'Authorization: Bearer <token>'{
"count": 123,
"next": "<string>",
"previous": "<string>",
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Contract clauses",
"brief": "Extract obligations and effective dates from contracts.",
"llm_model": "gpt-4o",
"extractable_object": "ContractClause",
"extractable_pydantic_class": "from pydantic import BaseModel\nfrom typing import Optional\n\nclass ContractClause(BaseModel):\n clause_type: str\n text: str\n effective_date: Optional[str] = None\n",
"extraction_prompt": "Extract every distinct contractual obligation as a separate ContractClause object.",
"document_ids": [
"b3c1d2e4-5f6a-4b7c-8d9e-0a1b2c3d4e5f"
],
"document_ranges": {},
"compute_alerts": false,
"add_anchoring_object": true,
"filtered_on_block_types": true,
"block_types": [
"text",
"table"
],
"extract_single_object": false,
"block_grouping_config": {},
"pre_execution_filter": {},
"alerts_additional_instructions": "<string>",
"alerts_llm_model": "<string>",
"extraction_mode": "standard",
"agentic_config": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"prompt_generation_status": "<string>",
"deployed_extractable_pydantic_class": "<string>",
"deployed_extraction_prompt": "<string>",
"deployed_llm_model": "<string>",
"extracted_objects_table": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alerts_table": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object_name": "<string>",
"blocks_table_version_info": {},
"chunks_table_version_info": {},
"table_version_updates": {},
"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,
"extractable_pydantic_class": "from pydantic import BaseModel\nfrom typing import Optional\n\nclass ContractClause(BaseModel):\n clause_type: str\n text: str\n effective_date: Optional[str] = None\n",
"extraction_prompt": "Extract every distinct contractual obligation as a separate ContractClause object.",
"llm_model": "gpt-4o",
"add_anchoring_object": true,
"filtered_on_block_types": true,
"block_types": [
"text",
"table"
],
"extract_single_object": false,
"block_grouping_config": {},
"alerts_additional_instructions": "<string>",
"extraction_mode": "standard",
"agentic_config": {}
}
],
"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,
"extractable_pydantic_class": "from pydantic import BaseModel\nfrom typing import Optional\n\nclass ContractClause(BaseModel):\n clause_type: str\n text: str\n effective_date: Optional[str] = None\n",
"extraction_prompt": "Extract every distinct contractual obligation as a separate ContractClause object.",
"llm_model": "gpt-4o",
"add_anchoring_object": true,
"filtered_on_block_types": true,
"block_types": [
"text",
"table"
],
"extract_single_object": false,
"block_grouping_config": {},
"alerts_additional_instructions": "<string>",
"extraction_mode": "standard",
"agentic_config": {}
},
"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,
"extractable_pydantic_class": "from pydantic import BaseModel\nfrom typing import Optional\n\nclass ContractClause(BaseModel):\n clause_type: str\n text: str\n effective_date: Optional[str] = None\n",
"extraction_prompt": "Extract every distinct contractual obligation as a separate ContractClause object.",
"llm_model": "gpt-4o",
"add_anchoring_object": true,
"filtered_on_block_types": true,
"block_types": [
"text",
"table"
],
"extract_single_object": false,
"block_grouping_config": {},
"alerts_additional_instructions": "<string>",
"extraction_mode": "standard",
"agentic_config": {}
}
}
]
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Object Extractors
List object extractors
List all ObjectExtractor rows in the project, newest first.
GET
/
projects
/
{project_id}
/
object-extractors
/
List object extractors
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/object-extractors/"
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}/object-extractors/', 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}/object-extractors/ \
--header 'Authorization: Bearer <token>'{
"count": 123,
"next": "<string>",
"previous": "<string>",
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Contract clauses",
"brief": "Extract obligations and effective dates from contracts.",
"llm_model": "gpt-4o",
"extractable_object": "ContractClause",
"extractable_pydantic_class": "from pydantic import BaseModel\nfrom typing import Optional\n\nclass ContractClause(BaseModel):\n clause_type: str\n text: str\n effective_date: Optional[str] = None\n",
"extraction_prompt": "Extract every distinct contractual obligation as a separate ContractClause object.",
"document_ids": [
"b3c1d2e4-5f6a-4b7c-8d9e-0a1b2c3d4e5f"
],
"document_ranges": {},
"compute_alerts": false,
"add_anchoring_object": true,
"filtered_on_block_types": true,
"block_types": [
"text",
"table"
],
"extract_single_object": false,
"block_grouping_config": {},
"pre_execution_filter": {},
"alerts_additional_instructions": "<string>",
"alerts_llm_model": "<string>",
"extraction_mode": "standard",
"agentic_config": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"prompt_generation_status": "<string>",
"deployed_extractable_pydantic_class": "<string>",
"deployed_extraction_prompt": "<string>",
"deployed_llm_model": "<string>",
"extracted_objects_table": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alerts_table": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object_name": "<string>",
"blocks_table_version_info": {},
"chunks_table_version_info": {},
"table_version_updates": {},
"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,
"extractable_pydantic_class": "from pydantic import BaseModel\nfrom typing import Optional\n\nclass ContractClause(BaseModel):\n clause_type: str\n text: str\n effective_date: Optional[str] = None\n",
"extraction_prompt": "Extract every distinct contractual obligation as a separate ContractClause object.",
"llm_model": "gpt-4o",
"add_anchoring_object": true,
"filtered_on_block_types": true,
"block_types": [
"text",
"table"
],
"extract_single_object": false,
"block_grouping_config": {},
"alerts_additional_instructions": "<string>",
"extraction_mode": "standard",
"agentic_config": {}
}
],
"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,
"extractable_pydantic_class": "from pydantic import BaseModel\nfrom typing import Optional\n\nclass ContractClause(BaseModel):\n clause_type: str\n text: str\n effective_date: Optional[str] = None\n",
"extraction_prompt": "Extract every distinct contractual obligation as a separate ContractClause object.",
"llm_model": "gpt-4o",
"add_anchoring_object": true,
"filtered_on_block_types": true,
"block_types": [
"text",
"table"
],
"extract_single_object": false,
"block_grouping_config": {},
"alerts_additional_instructions": "<string>",
"extraction_mode": "standard",
"agentic_config": {}
},
"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,
"extractable_pydantic_class": "from pydantic import BaseModel\nfrom typing import Optional\n\nclass ContractClause(BaseModel):\n clause_type: str\n text: str\n effective_date: Optional[str] = None\n",
"extraction_prompt": "Extract every distinct contractual obligation as a separate ContractClause object.",
"llm_model": "gpt-4o",
"add_anchoring_object": true,
"filtered_on_block_types": true,
"block_types": [
"text",
"table"
],
"extract_single_object": false,
"block_grouping_config": {},
"alerts_additional_instructions": "<string>",
"extraction_mode": "standard",
"agentic_config": {}
}
}
]
}{
"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
Query Parameters
Maximum number of results per page
Required range:
1 <= x <= 1000Number of results to skip for pagination
Required range:
x >= 0