๐ Quick Start
1. Get Your API Key
- Go to Profile page in the app.
- Click โCreate API Keyโ.
- Give it a name (e.g., โAutomation Scriptโ).
- Copy the key immediately (you wonโt see it again!).
2. Make Your First Request
The endpoint is OpenAI-compatible, meaning you can use standard LLM libraries or simplecurl commands.
๐ API Reference
Endpoint: POST /api/v1/chat/completions
| Parameter | Type | Default | Description |
|---|---|---|---|
model | string | REQ | Identifier (e.g., openai/gpt-4o, grok/grok-beta) |
messages | array | REQ | Chat history (OpenAI format) |
system | string | Default Persona | Custom system prompt. If provided, it overrides all default behavior. |
stream | boolean | false | Enable/disable real-time streaming. |
web_search | boolean | true* | Enables tools. Defaults to true unless a custom system prompt is used. |
pii | string | disabled | Security mode: disabled, obfuscate, or block. |
temperature | number | 0.7 | Controls randomness (0.0 to 2.0). |
๐ Python Implementation Examples
Standard (Non-Streaming)
Advanced Streaming
Recommended for a better user experience in CLI or UI applications.JavaScript/Node.js Example
Tips
- Save Your API Key: You only see it once during creation
- Use HTTPS in Production: All examples use
https://onefirewall.aifor secure access. - Monitor Usage: Check your API key stats in the Profile page
- Choose Security Level: Set
piibased on your needs:- Development:
"disabled"(default) - Production:
"obfuscate"(recommended) - High security:
"block"
- Development:
- Model Selection: Use the same models available in the chat UI
- Custom Prompts: When you provide a
systemprompt, itโs used exclusively (no mixing with app prompts) - API Independence: The API works independently of team UI settings by design
Support
- View your API keys: Go to Profile page
- Delete a key: Click the trash icon next to the key
- Track usage: See request count and last used date in the key list

