Retrieve a specific file

GET

/files/{id}/

Retrieves details for a specific file by ID. Currently applicable to draft hires only.

Helpful resources

• Upload and attach files

Required Scopes

• files.read

Request

Path Parameters

id idrequired

ID of the resource to return

Responses

200

Successful response

application/json

Schema

Schema

__meta object
redacted_fields object[]
Array [
name string
The name for the redacted field
reason string
The reason for the redaction
]
id stringrequired
Opaque identifier for this file
status stringrequired
Lifecycle status: awaiting_upload | uploaded | active | infected
display_name string
Human-readable label for the file
content_type string
MIME type supplied by the client at create time
upload_url string
S3 endpoint URL — POST your multipart form here to upload the file. Present only in the create response.
upload_fields object
Required form fields to include in the multipart POST to S3 alongside the file binary
url_data object
URLs for accessing the uploaded file after a successful upload
s3_url string
S3 URL where the file is accessible after upload
preview_url string
CDN URL for previewing the uploaded file after upload completes

Example (from schema)

{
  "__meta": {
    "redacted_fields": [
      {
        "name": "date_of_birth",
        "reason": "Insufficient entitlements"
      }
    ]
  },
  "id": "string",
  "status": "string",
  "display_name": "string",
  "content_type": "string",
  "upload_url": "string",
  "upload_fields": {},
  "url_data": {
    "s3_url": "string",
    "preview_url": "string"
  }
}

Loading...