Documents
Get Document by ID
Documents
Get Document by ID
Retrieve a document by its unique ID.
GET
/
document
/
{id}
curl --request GET \
--url https://{api-address}.org.machina.gg/document/{id} \
--header 'x-api-token: <api-key>'{
"data": {
"_id": "67e1fc8c2a5ade8c69c03fe7",
"created": "Tue, 25 Mar 2025 00:45:00 GMT",
"embed-vector": false,
"metadata": {
"agent_id": "123"
},
"name": "New test document",
"status": null,
"updated": "Tue, 25 Mar 2025 00:45:00 GMT",
"value": {
"chat": [
"What is Lorem Ipsum?",
"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.",
" It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum."
]
}
},
"status": true
}Authorizations
API key authentication
Path Parameters
Unique ID of the document
Response
200
application/json
Document details
Unique identifier of the document
Example:
"67e1fc8c2a5ade8c69c03fe7"
Unique name of the document
Example:
"New test document"
The main data of the document
Example:
{
"chat": [
"What is Lorem Ipsum?",
"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.",
" It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum."
]
}
Additional metadata for the document
Example:
{ "agent_id": "123" }
Current status of the document
Example:
null
Creation timestamp
Example:
"Tue, 25 Mar 2025 00:45:00 GMT"
Update timestamp
Example:
"Tue, 25 Mar 2025 00:45:00 GMT"
Whether a vector embedding was created
Example:
false
Operation status
Example:
true
curl --request GET \
--url https://{api-address}.org.machina.gg/document/{id} \
--header 'x-api-token: <api-key>'{
"data": {
"_id": "67e1fc8c2a5ade8c69c03fe7",
"created": "Tue, 25 Mar 2025 00:45:00 GMT",
"embed-vector": false,
"metadata": {
"agent_id": "123"
},
"name": "New test document",
"status": null,
"updated": "Tue, 25 Mar 2025 00:45:00 GMT",
"value": {
"chat": [
"What is Lorem Ipsum?",
"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.",
" It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum."
]
}
},
"status": true
}