📄 Data Entities
Get Data Entity
📄 Data Entities
Get Data Entity
This endpoint retrieves a Data Entity by its ID
GET
/
v1
/
data-entities
/
{id}
# Example Request
curl -X GET "https://api.getmetal.io/v1/data-entities/{id}" \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \
{
"data": {
"id": "entityID",
"datasource": "datasourceID",
"name": "record_deal.pdf",
"extractedMetadata": [
{
"name": "band",
"type": "string",
"value": "Iron Maiden"
},
{
"name": "recordLabel",
"value": "EMI",
"type": "string"
},
],
"sourcetype": "file",
"status": "EXTRACTED",
"createdAt": "2023-08-29T12:34:56.789Z",
"ocrData": {
"updatedAt": "1970-01-01T00:00:00Z",
"engine": "unstructured",
"dataEntity": "",
"filetype": "pdf",
"filename": "record_deal.pdf",
"data": [
{
"type": "UncategorizedText",
"text": "SEP-3-2R1@ B3:11F FROM: T0:17825834718 P.2"
},
{
"type": "Title",
"text": "RECORD DEAL AGREEMENT"
},
// ...
],
},
"metadataFields": [
{
"name": "Partners",
"type": "string",
"description": "Who are the partners involved in the deal?"
},
],
"url": "signed-url-to-file",
"createdBy": "007"
}
}
Auth Headers
An API key for your org.
A Client ID for your org.
Params
The unique identifier of the data entity you wish to retrieve.
Response
# Example Request
curl -X GET "https://api.getmetal.io/v1/data-entities/{id}" \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \
{
"data": {
"id": "entityID",
"datasource": "datasourceID",
"name": "record_deal.pdf",
"extractedMetadata": [
{
"name": "band",
"type": "string",
"value": "Iron Maiden"
},
{
"name": "recordLabel",
"value": "EMI",
"type": "string"
},
],
"sourcetype": "file",
"status": "EXTRACTED",
"createdAt": "2023-08-29T12:34:56.789Z",
"ocrData": {
"updatedAt": "1970-01-01T00:00:00Z",
"engine": "unstructured",
"dataEntity": "",
"filetype": "pdf",
"filename": "record_deal.pdf",
"data": [
{
"type": "UncategorizedText",
"text": "SEP-3-2R1@ B3:11F FROM: T0:17825834718 P.2"
},
{
"type": "Title",
"text": "RECORD DEAL AGREEMENT"
},
// ...
],
},
"metadataFields": [
{
"name": "Partners",
"type": "string",
"description": "Who are the partners involved in the deal?"
},
],
"url": "signed-url-to-file",
"createdBy": "007"
}
}
# Example Request
curl -X GET "https://api.getmetal.io/v1/data-entities/{id}" \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \
{
"data": {
"id": "entityID",
"datasource": "datasourceID",
"name": "record_deal.pdf",
"extractedMetadata": [
{
"name": "band",
"type": "string",
"value": "Iron Maiden"
},
{
"name": "recordLabel",
"value": "EMI",
"type": "string"
},
],
"sourcetype": "file",
"status": "EXTRACTED",
"createdAt": "2023-08-29T12:34:56.789Z",
"ocrData": {
"updatedAt": "1970-01-01T00:00:00Z",
"engine": "unstructured",
"dataEntity": "",
"filetype": "pdf",
"filename": "record_deal.pdf",
"data": [
{
"type": "UncategorizedText",
"text": "SEP-3-2R1@ B3:11F FROM: T0:17825834718 P.2"
},
{
"type": "Title",
"text": "RECORD DEAL AGREEMENT"
},
// ...
],
},
"metadataFields": [
{
"name": "Partners",
"type": "string",
"description": "Who are the partners involved in the deal?"
},
],
"url": "signed-url-to-file",
"createdBy": "007"
}
}