Get a file handler

Required scope: read

GET /v1/files/{id}

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/v1/files/{id}' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "bytes": 1,
  "content_type": "string",
  "created_at": 1,
  "filename": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "metadata": {},
  "object": "string",
  "purpose": "string",
  "status": "pending"
}

Required scope: read

Path parameters

id · string · required

File ID

Response

FileObject

bytes · integer · required

content_type · string

created_at · integer (int64) · required

filename · string · required

id · string · required

metadata · object

object · string · required

purpose · string · required

status · string · required

Status codes

Code	Meaning
200	File metadata
401	Unauthorized — missing or invalid credentials
403	Forbidden — the key/token lacks the required scope
429	Rate limited — see Retry-After / X-RateLimit-Reset

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/v1/files/{id}' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "bytes": 1,
  "content_type": "string",
  "created_at": 1,
  "filename": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "metadata": {},
  "object": "string",
  "purpose": "string",
  "status": "pending"
}