Get a file
Returns a file’s metadata and where it is in the pipeline.
{id} accepts the file id or the file name. A name has to match exactly one file here, otherwise the call answers 409 ambiguous_file_name.
status walks uploading → processing → ready, or lands on failed with an error. Poll this route after registering a file until it reads ready.
Once ready, urls carries signed links valid for about an hour:
content— the original bytes.markdownandjson— the parsed forms, present when the file was parsed.
Learn more: Working with files
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
id
Response
The file.
object
id
name
mimeType
status
Allowed values:
createdAt
parentFileId
metadata
error
uploadUrl
uploadExpiresAt
urls
Errors
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error