メインコンテンツへスキップ
GET
/
v1
/
files
/
{file_id}
Dateimetadaten nach ID abrufen
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>"
}

​
概要

このエンドポイントは、指定されたファイルIDに基づいてファイルのメタデータを取得します。

​
リクエスト

  • HTTP メソッド: GET
  • エンドポイント: /v1/files/{file_id}

​
パスパラメータ

  • file_id (必須): 取得するファイルの一意の識別子。

​
レスポンス

成功した場合、レスポンスは次のフィールドを含むJSONオブジェクトです。
フィールド名型説明
idstringファイルの一意の識別子
namestringファイルの名前
sizenumberファイルのサイズ（バイト）
created_atstringファイルの作成日時

​
例

​
リクエスト例

GET /v1/files/12345

​
レスポンス例

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

​
エラーハンドリング

  • 404 Not Found: 指定されたfile_idが存在しない場合に返されます。
  • 401 Unauthorized: 認証が必要であるが、提供されていない場合に返されます。

​
注意事項

このエンドポイントを使用するには、適切な認証トークンが必要です。詳細については、認証ガイドを参照してください。

承認

​
Authorization
string
header
必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

​
file_id
string
必須

Eindeutiger Bezeichner für die abzurufende Datei.

レスポンス

Erfolgreiche Antwort mit Dateimetadaten.

​
id
string

Datei-ID

​
object
string

Die Art des Objekts. "file" für diesen Endpunkt.

​
created
integer

Erstellter Epoch-Zeitstempel

​
filename
string

Der Dateiname der hochgeladenen Datei

​
bytes
integer

Dateigröße in Bytes

​
purpose
string

Der Zweck der Datei

​
status
string

Dateistatus (z.B. 'pending', 'completed')