Read a file's details

GET

/files/{file_id}

const url = 'https://api.katara.com/v1/files/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.katara.com/v1/files/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

file_id

required

string

/^file_[0-9a-f]{24}$/

Responses

200

The file.

application/json

object

required

string

object

required

string

Allowed value: file

bytes

required

integer

created_at

Unix seconds.

integer

filename

required

string

mime_type

required

string

sha256

string

purpose

string

Allowed value: user_data

extracted_text

Whether the file has text for models that cannot read it.

boolean

Example

{
  "id": "file_3f9a1c0b7d2e5a6b8c9d0e1f",
  "object": "file",
  "mime_type": "application/pdf",
  "purpose": "user_data"
}

404

file_not_found, also for a file another account uploaded.