Skip to main content
GET
/
files
/
metadata
/
{file_id}
curl https://api.u1.archetypeai.app/v0.5/files/metadata/test_image.jpg \
  -H "Authorization: Bearer $ATAI_API_KEY"

{
  "file_id": "file-abc123",
  "file_uid": "8f2c1e5a-7b3d-4d9e-9c1a-2f5b7d8e4a6c",
  "is_valid": true,
  "file_type": "image/png",
  "num_bytes": 482931,
  "file_status": "FILE_STATUS_INGESTED",
  "file_attributes": {
    "width": 1920,
    "height": 1080,
    "num_channels": 3,
    "channel_bands": ["R", "G", "B"]
  },
  "ingested": true,
  "file_index": 0,
  "file_tags": {}
}

​
Overview

This endpoint returns the full metadata record for a specific file in the authenticated organization, including file status, size, and type-specific attributes (image dimensions, tabular shape, etc.).

​
Path Parameters

​
file_id
string
required
Identifier of the file whose metadata to fetch

​
Response

​
file_id
string
Identifier of the file
​
file_uid
string
Internal unique identifier of the file
​
is_valid
boolean
Whether the metadata record is valid
​
file_type
string
MIME type of the file (e.g. image/png, text/csv)
​
num_bytes
integer
Size of the file in bytes
​
file_status
string
Lifecycle status of the file. One of:
  • FILE_STATUS_UNKNOWN
  • FILE_STATUS_REGISTERED
  • FILE_STATUS_INGESTING
  • FILE_STATUS_INGESTED
  • FILE_STATUS_IN_MEMORY
  • FILE_STATUS_IN_COLD_STORAGE
  • FILE_STATUS_CORRUPT
​
ingested
boolean
Whether the file has completed ingestion
​
file_index
integer
Index of this file within the organization’s file list
​
file_tags
object
Key/value tags attached to the file (empty object if no tags)
​
file_attributes
object
Type-specific attributes for the file. The shape varies by file type:
curl https://api.u1.archetypeai.app/v0.5/files/metadata/test_image.jpg \
  -H "Authorization: Bearer $ATAI_API_KEY"

{
  "file_id": "file-abc123",
  "file_uid": "8f2c1e5a-7b3d-4d9e-9c1a-2f5b7d8e4a6c",
  "is_valid": true,
  "file_type": "image/png",
  "num_bytes": 482931,
  "file_status": "FILE_STATUS_INGESTED",
  "file_attributes": {
    "width": 1920,
    "height": 1080,
    "num_channels": 3,
    "channel_bands": ["R", "G", "B"]
  },
  "ingested": true,
  "file_index": 0,
  "file_tags": {}
}