import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/object-alerts-extractors/{extractor_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}/object-alerts-extractors/{extractor_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}/object-alerts-extractors/{extractor_id}/ \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Missing effective dates",
"brief": "Alert when an obligation lacks an effective date.",
"instructions": "Flag any ContractClause missing an effective_date when clause_type is 'obligation'.",
"llm_model": "gpt-4o",
"document_ids": [],
"document_ranges": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"alerts_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,
"instructions": "Flag any ContractClause missing an effective_date when clause_type is 'obligation'.",
"llm_model": "gpt-4o"
}
],
"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,
"instructions": "Flag any ContractClause missing an effective_date when clause_type is 'obligation'.",
"llm_model": "gpt-4o"
},
"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,
"instructions": "Flag any ContractClause missing an effective_date when clause_type is 'obligation'.",
"llm_model": "gpt-4o"
}
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Retrieve object alerts extractor
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/object-alerts-extractors/{extractor_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}/object-alerts-extractors/{extractor_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}/object-alerts-extractors/{extractor_id}/ \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Missing effective dates",
"brief": "Alert when an obligation lacks an effective date.",
"instructions": "Flag any ContractClause missing an effective_date when clause_type is 'obligation'.",
"llm_model": "gpt-4o",
"document_ids": [],
"document_ranges": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"alerts_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,
"instructions": "Flag any ContractClause missing an effective_date when clause_type is 'obligation'.",
"llm_model": "gpt-4o"
}
],
"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,
"instructions": "Flag any ContractClause missing an effective_date when clause_type is 'obligation'.",
"llm_model": "gpt-4o"
},
"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,
"instructions": "Flag any ContractClause missing an effective_date when clause_type is 'obligation'.",
"llm_model": "gpt-4o"
}
}{
"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
Response
Successful response
Runs LLM-based alerts over already-extracted object rows.
"Missing effective dates"
"Alert when an obligation lacks an effective date."
"Flag any ContractClause missing an effective_date when clause_type is 'obligation'."
"gpt-4o"
[]
Show child attributes
Show child attributes
Immutable snapshot of an ObjectAlertsExtractor's version-bearing configuration.
Show child attributes
Show child attributes
Immutable snapshot of an ObjectAlertsExtractor's version-bearing configuration.
Show child attributes
Show child attributes