Tools

files_get

One file's state: `readiness` is the field to act on (ready | processing | failed — poll while 'processing'), plus dimensions, scan status, variants, and the typed `error.reason` when it failed.

One file’s state: readiness is the field to act on (ready | processing | failed — poll while ‘processing’), plus dimensions, scan status, variants, and the typed error.reason when it failed. Set include_url for a signed download url (600 s) once ready.

Input

FieldTypeRequiredDescription
organizationstringnoOrganization slug to act in (see organizations_list). Optional: API keys are bound to one organization; OAuth connections default to your active organization.
idstringyesFile id (file_…)
include_urlbooleannoAlso return a signed download url (600 s) once the file is ready
variantstringnoSign a named derivative instead of the original, e.g. “thumbnail”

Result

JSON on success. A refusal comes back as an error prefixed with its code (NOT_FOUND, FORBIDDEN, TOO_MANY_REQUESTS, …) and a message written to be acted on — read it before retrying.

The same operation elsewhere

This tool and the REST operation filesGet and the CLI command inklate files get run the same guarded procedure the dashboard uses — same permissions, same validation, same tenant isolation.