Send Your First AI Request via the Portrix Gateway

This guide walks you through making a live request to an AI model via Portrix. Whether you prefer the command line, Python, or JavaScript, you’ll have a working request running in under five minutes — with access to 400+ models through a single endpoint.

Before you begin

Prerequisites

A Portrix API key — grab one at app.portrix.ai
curl installed, or a code editor with Python 3.8+ or Node.js 18+

Using cURL

The fastest way to verify your setup is a raw curl request. Replace YOUR_API_KEY with your actual key:

curl https://api.portrix.ai/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-4o",
    "messages": [
      {
        "role": "user",
        "content": "What is the capital of France?"
      }
    ]
  }'

You should receive a JSON response within a few seconds. If you see a 401 error, double-check that your API key is correct and that you have not included extra whitespace.

Using Python

Install the official OpenAI SDK — Portrix is fully compatible with it:

pip install openai

Then point the client at the Portrix base URL:

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.portrix.ai/v1",
)

response = client.chat.completions.create(
    model="openai/gpt-4o",
    messages=[
        {"role": "user", "content": "What is the capital of France?"}
    ],
)

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

Using JavaScript / TypeScript

Install the OpenAI npm package:

npm install openai

Configure the client with the Portrix base URL:

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.portrix.ai/v1",
});

const response = await client.chat.completions.create({
  model: "openai/gpt-4o",
  messages: [
    { role: "user", content: "What is the capital of France?" },
  ],
});

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

Understanding the response

A successful response follows the standard OpenAI chat completions shape:

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1714000000,
  "model": "openai/gpt-4o",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "The capital of France is Paris."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 15,
    "completion_tokens": 9,
    "total_tokens": 24
  }
}

The fields you’ll use most often:

Field	Description
`choices[0].message.content`	The model’s text reply
`choices[0].finish_reason`	Why generation stopped (`stop`, `length`, `tool_calls`)
`usage.total_tokens`	Total tokens consumed — used for billing
`id`	Unique request ID, useful when contacting support

Legacy text completions

Portrix also supports the POST /v1/completions endpoint for older integrations that use the non-chat completions format. The request shape mirrors the OpenAI legacy completions API — use a prompt string instead of a messages array:

curl https://api.portrix.ai/v1/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-3.5-turbo-instruct",
    "prompt": "The capital of France is",
    "max_tokens": 10
  }'

For all new integrations, prefer POST /v1/chat/completions — it is supported by every model on Portrix and is the format used throughout this documentation.

Switching models

One of Portrix’s core benefits is that changing the underlying model requires updating a single string. Everything else in your code stays identical:

response = client.chat.completions.create(
    model="anthropic/claude-3-5-sonnet",   # changed from openai/gpt-4o
    messages=[
        {"role": "user", "content": "What is the capital of France?"}
    ],
)

response = client.chat.completions.create(
    model="google/gemini-2.0-flash",       # changed from openai/gpt-4o
    messages=[
        {"role": "user", "content": "What is the capital of France?"}
    ],
)

const response = await client.chat.completions.create({
  model: "anthropic/claude-3-5-sonnet",    // changed from openai/gpt-4o
  messages: [
    { role: "user", content: "What is the capital of France?" },
  ],
});

If you already have working OpenAI code, migrating to Portrix requires exactly two changes: set base_url / baseURL to https://api.portrix.ai/v1, and replace your OpenAI key with your Portrix API key. Your prompts, tools, and response-parsing logic need no modifications.

Get Started

Core Concepts

Guides

Integrations

Configuration

Help

Send Your First AI Request via the Portrix Gateway

Before you begin

Prerequisites

Using cURL

Using Python

Using JavaScript / TypeScript

Understanding the response

Legacy text completions

Switching models

​Before you begin

Prerequisites

​Using cURL

​Using Python

​Using JavaScript / TypeScript

​Understanding the response

​Legacy text completions

​Switching models

Before you begin

Using cURL

Using Python

Using JavaScript / TypeScript

Understanding the response

Legacy text completions

Switching models