Gate.AI›Blog›How to Integrate Gate.AI: A Quick Developer Onboarding Guide

    How to Integrate Gate.AI: A Quick Developer Onboarding Guide

    Guides

    Gate.AI API integration lets developers access a wide range of AI models through an OpenAI-compatible API. It provides unified model access, routing, and testing, without maintaining separate SDK configurations for each model provider. Whether you’re building a chatbot, internal tools, intelligent agents, workflow automation, or model evaluation scripts, the integration process is significantly simpler. This guide covers creating an API key, automatic routing, manual model selection, the OpenAI-compatible base URL, first-request testing, and troubleshooting common configuration mistakes. It does not cover advanced topics like enterprise-grade governance, billing strategy design, or custom security architectures.

    Prerequisites:

    • You have a Gate.AI account and access to Console settings.
    • Your local environment has Python, Node.js, or curl configured.

    What capabilities will you have after completing this guide?

    After completing this guide, you will be able to create a Gate.AI API key, configure the OpenAI-compatible base URL, send your first API request using model: "auto", and test a specified model ID.

    What applications can you build with Gate.AI API integration?

    Developers can use Gate.AI API integration to access a multi-model ecosystem using a unified OpenAI-compatible request format. Typical use cases include:

    Build type Gate.AI’s role Example output
    Chat applications Route user messages to supported chat models Customer support assistant
    Internal tools Standardize API configuration across teams AI writing/research assistant
    Intelligent agents and workflows Connect model calls with task automation Tool-calling assistant
    Model testing Compare auto routing vs. a fixed model ID Evaluation scripts
    Migration projects Replace an existing OpenAI-compatible base URL Multi-model prototype

    When you want Gate.AI to automatically choose a model, use model: "auto". If you need reproducible behavior for a specific model, provide the exact model ID.

    What do you need to prepare before you start?

    Before you begin, you only need to meet two key conditions:

    Prerequisite Why it matters
    Gate.AI account access You need to enter Console to create an API key and check routing settings
    Local request method You need to send test requests via Python, Node.js, or curl

    You do not need to choose all models at the start. First confirm that your API key and base URL work, then test manual model selection.

    Step 1: Create a Gate.AI API key

    In this step, you’ll create credentials for API authentication for your application.

    How to do it:

    1. Visit gate.ai.
    2. Choose a login method and complete authorization.
    3. Open Console → Settings → API keys.
    4. Click Create key.
    5. Copy the API key immediately and store it securely.

    You will see the new key in the API keys area. If the secret is shown only once, make sure you copy the key before you close the creation window.

    Step 2: Choose automatic routing or manual model selection

    This step determines whether Gate.AI assigns a model automatically, or whether you specify the model in the request.

    How to do it:

    1. Open Console → Settings → Routing.
    2. Check the Automatic routing toggle.
    3. If you want Gate.AI to automatically select a model for every request, keep automatic routing enabled.
    4. If you want to manually specify a model ID, turn off automatic routing and enter the model ID in the request body.
    Selection mode Request parameter value Suitable scenarios
    Automatic routing "model": "auto" When you need Gate.AI to auto-route requests
    Manual model selection "model": "anthropic/claude-sonnet-4.6" When you need to test or use a specific model ID

    Automatic routing is ideal for quick onboarding and general routing tests. Manual selection is for scenarios where you need reproducible evaluation on a single model.

    Step 3: Configure the OpenAI-compatible base URL

    This step points your existing OpenAI-style client to Gate.AI instead of the default OpenAI endpoint.

    Use the following base URL:

    1. https://api.gate.ai/openai/v1

    The authentication format is as follows:

    1. Authorization: Bearer YOUR_API_KEY

    Gate.AI documentation states that the API path is /openai/v1, not just /v1 (as of June 2026). Be sure to follow the example and enter the full base URL.

    Configuration item Value
    Base URL https://api.gate.ai/openai/v1
    Authentication method Authorization: Bearer YOUR_API_KEY
    Format OpenAI-compatible
    Chat endpoint POST /chat/completions
    Models list endpoint GET /models

    Most integration errors come from base URL abbreviations or copying the API key incorrectly. Confirm these two items first, then adjust your model configuration.

    Step 4: Send your first API request

    This step tests whether your API key, base URL, and OpenAI-compatible chat format work together.

    Python example:

    1. from openai import OpenAI
    2. client = OpenAI(
    3. api_key="YOUR_API_KEY",
    4. base_url="https://api.gate.ai/openai/v1",
    5. )
    6. completion = client.chat.completions.create(
    7. model="auto",
    8. messages=[
    9. {"role": "system", "content": "You are a concise assistant."},
    10. {"role": "user", "content": "Say hello from Gate.AI."}
    11. ],
    12. )
    13. print(completion.choices[0].message.content)

    Node.js example:

    1. import OpenAI from "openai";
    2. const client = new OpenAI({
    3. apiKey: "YOUR_API_KEY",
    4. baseURL: "https://api.gate.ai/openai/v1",
    5. });
    6. const completion = await client.chat.completions.create({
    7. model: "auto",
    8. messages: [
    9. { role: "system", content: "You are a concise assistant." },
    10. { role: "user", content: "Say hello from Gate.AI." }
    11. ],
    12. });
    13. console.log(completion.choices[0].message.content);

    curl example:

    1. curl https://api.gate.ai/openai/v1/chat/completions \
    2. -H "Authorization: Bearer YOUR_API_KEY" \
    3. -H "Content-Type: application/json" \
    4. -d '{
    5. "model": "auto",
    6. "messages": [
    7. {"role": "system", "content": "You are a concise assistant."},
    8. {"role": "user", "content": "Say hello from Gate.AI."}
    9. ]
    10. }'

    You should receive a normal assistant response. If you hit an authentication error, check the API key first. You don’t need to change your code right away.

    Step 5: Test a specified model ID

    This step verifies whether manual model selection takes effect when your application needs to specify a model.

    Change the model parameter from auto to a specific supported model ID:

    1. from openai import OpenAI
    2. client = OpenAI(
    3. api_key="YOUR_API_KEY",
    4. base_url="https://api.gate.ai/openai/v1",
    5. )
    6. completion = client.chat.completions.create(
    7. model="anthropic/claude-sonnet-4.6",
    8. messages=[
    9. {"role": "user", "content": "Explain model routing in one paragraph."}
    10. ],
    11. )
    12. print(completion.choices[0].message.content)

    Enter the model ID exactly as shown in the Gate.AI model documentation or in the model list. If you mistype it, the request will fail even if your API key and base URL are correct.

    How does Gate.AI’s automatic routing mechanism work in API requests?

    Gate.AI automatic routing works by setting model: "auto" in the request body and using the routing configuration in the Gate.AI console to choose a model automatically. As of June 2026, the relevant routing controls are managed in Console → Settings → Routing.

    Routing method Configuration location API request parameter
    Automatic routing Console → Settings → Routing "model": "auto"
    Manual model selection Request body Specify the model ID
    Routing strategy control Console routing settings Define organization-specific behavior

    Automatic routing is not the same as omitting the model field. You must include the model field in your request and set it to auto. Only then will Gate.AI route automatically.

    Which integration approach should you choose?

    Choose an integration method based on your runtime environment:

    Method Best for Key changes
    Python SDK Existing Python backend scripts or services Set base_url and api_key
    Node.js SDK JavaScript or TypeScript services Set baseURL and apiKey
    curl Fastest manual validation Send request headers and JSON payload directly
    Existing OpenAI-compatible apps Apps that already support a custom base URL Replace the base URL and API key

    Most developers recommend using curl to validate first, then integrating with Python or Node.js into your real application.

    What are common reasons Gate.AI API requests fail?

    If you get blocked during integration, troubleshoot step by step using the table below:

    Symptom Cause explanation Fix
    401 or invalid API key API key missing, expired, copied incorrectly, or not using Bearer authentication Recreate/copy the key, use Authorization: Bearer YOUR_API_KEY
    Model not found The request uses the wrong or unavailable model ID for your account Check the Gate.AI model documentation, or test with model: "auto" routing
    OpenAI-compatible code errors immediately Base URL is incomplete or you only provided /v1 Use https://api.gate.ai/openai/v1
    Automatic routing doesn’t work as expected Automatic routing is disabled or routing settings don’t match your expectations Turn on Console → Settings → Routing and check the automatic routing toggle
    Empty or abnormal response Request body format is wrong or the selected model doesn’t support the current request First test the simplest chat request, then add parameters gradually

    Start troubleshooting in this order: authentication, base URL, then model ID. Most quick onboarding issues can be solved with these three steps.

    What else can you configure next?

    Once your first request succeeds, you can expand integration in three directions:

    FAQ

    Why do you recommend using model: "auto" first?

    Using model: "auto" lets you validate the API key, base URL, request format, and routing configuration in one go. After confirming everything is correct, then test a specified model ID.

    Can I call Gate.AI using an existing OpenAI SDK?

    Yes. Gate.AI supports OpenAI-compatible API formats. All you need to do is set your Gate.AI API key and replace the base URL with https://api.gate.ai/openai/v1.

    Why does the request fail after switching to a specified model?

    The model ID may not exist, may be misspelled, or may not be supported by your current account. Confirm the model ID in the Gate.AI model documentation, then try again.

    Do I need to disable automatic routing when using a specified model?

    Not necessarily. When you need to manually select a model, you can pass the model ID directly in the request body. If the behavior doesn’t match your expectations, check the console routing settings.

    The content herein does not constitute any offer, solicitation, or recommendation. You should always seek independent professional advice before making any investment decisions. Please note that Gate may restrict or prohibit the use of all or a portion of the Services from Restricted Locations. For more information, please read the User Agreement