Documentation BYOM Setup

Bring Your Own Model (BYOM) Setup

Connect OpenAI, Anthropic, or Google Gemini (via Regular API or Vertex AI) to generate documentation using your own keys.

Advanced Edition Feature

By default, Sync-o uses Google's latest Gemini model (provided free of charge via Vertex AI). However, Advanced Edition subscribers can bring their own keys for OpenAI, Anthropic, or Google Gemini (via Regular API or Vertex AI) to use specific models or maintain strict data boundaries.

Supported Providers & Models

Google Gemini
Default
  • Model: Latest Gemini (auto-updated)
  • Cost: Free (included)
  • Setup: None required
  • Infra: Vertex AI
Google Gemini
BYOM
  • Options: Regular API or Vertex AI
  • Cost: Billed to your Google account
  • Best for: Google-native teams
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-...).

For Google Gemini users — Option A: Regular API

  1. Go to Google AI Studio.
  2. Click Create API Key and select a Google Cloud project.
  3. Copy the generated API key.
  4. Paste it into the API key field in Sync-o.

For Google Gemini users — Option B: Vertex AI

  1. Go to the Google Cloud Console.
  2. Create a Service Account with Vertex AI permissions.
  3. Generate a JSON key file for the service account.
  4. Paste the entire JSON contents into the credentials field.

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, Anthropic, or Google Gemini) 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 the default Gemini model to ensure your documentation pipeline keeps working.
Back to Documentation Contact Support