Skip to main content
POST
/
prod
/
v1
/
files
/
preview
Create a file preview
curl --request POST \
  --url https://api.orion.file.ai/prod/v1/files/preview \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "s3Path": "s3://orion.com/649e2d2d2d2d2d2d2d2d2d2d"
}
'
{
  "signedUrl": "https://s3.amazonaws.com/bucket/upload/file.txt?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Signature=1%2F6%2BN7Z6h%2F7oV7Z6i%2F9oV7Z4%3D&Expires=3600"
}

Documentation Index

Fetch the complete documentation index at: https://docs.file.ai/llms.txt

Use this file to discover all available pages before exploring further.

The input should contain the following information:
  • s3Path: the path of the file in the S3 bucket

Authorizations

​
x-api-key
string
header
required

API key for authentication

Body

application/json
​
s3Path
string
required

S3 Path

Example:

"s3://orion.com/649e2d2d2d2d2d2d2d2d2d2d"

Response

The signed URL for the file preview is retrieved

​
signedUrl
string