Retrieve imported object extractor
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/imported-object-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}/imported-object-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}/imported-object-extractors/{extractor_id}/ \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "CRM contacts",
"brief": "Contacts imported nightly from Salesforce.",
"extractable_pydantic_class": "from pydantic import BaseModel\n\nclass ImportedRecord(BaseModel):\n external_id: str\n payload: dict\n",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"imported_objects_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,
"extractable_pydantic_class": "from pydantic import BaseModel\n\nclass ImportedRecord(BaseModel):\n external_id: str\n payload: dict\n",
"last_import_status": "<string>"
}
],
"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\n\nclass ImportedRecord(BaseModel):\n external_id: str\n payload: dict\n",
"last_import_status": "<string>"
},
"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\n\nclass ImportedRecord(BaseModel):\n external_id: str\n payload: dict\n",
"last_import_status": "<string>"
}
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Imported Object Extractors
Retrieve imported object extractor
GET
/
projects
/
{project_id}
/
imported-object-extractors
/
{extractor_id}
/
Retrieve imported object extractor
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/imported-object-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}/imported-object-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}/imported-object-extractors/{extractor_id}/ \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "CRM contacts",
"brief": "Contacts imported nightly from Salesforce.",
"extractable_pydantic_class": "from pydantic import BaseModel\n\nclass ImportedRecord(BaseModel):\n external_id: str\n payload: dict\n",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"imported_objects_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,
"extractable_pydantic_class": "from pydantic import BaseModel\n\nclass ImportedRecord(BaseModel):\n external_id: str\n payload: dict\n",
"last_import_status": "<string>"
}
],
"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\n\nclass ImportedRecord(BaseModel):\n external_id: str\n payload: dict\n",
"last_import_status": "<string>"
},
"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\n\nclass ImportedRecord(BaseModel):\n external_id: str\n payload: dict\n",
"last_import_status": "<string>"
}
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Authorizations
BearerAuthTokenAuth
Use Authorization: Bearer
Path Parameters
UUID of the project
UUID of the extractor
Response
Successful response
Holds objects imported from an external system (rather than extracted by an LLM). Useful for hydrating the warehouse with data produced outside the platform.
Example:
"CRM contacts"
Example:
"Contacts imported nightly from Salesforce."
Example:
"from pydantic import BaseModel\n\nclass ImportedRecord(BaseModel):\n external_id: str\n payload: dict\n"
Show child attributes
Show child attributes
Immutable snapshot of an ImportedObjectExtractor's version-bearing configuration.
Show child attributes
Show child attributes
Immutable snapshot of an ImportedObjectExtractor's version-bearing configuration.
Show child attributes
Show child attributes