Get file status
import requests
url = "https://api.memic.ai/api/v1/files/{file_id}/status"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)curl --request GET \
--url https://api.memic.ai/api/v1/files/{file_id}/status \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.memic.ai/api/v1/files/{file_id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"name": "<string>",
"original_filename": "<string>",
"status": "uploading",
"project_id": "<string>",
"blob_storage_path": "<string>",
"is_converted": true,
"total_chunks": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"environment_id": "<string>",
"environment_slug": "<string>",
"folder_id": "<string>",
"folder_name": "<string>",
"converted_file_path": "<string>",
"enriched_file_path": "<string>",
"total_embeddings": 0,
"embedding_dimension": 123,
"conversion_started_at": "2023-11-07T05:31:56Z",
"conversion_completed_at": "2023-11-07T05:31:56Z",
"parsing_started_at": "2023-11-07T05:31:56Z",
"parsing_completed_at": "2023-11-07T05:31:56Z",
"chunking_started_at": "2023-11-07T05:31:56Z",
"chunking_completed_at": "2023-11-07T05:31:56Z",
"embedding_started_at": "2023-11-07T05:31:56Z",
"embedding_completed_at": "2023-11-07T05:31:56Z",
"conversion_duration_seconds": 123,
"parsing_duration_seconds": 123,
"chunking_duration_seconds": 123,
"embedding_duration_seconds": 123,
"total_processing_duration_seconds": 123,
"estimated_remaining_time_seconds": 123,
"estimated_remaining_time_display": "<string>",
"error_message": "<string>",
"file_metadata": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Endpoints
Get file status
Return the processing status of a file. Poll this endpoint until status is ready before issuing search or chat queries that expect the file’s content.
GET
/
api
/
v1
/
files
/
{file_id}
/
status
Get file status
import requests
url = "https://api.memic.ai/api/v1/files/{file_id}/status"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)curl --request GET \
--url https://api.memic.ai/api/v1/files/{file_id}/status \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.memic.ai/api/v1/files/{file_id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"name": "<string>",
"original_filename": "<string>",
"status": "uploading",
"project_id": "<string>",
"blob_storage_path": "<string>",
"is_converted": true,
"total_chunks": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"environment_id": "<string>",
"environment_slug": "<string>",
"folder_id": "<string>",
"folder_name": "<string>",
"converted_file_path": "<string>",
"enriched_file_path": "<string>",
"total_embeddings": 0,
"embedding_dimension": 123,
"conversion_started_at": "2023-11-07T05:31:56Z",
"conversion_completed_at": "2023-11-07T05:31:56Z",
"parsing_started_at": "2023-11-07T05:31:56Z",
"parsing_completed_at": "2023-11-07T05:31:56Z",
"chunking_started_at": "2023-11-07T05:31:56Z",
"chunking_completed_at": "2023-11-07T05:31:56Z",
"embedding_started_at": "2023-11-07T05:31:56Z",
"embedding_completed_at": "2023-11-07T05:31:56Z",
"conversion_duration_seconds": 123,
"parsing_duration_seconds": 123,
"chunking_duration_seconds": 123,
"embedding_duration_seconds": 123,
"total_processing_duration_seconds": 123,
"estimated_remaining_time_seconds": 123,
"estimated_remaining_time_display": "<string>",
"error_message": "<string>",
"file_metadata": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Memic API key. Every key is bound to exactly one environment — get one from the Memic dashboard under API Keys.
Path Parameters
Response
Successful Response
Detailed status response for file processing.
Enum for file processing status.
Available options:
uploading, uploaded, upload_failed, conversion_started, conversion_complete, conversion_failed, parsing_started, parsing_complete, parsing_failed, chunking_started, chunking_complete, chunking_failed, embedding_started, embedding_complete, embedding_failed, ready