Skip to main content
GET
https://api.u1.archetypeai.app/v0.5
/
files
/
metadata
curl https://api.dev.u1.archetypeai.app/v0.5/files/metadata \
  -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,
    "file_index": 0
  }
]

​
Overview

Retrieve metadata for all uploaded files. Supports pagination using shard indices.

​
Request

​
Authorization
string
required
Bearer token for authentication. Format: Bearer $ATAI_API_KEY
​
shard_index
integer
default:"-1"
Shard index for pagination. Use -1 to retrieve all files.
​
max_items_per_shard
integer
default:"-1"
Maximum items per shard. Use -1 for no limit.

​
Response

Returns an array of file metadata objects. Each object contains:
​
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”)
​
file_status
string
Storage status (e.g., “FILE_STATUS_INGESTED”)
​
file_attributes
object
File-specific attributes (dimensions for images, etc.)
​
num_bytes
integer
File size in bytes
​
ingested
boolean
Whether the file has been processed
curl https://api.dev.u1.archetypeai.app/v0.5/files/metadata \
  -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,
    "file_index": 0
  }
]