Documentation BYOM Setup

Bring Your Own Model (BYOM) Setup

Connect OpenAI or Anthropic to generate documentation using your own API keys.

Advanced Edition Feature

By default, Sync-O uses Google Gemini 2.0 Flash (provided free of charge). However, Advanced Edition subscribers can bring their own API keys for OpenAI or Anthropic to use specific models or maintain strict data boundaries.

Supported Providers & Models

Google Gemini
Default
  • Model: Gemini 2.0 Flash
  • Cost: Free (included)
  • Setup: None required
OpenAI
BYOM
  • Models: GPT-4o, GPT-4-turbo, GPT-3.5-turbo
  • Cost: Billed to your OpenAI account
  • Best for: Reasoning
Anthropic
BYOM
  • Models: Claude 3.5 Sonnet, Opus, Haiku
  • Cost: Billed to your Anthropic account
  • Best for: Nuance & Context

Setup Instructions

Step 1: Obtain Your API Key

For OpenAI users

  1. Log in to OpenAI Platform.
  2. Go to API Keys.
  3. Create a new secret key and copy it (starts with sk-...).

For Anthropic users

  1. Log in to Anthropic Console.
  2. Go to Settings → API Keys.
  3. Create a new key and copy it (starts with sk-ant-...).

Step 2: Configure Sync-O

  1. Navigate to Jira Admin → Apps → Sync-O → Configure.
  2. Open the AI Configuration tab.
  3. Select your provider (OpenAI or Anthropic) from the dropdown.
  4. Paste your API Key into the field.
  5. Click Test Key to verify connectivity.
    • Success: You will see a green checkmark.
    • Error: Check that your key is active and has credits.
  6. Select your preferred Model from the dropdown.
  7. Click Save Settings.

Security & Troubleshooting

Security Note: Your API keys are encrypted at rest using AWS KMS (Key Management Service). They are never logged in plain text and are only decrypted strictly for the purpose of processing your requests.

Common Issues

  • "Invalid Key": Check for accidental whitespace characters when copying the key.
  • "Rate Limit": Ensure your provider account has a valid payment method attached and is not out of credits.
  • Fallback Behavior: If your custom provider fails (e.g., downtime or rate limit), Sync-O will automatically failover to Gemini 2.0 Flash to ensure your documentation pipeline keeps working.