AthausDoku

Download a file

Aufruf, Parameter, Antwort und Fehler von GET /v1/files/{id}/content.

Zuletzt aktualisiert:

Returns the bytes of the original file as a download (Content-Disposition: attachment), with the stored media type, or application/octet-stream if none is stored. The whole file comes in one response: there are no variants such as thumbnails, no Range requests and no HEAD. sizeBytes in the metadata of the file gives the length up front. Needs read access to files.

Braucht den Scope read und mindestens die Stufe read auf files.

Aufruf

GET https://api.athaus.ai/v1/files/{id}/content

Parameter

Pfad

NameTypPflichtBeschreibung
idstring (uuid)jaUUID of the file.

Kopf

NameTypPflichtBeschreibung
Athaus-VersionstringneinOptional and carries nothing a client needs: the version is the path. Accepted when it says v1 or 1. Any other value is a 400 api_version_unsupported.

Beispiel

curl "https://api.athaus.ai/v1/files/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17/content" \
  -H "Authorization: Bearer ath_live_..." \
  -o file

Antwort

Bei Erfolg kommt 200 mit den Bytes der Datei als application/octet-stream, nicht als JSON. Ein Fehler kommt weiter als JSON in der Hülle.

Köpfe der Antwort

KopfBeschreibung
Request-IdIdentifies this request. Quote it in a support request.
Athaus-VersionThe API version of this response: v1.
Athaus-ReleaseThe release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.
Content-Dispositionattachment, with the file name of the file.
Content-LengthThe size of the file in bytes.

Fehler

Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.

StatusCodesBedeutung
400invalid_id, api_version_unsupportedInvalid request.
401unauthorizedMissing or invalid API key.
403insufficient_permissions, plan_requiredThe key lacks a right, or the plan does not include API access.
404not_foundNothing under this ID.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Weiter lesen

Auf dieser Seite