Skip to main content

Quick Start

1. Get Your API Key

  1. Go to the Profile page in the app.
  2. Click Create API Key.
  3. Give it a name (e.g., “Automation Script”).
  4. Copy the key immediately. It is not shown again.

2. Make Your First Request

The endpoint is OpenAI-compatible, meaning you can use standard LLM libraries or simple curl commands.

API Reference

Endpoint: POST /api/v1/chat/completions


Python Examples

Standard (Non-Streaming)

Streaming

Use stream: true to receive tokens as they’re generated, useful for CLI or UI applications.

JavaScript / Node.js Example


Tips

  1. HTTPS only: all examples use https://onefirewall.ai; there is no unencrypted endpoint.
  2. pii level: disabled for development (default), obfuscate for production, block where sensitive data must never reach the model.
  3. Model selection: use the same model IDs available in the chat UI.
  4. Custom prompts: a system prompt you provide replaces the default persona entirely — it is not merged with it.
  5. API independence: the API does not read team UI settings; behavior is controlled entirely by request parameters.

Managing API Keys

  • View keys: Profile page.
  • Delete a key: click the trash icon next to it in the key list.
  • Usage: request count and last-used date are shown per key in the same list.