Skip to main content

​
OpenAI API Compatible Configuration

OpenAI Compatible Configuration Interface The OpenAI API Compatible configuration screen in Novaplan AI where you’ll enter your endpoint URL, API Key, and Model Name Novaplan AI can connect to an LLM provider with a compatible OpenAI-style chat API, including services such as Together AI, DeepSeek, OpenRouter, or an approved model server. Providers differ in supported endpoints and parameters; confirm the chosen model and connection from the managed workspace.

​
Required Fields

​
Endpoint URL *

The Endpoint URL is the base API endpoint for your OpenAI-compatible service. Common endpoint examples: Important: Enter the base path documented by the selected provider. Many providers use /v1/, but this is not universal: DeepSeek currently documents https://api.deepseek.com without that suffix. Novaplan AI appends the paths needed for its requests. Confirm the value from the managed workspace before relying on the connection.

​
API Key *

The API Key is required to authenticate your requests to the OpenAI-compatible service. How to obtain an API Key:
  1. Sign up or log in to your chosen provider’s platform
  2. Navigate to the API Keys or Settings section
  3. Create a new API key
  4. Copy the key immediately (most providers only show it once)
Security note: Treat this API key as a secret. Use the approved workspace setup flow, and coordinate access and rotation with Novaplan and your provider administrator.

​
Model Name *

The Model Name field defines which specific model you want to use from your provider. Example model names by provider: Together AI examples:
  • MiniMaxAI/MiniMax-M3
  • openai/gpt-oss-120b
These are examples from Together AI’s current documentation. Choose a model ID that is available to your account at setup time. How to choose a model:
  • Check your provider’s model catalog for available options
  • Consider factors like context length, speed, and cost
  • Verify the model name matches exactly as listed by the provider
  • Test with smaller models first before scaling to larger ones

​
Optional Features

​
Multimodal

Enable this checkbox if your selected model supports multimodal input (text + images). When to enable:
  • Your model explicitly supports vision/image understanding
  • You need to process documents with images or screenshots
  • You want to analyze visual content alongside text
Note: Not all models support multimodal capabilities. Check your provider’s documentation to confirm whether your chosen model includes vision support.

​
Reasoning

Enable this checkbox if your selected model has enhanced reasoning capabilities. When to enable:
  • Your selected model and provider explicitly support a reasoning mode
  • You need advanced problem-solving capabilities
  • Your use case involves mathematical or logical reasoning
Note: Reasoning models typically have different pricing and may take longer to generate responses due to their enhanced thinking process.

​
Configuration Steps

As shown in the image above:
  1. Select “OpenAI API Compatible” as your Provider Type from the dropdown
  2. Enter the Endpoint URL for your chosen provider (marked with *)
  3. Enter your API Key in the designated field (marked with *)
  4. Specify the exact Model Name as listed by your provider (marked with *)
  5. (Optional) Check “Multimodal” if your model supports image input
  6. (Optional) Check “Reasoning” if your model has enhanced reasoning capabilities
  7. Click “Add Model” to complete the setup
All fields marked with an asterisk (*) are required to successfully configure the OpenAI-compatible integration. You must complete these fields to proceed with the setup.

​
Supported Providers

The configuration can work with providers that implement the chat endpoints and parameters Novaplan AI uses. Check the provider’s documentation and test the connection before relying on it. Examples to evaluate include:
  • Together AI - Access to various open-source models with fast inference
  • Groq - Ultra-fast inference with open-source models
  • Perplexity - Online and offline models with search capabilities
  • Anyscale - Enterprise-grade model serving
  • OpenRouter - Unified interface to multiple LLM providers
  • Fireworks AI - Fast inference for open-source models
  • Deepinfra - Cost-effective access to open-source models
  • Local providers - Self-hosted solutions like vLLM, Ollama with OpenAI compatibility

​
Usage Considerations

  • API usage will count against your provider’s account quota and billing
  • Different providers and models have different pricing structures
  • Response times vary by provider and model size
  • Ensure your endpoint supports the OpenAI API format (chat completions, embeddings, etc.)
  • Some providers may have rate limits - check your plan details
  • Context window sizes vary by model - verify limits for your use case

​
Troubleshooting

Connection Issues:
  • Verify the endpoint URL matches the provider’s documented base path; do not add /v1/ unless that provider requires it
  • Ensure your endpoint URL uses https:// for secure connections
  • Check that the endpoint is accessible from the managed Novaplan AI environment
Authentication Errors:
  • Verify your API key is correct and has not expired
  • Ensure your API key has the necessary permissions for chat completions
  • Check that your provider account has billing set up (if required)
Model Not Found:
  • Confirm the model name exactly matches your provider’s naming convention
  • Verify that your account has access to the specified model
  • Check if the model requires special access or waitlist approval
Response Errors:
  • Ensure the selected model is currently available (not deprecated)
  • Verify that multimodal/reasoning flags match the model’s actual capabilities
  • Check your provider’s status page for any ongoing issues
For additional support, refer to your provider’s documentation or contact Novaplan AI support.