Skip to main content
GET
https://api.u1.archetypeai.app/v0.5
/
files
/
metadata
/
{file_id}
curl https://api.dev.u1.archetypeai.app/v0.5/files/metadata/test_image.jpg \
  -H "Authorization: Bearer $ATAI_API_KEY"
{
  "file_id": "test_image.jpg",
  "file_uid": "251207f9651f889e6c0d9f",
  "file_type": "image/jpeg",
  "file_status": "FILE_STATUS_INGESTED",
  "file_attributes": {
    "width": 1024,
    "height": 797,
    "num_channels": 3,
    "channel_bands": ["R", "G", "B"]
  },
  "file_tags": {},
  "num_bytes": 178324,
  "ingested": true,
  "is_valid": true
}

Overview

Retrieve complete metadata for a specific uploaded file, including dimensions, file type, size, and processing status.

Request

Authorization
string
required
Bearer token for authentication. Format: Bearer $ATAI_API_KEY
file_id
string
required
The file ID returned from the upload endpoint

Response

file_id
string
The filename of the file
file_uid
string
Unique identifier for the file
file_type
string
MIME type of the file (e.g., “image/jpeg”, “application/pdf”)
num_bytes
integer
File size in bytes
file_status
string
Storage status (e.g., “FILE_STATUS_INGESTED”)
file_attributes
object
File-specific attributes. For images, includes width, height, num_channels, channel_bands.
ingested
boolean
Whether the file has been processed by the platform
is_valid
boolean
Whether the file is valid and accessible
curl https://api.dev.u1.archetypeai.app/v0.5/files/metadata/test_image.jpg \
  -H "Authorization: Bearer $ATAI_API_KEY"
{
  "file_id": "test_image.jpg",
  "file_uid": "251207f9651f889e6c0d9f",
  "file_type": "image/jpeg",
  "file_status": "FILE_STATUS_INGESTED",
  "file_attributes": {
    "width": 1024,
    "height": 797,
    "num_channels": 3,
    "channel_bands": ["R", "G", "B"]
  },
  "file_tags": {},
  "num_bytes": 178324,
  "ingested": true,
  "is_valid": true
}