Jobim.ai Docs

Base URLs

Integrate Jobim.ai with your existing OpenAI SDK implementation by changing the base URL. Our API is fully compatible with OpenAI's SDK, making migration seamless.

1

Configure OpenAI SDK

Use Jobim.ai with your existing OpenAI SDK by simply changing the base URL to point to Jobim.ai's API endpoint:

JavaScript / TypeScript

import OpenAI from 'openai';

// Initialize the client with Jobim.ai's base URL
const openai = new OpenAI({
  baseURL: 'https://api.jobim.ai/v1',
  apiKey: 'YOUR_JOBIM_API_KEY',  // Get this from dashboard.jobim.ai
});

const messages = [
  { role: 'system', content: 'You are a helpful AI assistant...' },
  { role: 'user', content: 'Explain quantum computing in simple terms' },
];

const response = await openai.chat.completions.create({
  model: 'jobim-jfactor-utility',  // Use any Jobim.ai model
  messages: messages,
});

Python

from openai import OpenAI

# Initialize the client with Jobim.ai's base URL
client = OpenAI(
    base_url='https://api.jobim.ai/v1',
    api_key='YOUR_JOBIM_API_KEY'  # Get this from dashboard.jobim.ai
)

messages = [
    {'role': 'system', 'content': 'You are a helpful AI assistant...'},
    {'role': 'user', 'content': 'Explain quantum computing in simple terms'},
]

response = client.chat.completions.create(
    model='jobim-jfactor-utility',  # Use any Jobim.ai model
    messages=messages
)
2

Advanced Configuration

For enhanced features and provider-specific configurations, you can use additional headers with Jobim.ai:

Advanced Headers Configuration

import OpenAI from 'openai';

const openai = new OpenAI({
  baseURL: 'https://api.jobim.ai/v1',
  apiKey: 'YOUR_JOBIM_API_KEY',
  defaultHeaders: {
    // Provider authentication headers (optional)
    'X-Jobim-Provider-OpenAI': 'YOUR_OPENAI_API_KEY',
    'X-Jobim-Provider-Anthropic': 'YOUR_ANTHROPIC_API_KEY',
    'X-Jobim-Provider-Groq': 'YOUR_GROQ_API_KEY',
    'X-Jobim-Provider-Gemini': 'YOUR_GEMINI_API_KEY',
    'X-Jobim-Provider-Azure': 'YOUR_AZURE_API_KEY',
    
    // Jobim.ai feature headers
    'X-Jobim-Optimization': 'enabled',
    'X-Jobim-Fallback': 'enabled',
  }
});
Provider Headers
  • X-Jobim-Provider-OpenAI
  • X-Jobim-Provider-Anthropic
  • X-Jobim-Provider-Groq
  • X-Jobim-Provider-Gemini
Feature Headers
  • X-Jobim-Optimization
  • X-Jobim-Fallback
  • X-Jobim-Cache
  • X-Jobim-Metrics
!

Base URL Approach Limitations

While using the base URL approach is simple for existing OpenAI integrations, you'll miss out on some Jobim.ai exclusive features:

  • •Limited Automatic Fallbacks: Requests may fail instead of automatically falling back to optimized providers
  • •No JOBIM Optimization: Missing advanced performance optimizations and cost savings
  • •Manual Configuration: You'll need to handle model selection and provider routing manually
  • •Limited Observability: Reduced access to advanced metrics and monitoring features

For production applications requiring maximum reliability and performance, we recommend using Jobim.ai's native SDK when available.

3

Available Endpoints

Primary Endpoints

/v1/chat/completionsAvailable
/v1/completionsAvailable
/v1/embeddingsAvailable
/v1/modelsAvailable

Jobim.ai Exclusive

/v1/optimizeNative SDK
/v1/analyticsNative SDK
/v1/jobim-metricsNative SDK
/v1/batchComing Soon

🚀 Recommended Next Steps

Choose the integration method that best fits your needs:

Base URL Approach

Quick integration for existing OpenAI projects

• Fast setup

• OpenAI compatibility

• Good for prototyping

Native Integration

Full access to Jobim.ai features and optimizations

• Automatic fallbacks

• Advanced optimizations

• Production ready

Explore ModelsAPI ReferenceJOBIM Features