Download a file

POST/api/v4/records/content

Returns the bytes of one file attached to a record. Take unstructuredId and module from the file reference in the record, and use the record's id as objectId. Files are up to 10 MB.

Auth: X-API-Key
Counts as: 1 request
Idempotency: not supported
Files: up to 10 MB each

Headers

X-API-Keystringrequired: Read from your server environment.
Content-Typestringrequired: application/json.

Body parameters

unstructuredIdstringrequired: From the file reference
objectIdintegerrequired: The record's id
unstructuredModelobjectrequired: —
unstructuredModel.modulestringrequired: From the file reference

Returns

HTTP 200. The file bytes.

Raw file bytes. Content-Type is application/pdf, image/png, image/jpeg, otherwise application/octet-stream. Headers include Content-Length, Content-Disposition, X-Beezr-File-Name and X-Beezr-File-Extension.

Errors

HTTP	Code	What to do
400	`MISSING_REQUIRED_FIELD`	Send the required body fields.
401	`AUTHENTICATION_FAILED`	Check the API key.
404	`CONTENT_NOT_FOUND`	Check the reference and record id.
400 · 413	`CONTENT_TOO_LARGE`	Keep files within 10 MB.
429	`RATE_LIMIT_EXCEEDED`	Wait for the rate-limit reset.
429	`TOO_MANY_CONCURRENT_REQUESTS`	Wait; keep at most 2 in flight.
429	`MONTHLY_QUOTA_EXCEEDED`	Stop retries until the 1st.
500	`FIELD_LOAD_FAILED`	Retry later.
500	`INTERNAL_ERROR`	Retry later.