Quickstart

npm install openai @averta-security/sdk-openai

yarn add openai @averta-security/sdk-openai

pnpm add openai @averta-security/sdk-openai

python3 -m venv .venv
. .venv/bin/activate
python3 -m pip install "openai>=2" -e packages/python-core -e packages/python-openai

import OpenAI from "openai";
import { wrapOpenAI } from "@averta-security/sdk-openai";

function readEnv(name) {
  const value = process.env[name];

  if (!value) {
    throw new Error(`Missing required environment variable: ${name}`);
  }

  return value;
}

const client = wrapOpenAI(
  new OpenAI({
    apiKey: readEnv("OPENAI_API_KEY"),
  })
);

const response = await client.responses.create({
  model: process.env.OPENAI_MODEL ?? "gpt-5.4-mini",
  input: "Write one sentence explaining what a password reset link is.",
});

console.log("\nModel output:");
console.log(response.output_text);

import os

from openai import OpenAI
from averta_openai import wrap_openai


def read_env(name):
    value = os.environ.get(name)

    if not value:
        raise RuntimeError(f"Missing required environment variable: {name}")

    return value


client = wrap_openai(OpenAI(api_key=read_env("OPENAI_API_KEY")))

response = client.responses.create(
    model=os.environ.get("OPENAI_MODEL", "gpt-5.4-mini"),
    input="Write one sentence explaining what a password reset link is.",
)

print("\nModel output:")
print(response.output_text)

node quickstart.mjs

python quickstart.py

const tools = [
  {
    type: "function",
    name: "search_docs",
    description: "Search internal support documentation.",
    strict: true,
    parameters: {
      type: "object",
      properties: {
        query: { type: "string" },
      },
      required: ["query"],
      additionalProperties: false,
    },
  },
];

const responseWithTools = await client.responses.create({
  model: process.env.OPENAI_MODEL ?? "gpt-5.4-mini",
  input: "Search the docs for password reset guidance.",
  tools,
});

tools = [
    {
        "type": "function",
        "name": "search_docs",
        "description": "Search internal support documentation.",
        "strict": True,
        "parameters": {
            "type": "object",
            "properties": {"query": {"type": "string"}},
            "required": ["query"],
            "additionalProperties": False,
        },
    }
]

response_with_tools = client.responses.create(
    model=os.environ.get("OPENAI_MODEL", "gpt-5.4-mini"),
    input="Search the docs for password reset guidance.",
    tools=tools,
)