SDK Overview

// OpenAI integration
import OpenAI from '@openfiles-ai/sdk/openai'

// Tools integration
import { OpenFilesTools } from '@openfiles-ai/sdk/tools'

// Core client
import { OpenFilesClient } from '@openfiles-ai/sdk/core'

# OpenAI integration
from openfiles_ai import OpenAI

# Tools integration
from openfiles_ai.tools import OpenFilesTools

# Core client
from openfiles_ai import OpenFilesClient

const ai = new OpenAI({
  apiKey: string,                    // OpenAI API key (required)
  openFilesApiKey: string,           // OpenFiles API key (required)  
  basePath?: string,                 // File path prefix (optional)
  timeout?: number,                  // Request timeout ms (default: 60000)
  maxRetries?: number                // Failed request retries (default: 3)
})

ai = OpenAI(
    api_key='sk-...',                # OpenAI API key (required)
    openfiles_api_key='oa-...',      # OpenFiles API key (required)
    base_path='my-project',          # File path prefix (optional)
    timeout=60000,                   # Request timeout ms (default: 60000)
    max_retries=3                    # Failed request retries (default: 3)
)

const tools = new OpenFilesTools({
  apiKey: string,                    // OpenFiles API key (required)
  basePath?: string,                 // File path prefix (optional)
  timeout?: number,                  // Request timeout ms (default: 60000)
  maxRetries?: number                // Failed request retries (default: 3)
})

// Access provider-specific tools
tools.openai.definitions           // OpenAI tool definitions
tools.anthropic.definitions        // Anthropic tool definitions

tools = OpenFilesTools(
    api_key='oa-...',                # OpenFiles API key (required)
    base_path='my-project',          # File path prefix (optional)
    timeout=60000,                   # Request timeout ms (default: 60000)
    max_retries=3                    # Failed request retries (default: 3)
)

# Access provider-specific tools
tools.openai.definitions           # OpenAI tool definitions
tools.anthropic.definitions        # Anthropic tool definitions

const client = new OpenFilesClient({
  apiKey: string,                    // OpenFiles API key (required)
  baseUrl?: string,                  // API base URL (default: https://api.openfiles.ai/functions/v1/api)
  basePath?: string,                 // File path prefix (optional) 
  timeout?: number,                  // Request timeout ms (default: 60000)
  maxRetries?: number                // Failed request retries (default: 3)
})

client = OpenFilesClient(
    api_key='oa-...',                # OpenFiles API key (required)
    base_url='https://api.openfiles.ai/functions/v1/api',  # API base URL
    base_path='my-project',          # File path prefix (optional)
    timeout=60000,                   # Request timeout ms (default: 60000)
    max_retries=3                    # Failed request retries (default: 3)
)

import { FileOperationError } from '@openfiles-ai/sdk/core'

try {
  await client.writeFile({ path: 'file.txt', content: 'hello' })
} catch (error) {
  if (error instanceof FileOperationError) {
    console.log(error.statusCode)  // HTTP status
    console.log(error.code)        // Error code
    console.log(error.message)     // Error description
  }
}

from openfiles_ai.exceptions import FileOperationError

try:
    await client.write_file(path='file.txt', content='hello')
except FileOperationError as error:
    print(error.status_code)  # HTTP status
    print(error.code)         # Error code
    print(error.message)      # Error description