Skip to main 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)
{
  "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": {}
}

Authorizations

​
X-API-Key
string
header
required

Memic API key. Every key is bound to exactly one environment — get one from the Memic dashboard under API Keys.

Path Parameters

​
file_id
string<uuid>
required

Response

Successful Response

Detailed status response for file processing.

​
id
string<uuid4>
required
​
name
string
required
​
original_filename
string
required
​
status
enum<string>
required

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
​
project_id
string<uuid4>
required
​
blob_storage_path
string
required
​
is_converted
boolean
required
​
total_chunks
integer
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
environment_id
string<uuid4> | null
​
environment_slug
string | null
​
folder_id
string<uuid4> | null
​
folder_name
string | null
​
converted_file_path
string | null
​
enriched_file_path
string | null
​
total_embeddings
integer
default:0
​
embedding_dimension
integer | null
​
conversion_started_at
string<date-time> | null
​
conversion_completed_at
string<date-time> | null
​
parsing_started_at
string<date-time> | null
​
parsing_completed_at
string<date-time> | null
​
chunking_started_at
string<date-time> | null
​
chunking_completed_at
string<date-time> | null
​
embedding_started_at
string<date-time> | null
​
embedding_completed_at
string<date-time> | null
​
conversion_duration_seconds
number | null
​
parsing_duration_seconds
number | null
​
chunking_duration_seconds
number | null
​
embedding_duration_seconds
number | null
​
total_processing_duration_seconds
number | null
​
estimated_remaining_time_seconds
integer | null
​
estimated_remaining_time_display
string | null
​
error_message
string | null
​
file_metadata
File Metadata · object