Skip to main content
Use the official client libraries to interact with the Orq.ai API.

Github

Our SDKs are available on Github:

Node.js

Python

Installation

# The SDK can be installed with either pip or poetry package managers.
# PIP

pip install orq-ai-sdk

# Poetry

poetry add orq-ai-sdk
# The SDK can be installed with either npm, pnpm, bun or yarn package managers.
# NPM

npm add @orq-ai/node

# PNPM

pnpm add @orq-ai/node

# Bun

bun add @orq-ai/node

# Yarn

yarn add @orq-ai/node zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Usage

To get your workspace API Keys, see API Keys.
Initialize the Orq.ai client with an API key:
import os

from orq_ai_sdk import Orq

client = Orq(
    api_key=os.environ.get("ORQ_API_KEY", "__API_KEY__"),
)
import { Orq } from "@orq-ai/node";

const client = new Orq({
  apiKey: 'orq-api-key',
});

Platform

Agents

Agents Responses

Annotations

API Keys

Chunking

Datasets

Deployments

Evals

Feedback

Files

Guardrail Rules

Human Review Sets

Identities

Knowledge

Memory Stores

Models

PII

Policies

Projects

Prompts

Reporting

Responses

Routing Rules

Schedules

Skills

Tools

Router / Gateway

Router

Chat Completions

Completions

Embeddings

Audio: Speech

Audio: Transcriptions

Audio: Translations

Images: Generations

Images: Edits

Images: Variations

Moderations

Rerank