AthausDoku

List files

Aufruf, Parameter, Antwort und Fehler von GET /v1/files.

Zuletzt aktualisiert:

Returns the metadata of the files attached to the properties of the office, newest first by default. Filter by listingId. A file has no time of change, so updatedSince is rejected as an unknown parameter; follow new files with sort=-createdAt and stop at the last createdAt you saw. Needs read access to files.

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

In der Konsole ausprobieren

Aufruf

GET https://api.athaus.ai/v1/files

Parameter

Abfrage

NameTypPflichtBeschreibung
limitintegerneinPage size, 1 to 100. More than 100 is rejected, never capped. Vorgabe 50.
cursorstringneinOpaque value from nextCursor of the previous page.
listingIdstring (uuid)neinOnly files of this property.
sortstringneinField to order by. A leading - sorts descending. Eines von createdAt, -createdAt. Vorgabe -createdAt.

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?limit=10" \
  -H "Authorization: Bearer ath_live_..."

Antwort

Bei Erfolg kommt 200 mit FileList.

FileList

FeldTypBeschreibung
objectstringImmer list.
dataFile[]
hasMorebooleanTrue if another page follows.
nextCursorstring | nullPass as cursor to get the next page. Null on the last page.

File

FeldTypBeschreibung
objectstringImmer file.
idstringUUID of the file.
listingIdstring
kindstringEines von photo, floor_plan, document.
documentTypestring | nullFor a document, which paper it is, in the keys the app uses. Null if it was not sorted.
filenamestring | null
mimeTypestring | null
sizeBytesinteger | null
widthinteger | nullIn pixels, for an image where it is known.
heightinteger | nullIn pixels, for an image where it is known.
captionstring | null
positionintegerThe order within the property. Position 0 is the cover.
createdAtstring (date-time)

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.

Fehler

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

StatusCodesBedeutung
400invalid_query, 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