Integração direta com o OpenAI SDK

AI Gateway

Encaminhe suas chamadas de LLM pelo AI Gateway alterando apenas a URL base. Sem dependência de fornecedor: execute sempre o melhor modelo pelo menor custo para o seu caso de uso.

Observabilidade

Instrumente seu código com OpenTelemetry para capturar traces, logs e métricas de cada chamada de LLM, etapa de agente e uso de ferramenta.

AI Gateway

Visão geral

O OpenAI SDK oferece ferramentas poderosas para criar aplicações de IA com modelos GPT. Ao conectar o SDK ao AI Gateway do Toqan Router, você transforma sua integração com a OpenAI em um sistema pronto para produção, com recursos de nível empresarial, observabilidade completa e acesso a mais de 500 modelos de mais de 30 provedores.

Principais benefícios

O AI Gateway do Toqan Router aprimora seu OpenAI SDK com:

Observabilidade completa

Acompanhe cada chamada de API, uso de tokens e interação com modelos com traces e análises detalhados

Confiabilidade integrada

Fallbacks automáticos, novas tentativas e balanceamento de carga para resiliência em produção

Otimização de custos

Rastreamento de custos em tempo real e gestão de gastos em todas as suas operações de IA

Acesso a vários provedores

Acesse mais de 500 LLMs e mais de 30 provedores por meio de uma única integração unificada

Pré-requisitos

Antes de integrar o OpenAI SDK ao Toqan Router, verifique se você tem:

Uma conta no Toqan Router e uma chave de API
Python 3.8+ ou Node.js 18+ com suporte a TypeScript
O OpenAI SDK instalado

Para configurar sua chave de API, consulte Chaves de API e endpoints.

Para usar bibliotecas com modelos privados, consulte Integração de modelos privados.

Para migrar passo a passo uma aplicação existente com o OpenAI SDK, consulte Migrar para o Toqan Router.

Instalação

pip install openai

npm install openai

Configuração

Ao usar o OpenAI SDK, defina a Base URL como o AI Gateway para enviar as chamadas pela nossa API sem alterar nenhuma outra parte do seu código. Com o Toqan Router AI Gateway, você aproveita os Traces da plataforma e o monitoramento de custos e uso, mantendo total compatibilidade e uma API unificada para todos os modelos enquanto usa o OpenAI SDK.

base_url: https://router.toqan.ai/eu/v3/router

Geração de texto

Geração de texto básica com o OpenAI SDK pelo Toqan Router:

import OpenAI from "openai";

const openai = new OpenAI({
  baseURL: "https://router.toqan.ai/eu/v3/router",
  apiKey: process.env.TOQAN_API_KEY,
});

const response = await openai.responses.create({
  model: "openai/gpt-5.6-sol",
  instructions: "You are a helpful assistant.",
  input: "Hello!",
});

console.log(response.output_text);

from openai import OpenAI
import os

client = OpenAI(
    base_url="https://router.toqan.ai/eu/v3/router",
    api_key=os.environ.get("TOQAN_API_KEY"),
)

response = client.responses.create(
    model="openai/gpt-5.6-sol",
    instructions="You are a helpful assistant.",
    input="Hello!",
)

print(response.output_text)

import OpenAI from "openai";

const openai = new OpenAI({
  baseURL: "https://router.toqan.ai/eu/v3/router",
  apiKey: process.env.TOQAN_API_KEY,
});

const completion = await openai.chat.completions.create({
  model: "openai/gpt-5.6-sol",
  messages: [
    { role: "system", content: "You are a helpful assistant." },
    { role: "user", content: "Hello!" },
  ],
});

console.log(completion.choices[0].message.content);

from openai import OpenAI
import os

client = OpenAI(
    base_url="https://router.toqan.ai/eu/v3/router",
    api_key=os.environ.get("TOQAN_API_KEY"),
)

completion = client.chat.completions.create(
    model="openai/gpt-5.6-sol",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Hello!"},
    ],
)

print(completion.choices[0].message.content)

Respostas em streaming

Faça streaming das respostas para obter saída em tempo real:

import OpenAI from "openai";

const openai = new OpenAI({
  baseURL: "https://router.toqan.ai/eu/v3/router",
  apiKey: process.env.TOQAN_API_KEY,
});

const stream = await openai.responses.create({
  model: "openai/gpt-5.6-sol",
  input: "Write a short story about robots.",
  stream: true,
});

for await (const event of stream) {
  if (event.type === "response.output_text.delta") {
    process.stdout.write(event.delta);
  }
}

from openai import OpenAI
import os

client = OpenAI(
    base_url="https://router.toqan.ai/eu/v3/router",
    api_key=os.environ.get("TOQAN_API_KEY"),
)

stream = client.responses.create(
    model="openai/gpt-5.6-sol",
    input="Write a short story about robots.",
    stream=True,
)

for event in stream:
    if event.type == "response.output_text.delta":
        print(event.delta, end="", flush=True)

import OpenAI from "openai";

const openai = new OpenAI({
  baseURL: "https://router.toqan.ai/eu/v3/router",
  apiKey: process.env.TOQAN_API_KEY,
});

const stream = await openai.chat.completions.create({
  model: "openai/gpt-5.6-sol",
  messages: [{ role: "user", content: "Write a short story about robots." }],
  stream: true,
});

for await (const chunk of stream) {
  process.stdout.write(chunk.choices[0]?.delta?.content || "");
}

from openai import OpenAI
import os

client = OpenAI(
    base_url="https://router.toqan.ai/eu/v3/router",
    api_key=os.environ.get("TOQAN_API_KEY"),
)

stream = client.chat.completions.create(
    model="openai/gpt-5.6-sol",
    messages=[{"role": "user", "content": "Write a short story about robots."}],
    stream=True,
)

for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

Seleção de modelo

Com o Toqan Router, você pode usar qualquer modelo compatível de mais de 30 provedores:

import OpenAI from "openai";

const openai = new OpenAI({
  baseURL: "https://router.toqan.ai/eu/v3/router",
  apiKey: process.env.TOQAN_API_KEY,
});

const claudeResponse = await openai.responses.create({
  model: "anthropic/claude-sonnet-5",
  input: "Explain machine learning",
});

const geminiResponse = await openai.responses.create({
  model: "google/gemini-2.5-flash",
  input: "Explain machine learning",
});

const groqResponse = await openai.responses.create({
  model: "groq/qwen/qwen3.8-27b",
  input: "Explain machine learning",
});

from openai import OpenAI
import os

client = OpenAI(
    base_url="https://router.toqan.ai/eu/v3/router",
    api_key=os.environ.get("TOQAN_API_KEY"),
)

claude_response = client.responses.create(
    model="anthropic/claude-sonnet-5",
    input="Explain machine learning",
)

gemini_response = client.responses.create(
    model="google/gemini-2.5-flash",
    input="Explain machine learning",
)

groq_response = client.responses.create(
    model="groq/qwen/qwen3.8-27b",
    input="Explain machine learning",
)

Observabilidade

Primeiros passos

Integre o OpenAI SDK à observabilidade do Toqan Router para obter uma visão completa do desempenho dos modelos, do uso de tokens, da latência da API e dos fluxos de conversa usando OpenTelemetry.

Pré-requisitos

Antes de começar, verifique se você tem:

Uma conta no Toqan Router e uma chave de API
Python 3.8+ ou Node.js 18+
O OpenAI SDK instalado

Instale as dependências

# Core OpenTelemetry packages
pip install opentelemetry-sdk opentelemetry-instrumentation opentelemetry-exporter-otlp

# OpenAI SDK
pip install openai

# OpenAI Auto-Instrumentation
pip install opentelemetry-instrumentation-openai

# OpenTelemetry SDK (includes all core packages)
npm install @opentelemetry/sdk-node @opentelemetry/api @opentelemetry/exporter-trace-otlp-http

# OpenAI SDK
npm install openai

# OpenAI Auto-Instrumentation
npm install @opentelemetry/instrumentation-openai

Configure o Toqan Router

Configure suas variáveis de ambiente para se conectar ao coletor OpenTelemetry do Toqan Router: Unix/Linux/macOS:

export OTEL_EXPORTER_OTLP_ENDPOINT="https://router.toqan.ai/eu/v2/otel"
export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer $TOQAN_API_KEY"
export OTEL_RESOURCE_ATTRIBUTES="service.name=openai-app,service.version=1.0.0"
export OTEL_EXPORTER_OTLP_TRACES_PROTOCOL="http/json"

Windows (PowerShell):

$env:OTEL_EXPORTER_OTLP_ENDPOINT = "https://router.toqan.ai/eu/v2/otel"
$env:OTEL_EXPORTER_OTLP_HEADERS = "Authorization=Bearer <TOQAN_API_KEY>"
$env:OTEL_RESOURCE_ATTRIBUTES = "service.name=openai-app,service.version=1.0.0"
$env:OTEL_EXPORTER_OTLP_TRACES_PROTOCOL = "http/json"

Usando um arquivo .env:

OTEL_EXPORTER_OTLP_ENDPOINT=https://router.toqan.ai/eu/v2/otel
OTEL_EXPORTER_OTLP_HEADERS=Authorization=Bearer <TOQAN_API_KEY>
OTEL_RESOURCE_ATTRIBUTES=service.name=openai-app,service.version=1.0.0
OTEL_EXPORTER_OTLP_TRACES_PROTOCOL=http/json

Configuração inicial

Configure o OpenTelemetry uma única vez na inicialização da aplicação:

from openai import OpenAI
from opentelemetry import trace
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor
from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
from opentelemetry.instrumentation.openai import OpenAIInstrumentor
import os

# Configure OpenTelemetry
tracer_provider = TracerProvider()
tracer_provider.add_span_processor(BatchSpanProcessor(OTLPSpanExporter()))
trace.set_tracer_provider(tracer_provider)

# Instrument OpenAI
OpenAIInstrumentor().instrument(tracer_provider=tracer_provider)

# Create OpenAI client
client = OpenAI(
    base_url="https://router.toqan.ai/eu/v3/router",
    api_key=os.environ.get("TOQAN_API_KEY")
)

import { NodeSDK } from "@opentelemetry/sdk-node";
import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
import { OpenAIInstrumentation } from "@opentelemetry/instrumentation-openai";
import OpenAI from "openai";

// Initialize SDK
const sdk = new NodeSDK({
  traceExporter: new OTLPTraceExporter(),
  instrumentations: [new OpenAIInstrumentation()],
});

sdk.start();

// Graceful shutdown
process.on("SIGTERM", () => {
  sdk.shutdown()
    .then(() => console.log("Tracing terminated"))
    .catch((error) => console.log("Error terminating tracing", error))
    .finally(() => process.exit(0));
});

// Create OpenAI client
const client = new OpenAI({
  baseURL: "https://router.toqan.ai/eu/v3/router",
  apiKey: process.env.TOQAN_API_KEY,
});

Exemplos

Os exemplos abaixo usam o endpoint Chat Completions. A instrumentação do OpenTelemetry funciona da mesma forma com a Responses API: substitua client.chat.completions.create(...) por client.responses.create(...).

Exemplo básico

from openai import OpenAI
import os

client = OpenAI(
    base_url="https://router.toqan.ai/eu/v3/router",
    api_key=os.environ.get("TOQAN_API_KEY"),
)

response = client.chat.completions.create(
    model="openai/gpt-5.6-sol",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "What is quantum computing in one sentence?"}
    ]
)

print(response.choices[0].message.content)

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.TOQAN_API_KEY,
  baseURL: "https://router.toqan.ai/eu/v3/router",
});

const response = await client.chat.completions.create({
  model: "openai/gpt-5.6-sol",
  messages: [
    { role: "system", content: "You are a helpful assistant." },
    { role: "user", content: "What is quantum computing in one sentence?" },
  ],
});

console.log(response.choices[0].message.content);

Exemplo de streaming

from openai import OpenAI
from opentelemetry import trace
import os

client = OpenAI(
    base_url="https://router.toqan.ai/eu/v3/router",
    api_key=os.environ.get("TOQAN_API_KEY"),
)

tracer = trace.get_tracer(__name__)
with tracer.start_as_current_span("streaming-completion") as span:
    stream = client.chat.completions.create(
        model="openai/gpt-5.6-sol",
        messages=[{"role": "user", "content": "Write a haiku about code."}],
        stream=True
    )

    full_response = ""
    for chunk in stream:
        if chunk.choices and chunk.choices[0].delta.content:
            content = chunk.choices[0].delta.content
            full_response += content
            print(content, end="", flush=True)

    span.set_attribute("response.length", len(full_response))

import OpenAI from "openai";
import { trace } from "@opentelemetry/api";

const client = new OpenAI({
  apiKey: process.env.TOQAN_API_KEY,
  baseURL: "https://router.toqan.ai/eu/v3/router",
});

const tracer = trace.getTracer("openai-app");

await tracer.startActiveSpan("streaming-completion", async (span) => {
  try {
    const stream = await client.chat.completions.create({
      model: "openai/gpt-5.6-sol",
      messages: [{ role: "user", content: "Write a haiku about code." }],
      stream: true,
    });

    let fullResponse = "";
    for await (const chunk of stream) {
      const content = chunk.choices[0]?.delta?.content;
      if (content) {
        fullResponse += content;
        process.stdout.write(content);
      }
    }

    span.setAttribute("response.length", fullResponse.length);
  } finally {
    span.end();
  }
});

Exemplo de spans personalizados

from openai import OpenAI
from opentelemetry import trace
import os

client = OpenAI(
    base_url="https://router.toqan.ai/eu/v3/router",
    api_key=os.environ.get("TOQAN_API_KEY"),
)

tracer = trace.get_tracer(__name__)

def analyze_document(document: str):
    with tracer.start_as_current_span("document-analysis") as span:
        span.set_attribute("document.length", len(document))

        # Prepare prompt
        prompt = f"Analyze this text: {document}"
        with tracer.start_as_current_span("prepare-prompt") as prep_span:
            prep_span.set_attribute("prompt.length", len(prompt))

        # Model inference
        with tracer.start_as_current_span("model-inference") as inf_span:
            inf_span.set_attribute("model", "gpt-5.6-sol")

            response = client.chat.completions.create(
                model="openai/gpt-5.6-sol",
                messages=[{"role": "user", "content": prompt}]
            )

            inf_span.set_attribute("tokens.total", response.usage.total_tokens)

        # Process result
        with tracer.start_as_current_span("process-result") as proc_span:
            result = response.choices[0].message.content
            proc_span.set_attribute("result.length", len(result))

        return result

analysis = analyze_document("Machine learning is a subset of AI.")
print(analysis)

import OpenAI from "openai";
import { trace } from "@opentelemetry/api";

const client = new OpenAI({
  apiKey: process.env.TOQAN_API_KEY,
  baseURL: "https://router.toqan.ai/eu/v3/router",
});

const tracer = trace.getTracer("openai-app");

async function analyzeDocument(document: string) {
  return await tracer.startActiveSpan("document-analysis", async (span) => {
    try {
      span.setAttribute("document.length", document.length);

      // Prepare prompt
      const prompt = `Analyze this text: ${document}`;
      await tracer.startActiveSpan("prepare-prompt", async (prepSpan) => {
        try {
          prepSpan.setAttribute("prompt.length", prompt.length);
        } finally {
          prepSpan.end();
        }
      });

      // Model inference
      let response: Awaited<ReturnType<typeof client.chat.completions.create>>;
      await tracer.startActiveSpan("model-inference", async (infSpan) => {
        try {
          infSpan.setAttribute("model", "gpt-5.6-sol");

          response = await client.chat.completions.create({
            model: "openai/gpt-5.6-sol",
            messages: [{ role: "user", content: prompt }],
          });

          infSpan.setAttribute("tokens.total", response.usage?.total_tokens || 0);
        } finally {
          infSpan.end();
        }
      });

      // Process result
      await tracer.startActiveSpan("process-result", async (procSpan) => {
        try {
          const result = response!.choices[0].message.content || "";
          procSpan.setAttribute("result.length", result.length);
        } finally {
          procSpan.end();
        }
      });

      return response!.choices[0].message.content;
    } finally {
      span.end();
    }
  });
}

analyzeDocument("Machine learning is a subset of AI.")
  .then((analysis) => console.log(analysis));

Exemplo de fluxos de trabalho avançados

from openai import OpenAI
from opentelemetry import trace
import os

client = OpenAI(
    base_url="https://router.toqan.ai/eu/v3/router",
    api_key=os.environ.get("TOQAN_API_KEY"),
)

tracer = trace.get_tracer(__name__)

def content_generation_pipeline(topic: str):
    with tracer.start_as_current_span("content-pipeline") as pipeline_span:
        pipeline_span.set_attribute("pipeline.topic", topic)
        pipeline_span.set_attribute("pipeline.stages", 3)

        # Stage 1: Research
        with tracer.start_as_current_span("stage-research") as research_span:
            research_span.set_attribute("stage.name", "research")

            research = client.chat.completions.create(
                model="openai/gpt-5.6-sol",
                messages=[{"role": "user", "content": f"List 3 key facts about {topic}."}]
            )

            facts = research.choices[0].message.content
            research_span.set_attribute("facts.count", 3)
            research_span.set_attribute("tokens.used", research.usage.total_tokens)

        # Stage 2: Writing
        with tracer.start_as_current_span("stage-writing") as writing_span:
            writing_span.set_attribute("stage.name", "writing")

            writing = client.chat.completions.create(
                model="openai/gpt-5.6-sol",
                messages=[{"role": "user", "content": f"Write a brief introduction using these facts: {facts}"}]
            )

            content = writing.choices[0].message.content
            writing_span.set_attribute("content.length", len(content))

        # Stage 3: Review
        with tracer.start_as_current_span("stage-review") as review_span:
            review_span.set_attribute("stage.name", "review")

            review = client.chat.completions.create(
                model="openai/gpt-5.6-sol",
                messages=[{"role": "user", "content": f"Rate this content quality 1-10: {content}"}]
            )

            rating = review.choices[0].message.content
            review_span.set_attribute("quality.rating", rating)

        pipeline_span.set_attribute("pipeline.success", True)
        return {"content": content, "rating": rating}

result = content_generation_pipeline("neural networks")
print(f"Content: {result['content']}")
print(f"Rating: {result['rating']}")

import OpenAI from "openai";
import { trace } from "@opentelemetry/api";

const client = new OpenAI({
  apiKey: process.env.TOQAN_API_KEY,
  baseURL: "https://router.toqan.ai/eu/v3/router",
});

const tracer = trace.getTracer("openai-app");

async function contentGenerationPipeline(topic: string) {
  return await tracer.startActiveSpan("content-pipeline", async (pipelineSpan) => {
    try {
      pipelineSpan.setAttribute("pipeline.topic", topic);
      pipelineSpan.setAttribute("pipeline.stages", 3);

      let facts = "";
      let content = "";
      let rating = "";

      // Stage 1: Research
      await tracer.startActiveSpan("stage-research", async (researchSpan) => {
        try {
          researchSpan.setAttribute("stage.name", "research");

          const research = await client.chat.completions.create({
            model: "openai/gpt-5.6-sol",
            messages: [{ role: "user", content: `List 3 key facts about ${topic}.` }],
          });

          facts = research.choices[0].message.content || "";
          researchSpan.setAttribute("facts.count", 3);
          researchSpan.setAttribute("tokens.used", research.usage?.total_tokens || 0);
        } finally {
          researchSpan.end();
        }
      });

      // Stage 2: Writing
      await tracer.startActiveSpan("stage-writing", async (writingSpan) => {
        try {
          writingSpan.setAttribute("stage.name", "writing");

          const writing = await client.chat.completions.create({
            model: "openai/gpt-5.6-sol",
            messages: [{ role: "user", content: `Write a brief introduction using these facts: ${facts}` }],
          });

          content = writing.choices[0].message.content || "";
          writingSpan.setAttribute("content.length", content.length);
        } finally {
          writingSpan.end();
        }
      });

      // Stage 3: Review
      await tracer.startActiveSpan("stage-review", async (reviewSpan) => {
        try {
          reviewSpan.setAttribute("stage.name", "review");

          const review = await client.chat.completions.create({
            model: "openai/gpt-5.6-sol",
            messages: [{ role: "user", content: `Rate this content quality 1-10: ${content}` }],
          });

          rating = review.choices[0].message.content || "";
          reviewSpan.setAttribute("quality.rating", rating);
        } finally {
          reviewSpan.end();
        }
      });

      pipelineSpan.setAttribute("pipeline.success", true);
      return { content, rating };
    } finally {
      pipelineSpan.end();
    }
  });
}

contentGenerationPipeline("neural networks")
  .then((result) => {
    console.log(`Content: ${result.content}`);
    console.log(`Rating: ${result.rating}`);
  });

Visualize os traces

Veja seus traces no AI Studio, na aba Traces.

Acesse seu AI Studio para ver análises e traces em tempo real.

Visão geral

Instrumente seu app

Explorar

Monitorar

Exportar

Revisar

Privacidade e segurança de dados

Integrações com frameworks

AI Gateway

Observabilidade

AI Gateway

Visão geral

Principais benefícios

Observabilidade completa

Confiabilidade integrada

Otimização de custos

Acesso a vários provedores

Pré-requisitos

Instalação

Configuração

Geração de texto

Respostas em streaming

Seleção de modelo

Observabilidade

Primeiros passos

Pré-requisitos

Instale as dependências

Configure o Toqan Router

Configuração inicial

Exemplos

Exemplo básico

Exemplo de streaming

Exemplo de spans personalizados

Exemplo de fluxos de trabalho avançados

Visualize os traces

AI Gateway

Observabilidade

​AI Gateway

​Visão geral

​Principais benefícios

Observabilidade completa

Confiabilidade integrada

Otimização de custos

Acesso a vários provedores

​Pré-requisitos

​Instalação

​Configuração

​Geração de texto

​Respostas em streaming

​Seleção de modelo

​Observabilidade

​Primeiros passos

​Pré-requisitos

​Instale as dependências

​Configure o Toqan Router

​Configuração inicial

​Exemplos

​Exemplo básico

​Exemplo de streaming

​Exemplo de spans personalizados

​Exemplo de fluxos de trabalho avançados

​Visualize os traces

AI Gateway

Visão geral

Principais benefícios

Pré-requisitos

Instalação

Configuração

Geração de texto

Respostas em streaming

Seleção de modelo

Observabilidade

Primeiros passos

Pré-requisitos

Instale as dependências

Configure o Toqan Router

Configuração inicial

Exemplos

Exemplo básico

Exemplo de streaming

Exemplo de spans personalizados

Exemplo de fluxos de trabalho avançados

Visualize os traces