API Quickstart - OpenFiles

1. Get Your API Key

Create your account at console.openfiles.ai

Create API Key

Navigate to API Keys → Create API Key

Copy Your Key

Copy your API key (starts with oa_) and store it securely

2. Make Your First API Call

Let’s create your first file:

curl -X POST "https://api.openfiles.ai/functions/v1/api/files" \
  -H "Content-Type: application/json" \
  -H "x-api-key: oa_your_api_key_here" \
  -d '{
    "path": "hello-world.txt",
    "content": "Hello from OpenFiles API!",
    "contentType": "text/plain"
  }'

const response = await fetch('https://api.openfiles.ai/functions/v1/api/files', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'oa_your_api_key_here'
  },
  body: JSON.stringify({
    path: 'hello-world.txt',
    content: 'Hello from OpenFiles API!',
    contentType: 'text/plain'
  })
})

const result = await response.json()
console.log(result)

import requests

url = "https://api.openfiles.ai/functions/v1/api/files"
headers = {
    "Content-Type": "application/json",
    "x-api-key": "oa_your_api_key_here"
}

data = {
    "path": "hello-world.txt",
    "content": "Hello from OpenFiles API!",
    "contentType": "text/plain"
}

response = requests.post(url, json=data, headers=headers)
result = response.json()
print(result)

3. Read Your File Back

Now let’s read the file we just created:

curl -X GET "https://api.openfiles.ai/functions/v1/api/files/hello-world.txt" \
  -H "x-api-key: oa_your_api_key_here"

const response = await fetch('https://api.openfiles.ai/functions/v1/api/files/hello-world.txt', {
  headers: {
    'x-api-key': 'oa_your_api_key_here'
  }
})

const file = await response.json()
console.log(file.data.content) // "Hello from OpenFiles API!"

import requests

url = "https://api.openfiles.ai/functions/v1/api/files/hello-world.txt"
headers = {"x-api-key": "oa_your_api_key_here"}

response = requests.get(url, headers=headers)
file = response.json()
print(file['data']['content'])  # "Hello from OpenFiles API!"

4. List All Your Files

See all files in your project:

curl -X GET "https://api.openfiles.ai/functions/v1/api/files" \
  -H "x-api-key: oa_your_api_key_here"

const response = await fetch('https://api.openfiles.ai/functions/v1/api/files', {
  headers: {
    'x-api-key': 'oa_your_api_key_here'
  }
})

const files = await response.json()
console.log(files.data.files)

import requests

url = "https://api.openfiles.ai/functions/v1/api/files"
headers = {"x-api-key": "oa_your_api_key_here"}

response = requests.get(url, headers=headers)
files = response.json()
print(files['data']['files'])

Core Concepts

File Paths

Use S3-style paths: documents/report.pdf ✅
No leading slashes: /documents/report.pdf ❌
Forward slashes on all platforms

Versioning

Every write creates a new version automatically
Access specific versions: GET /files/report.pdf?version=2
Version history: GET /files/report.pdf?versions

Content Types

Auto-detected from file extension
Or specify explicitly: "contentType": "application/json"
Supports text and binary files

Common Patterns

Organize Files with Folders

{
  "path": "projects/website/src/index.html",
  "content": "<!DOCTYPE html>...",
  "contentType": "text/html"
}

Edit Existing Files

{
  "oldString": "Hello World",
  "newString": "Hello OpenFiles"
}

Append to Log Files

{
  "content": "\n2025-01-15 10:30:00 - User logged in"
}

Next Steps

File Operations

Explore all 8 file operations

SDKs

Use our TypeScript or Python SDKs

Ready to build something amazing? Check out our complete API reference for all available operations!

​1. Get Your API Key

​2. Make Your First API Call

​3. Read Your File Back

​4. List All Your Files

​Core Concepts

​File Paths

​Versioning

​Content Types

​Common Patterns

​Organize Files with Folders

​Edit Existing Files

​Append to Log Files

​Next Steps