API reference

Get file metadata

GET/v1/files/{fileId}

Authorization

Send a personal API key or an OAuth access token as Authorization: Bearer <token>.

OAuth scopes: files:read

Parameters

fileIdstring (uuid), pathrequired

Responses

200Success

fileobjectrequired
idstringrequired
versionIdstring (uuid)
namestringrequired
mediaTypestringrequired
sizenumberrequired
taskIdstring | nullrequired
projectIdstring | nullrequired
downloadUrlstring (uri)required
createdAtstringrequired
updatedAtstringrequired

400Invalid request

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

401Missing or invalid Bearer credential

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

402Payment or subscription required

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

403Credential is missing a required scope

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

404Resource not found

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

409Request conflict

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

429Rate limit exceeded

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

500Internal API error

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

curl --request GET \
  --url 'https://api.staging.adam.new/v1/files/{fileId}' \
  --header 'Authorization: Bearer <token>'

{
  "file": {
    "id": "<string>",
    "versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "mediaType": "<string>",
    "size": 123,
    "taskId": "<string>",
    "projectId": "<string>",
    "downloadUrl": "https://example.com",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}