Naar hoofdinhoud gaan
GET
/
v1
/
files
/
{file_id}
Haal Bestandsmetadata op via ID
curl --request GET \
  --url https://api.olostep.com/v1/files/{file_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "<string>",
  "created": 123,
  "filename": "<string>",
  "bytes": 123,
  "purpose": "<string>",
  "status": "<string>"
}

Overzicht

Met het Get File eindpunt kun je metadata ophalen voor een specifiek bestand door het file_id te gebruiken. Dit is handig wanneer je informatie nodig hebt over een bestand dat al is geüpload naar Olostep.

Eindpunt

GET /v1/files/{file_id}

Parameters

  • file_id (vereist): De unieke identifier voor het bestand waarvan je de metadata wilt ophalen.

Voorbeeldverzoek

GET /v1/files/12345
Host: api.olostep.com
Authorization: Bearer YOUR_ACCESS_TOKEN

Voorbeeldantwoord

{
  "id": "12345",
  "name": "example.pdf",
  "size": 1024,
  "type": "application/pdf",
  "created_at": "2023-10-01T12:00:00Z"
}

Reacties

  • 200 OK: Het verzoek was succesvol en de metadata van het bestand wordt geretourneerd.
  • 404 Not Found: Het opgegeven file_id bestaat niet.
  • 401 Unauthorized: Er is geen geldige API-token verstrekt.

Opmerkingen

Zorg ervoor dat je de juiste machtigingen hebt om toegang te krijgen tot de gevraagde bestandgegevens. Raadpleeg de Authenticatiegids voor meer informatie over het verkrijgen van een toegangstoken.

Autorisaties

Authorization
string
header
vereist

Bearer authenticatie header in de vorm Bearer , waarbij jouw auth token is.

Padparameters

file_id
string
vereist

Unieke identificatie voor het bestand om op te halen.

Respons

Succesvolle respons met bestandsmetadata.

id
string

Bestand ID

object
string

Het soort object. "file" voor deze endpoint.

created
integer

Gemaakt epoch-tijdstempel

filename
string

De bestandsnaam van het geüploade bestand

bytes
integer

Bestandsgrootte in bytes

purpose
string

Het doel van het bestand

status
string

Bestandsstatus (bijv. 'pending', 'completed')