Files

The AI Gateway supports managing files in two ways:

Provider Files: Uploading and managing files directly to any provider using the unified signature
AI Gateway Files: Uploading files to the AI Gateway and using them for batching/fine-tuning requests with any provider

1. Provider Files

Upload and manage files directly to providers (OpenAI, Bedrock, etc.) using the AI Gateway’s unified API signature. This approach is useful when you need provider-specific file features or want to manage files directly on the provider’s platform.

Supported Providers

Quick Example

curl -X POST https://aigw.portkey.ai/v1/files \
  -H "Authorization: Bearer $PORTKEY_API_KEY" \
  -H "x-portkey-provider: openai" \
  -F "purpose=fine-tune" \
  -F "file=@training_data.jsonl"

2. AI Gateway Files

Upload files to the AI Gateway and reuse them for batching inference with any provider and fine-tuning with supported providers. This approach is ideal for:

Testing your data with different foundation models
Performing A/B testing across multiple providers
Batch inference with provider-agnostic file management
Reusing the same file across multiple batch jobs

File Requirements

Format: JSONL files where each line contains a single request payload

Uploading Files

curl -X POST https://aigw.portkey.ai/v1/files \
  -H "Authorization: Bearer $PORTKEY_API_KEY" \
  -F "purpose=batch" \
  -F "file=@batch_data.jsonl"

Listing Files

curl -X GET https://aigw.portkey.ai/v1/files \
  -H "Authorization: Bearer $PORTKEY_API_KEY"

const files = await client.files.list();
console.log(files);

files = client.files.list()
print(files)

Get File Details

curl -X GET https://aigw.portkey.ai/v1/files/{file_id} \
  -H "Authorization: Bearer $PORTKEY_API_KEY"

const file = await client.files.retrieve('file_abc123');
console.log(file);

file = client.files.retrieve('file_abc123')
print(file)

Get File Content

curl -X GET https://aigw.portkey.ai/v1/files/{file_id}/content \
  -H "Authorization: Bearer $PORTKEY_API_KEY"

const content = await client.files.content('file_abc123');
console.log(content);

content = client.files.content('file_abc123')
print(content)

File Format Examples

Batch Inference JSONL Format

Each line should be a valid JSON object representing a single request:

{"custom_id": "request-1", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "gpt-3.5-turbo-0125", "messages": [{"role": "system", "content": "You are a helpful assistant."},{"role": "user", "content": "Hello world!"}],"max_tokens": 1000}}
{"custom_id": "request-2", "method": "POST", "url": "/v1/chat/completions", "body": {"model": "gpt-3.5-turbo-0125", "messages": [{"role": "system", "content": "You are an unhelpful assistant."},{"role": "user", "content": "Hello world!"}],"max_tokens": 1000}}

Fine-tuning JSONL Format

For fine-tuning, each line should contain training examples:

{"messages": [{"role": "system", "content": "You are a helpful assistant."}, {"role": "user", "content": "Hello"}, {"role": "assistant", "content": "Hi! How can I help you today?"}]}
{"messages": [{"role": "system", "content": "You are a helpful assistant."}, {"role": "user", "content": "What's 2+2?"}, {"role": "assistant", "content": "2+2 equals 4."}]}

Security & Best Practices

Encryption: Files are encrypted at rest using AES-256
Access Control: File access is gated by workspace permissions
Provider Upload: The AI Gateway uploads files to providers using least-privilege credentials

Introduction

Product

1. Provider Files

Supported Providers

Quick Example

2. AI Gateway Files

File Requirements

Uploading Files

Listing Files

Get File Details

Get File Content

File Format Examples

Batch Inference JSONL Format

Fine-tuning JSONL Format

Security & Best Practices

​1. Provider Files

​Supported Providers

​Quick Example

​2. AI Gateway Files

​File Requirements

​Uploading Files

​Listing Files

​Get File Details

​Get File Content

​File Format Examples

​Batch Inference JSONL Format

​Fine-tuning JSONL Format

​Security & Best Practices

1. Provider Files

Supported Providers

Quick Example

2. AI Gateway Files

File Requirements

Uploading Files

Listing Files

Get File Details

Get File Content

File Format Examples

Batch Inference JSONL Format

Fine-tuning JSONL Format

Security & Best Practices