> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Orq SDKs

> Install and configure the official Orq.ai SDKs for Python and Node.js. Authenticate with your API key and start making API calls in minutes.

Use the official client libraries to interact with the **Orq.ai** API.

## Github

Our SDKs are available on **Github**:

<CardGroup cols={2}>
  <Card horizontal title="Node.js" icon="node-js" href="https://github.com/orq-ai/orq-node/tree/main" cta="Get started with our Node.js SDK" />

  <Card horizontal title="Python" icon="python" href="https://github.com/orq-ai/orq-python/tree/main" cta="Get started with our Python SDK" />
</CardGroup>

## Installation

<CodeGroup>
  ```bash Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  # The SDK can be installed with either pip or uv package managers.
  # PIP

  pip install orq-ai-sdk

  # uv

  uv add orq-ai-sdk
  ```

  ```bash Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
  # 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.
  ```
</CodeGroup>

## Usage

<Info>
  To get your workspace API Keys, see [API Keys](/ai-studio/organization/api-keys).
</Info>

Initialize the **Orq.ai** client with an API key:

<CodeGroup>
  ```bash Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  import os

  from orq_ai_sdk import Orq

  client = Orq(
      api_key=os.environ.get("ORQ_API_KEY", "__API_KEY__"),
  )
  ```

  ```bash Javascript theme={"theme":{"light":"github-light","dark":"github-dark"}}
  import { Orq } from "@orq-ai/node";

  const client = new Orq({
    apiKey: 'orq-api-key',
  });
  ```
</CodeGroup>

Both clients default to the managed cloud at `https://my.orq.ai`. Self-hosted and on-premise deployments serve the API under their own hostname, which has to be passed explicitly as `server_url` or `serverURL`. See [Base URLs](/reference/base-urls).

## Platform

<CardGroup cols={3}>
  <Card horizontal title="Agents" href="/reference/sdk/agents" icon="robot" />

  <Card horizontal title="Agents Responses" href="/reference/sdk/orqresponses" icon="message-bot" />

  <Card horizontal title="Annotations" href="/reference/sdk/annotations" icon="tag" />

  <Card horizontal title="API Keys" href="/reference/sdk/apikeys" icon="key" />

  <Card horizontal title="Chunking" href="/reference/sdk/chunking" icon="scissors" />

  <Card horizontal title="Datasets" href="/reference/sdk/datasets" icon="table" />

  <Card horizontal title="Deployments" href="/reference/sdk/deployments" icon="rocket" />

  <Card horizontal title="Evals" href="/reference/sdk/evals" icon="flask" />

  <Card horizontal title="Feedback" href="/reference/sdk/feedback" icon="thumbs-up" />

  <Card horizontal title="Files" href="/reference/sdk/files" icon="file" />

  <Card horizontal title="Guardrail Rules" href="/reference/sdk/guardrailrules" icon="shield" />

  <Card horizontal title="Human Review Sets" href="/reference/sdk/humanreviewsets" icon="user-check" />

  <Card horizontal title="Identities" href="/reference/sdk/identities" icon="id-card" />

  <Card horizontal title="Knowledge" href="/reference/sdk/knowledge" icon="book" />

  <Card horizontal title="Memory Stores" href="/reference/sdk/memorystores" icon="database" />

  <Card horizontal title="MCP Gateways" href="/reference/sdk/mcpgateways" icon="network-wired" />

  <Card horizontal title="MCP Servers" href="/reference/sdk/mcpservers" icon="plug" />

  <Card horizontal title="Model Catalog" href="/reference/sdk/modelcatalog" icon="microchip" />

  <Card horizontal title="Models" href="/reference/sdk/models" icon="microchip" />

  <Card horizontal title="PII" href="/reference/sdk/pii" icon="eye-slash" />

  <Card horizontal title="Projects" href="/reference/sdk/projects" icon="folder" />

  <Card horizontal title="Prompts" href="/reference/sdk/prompts" icon="pen" />

  <Card horizontal title="Reporting" href="/reference/sdk/reporting" icon="chart-line" />

  <Card horizontal title="Responses" href="/reference/sdk/responses" icon="reply" />

  <Card horizontal title="Routing Rules" href="/reference/sdk/routingrules" icon="route" />

  <Card horizontal title="Schedules" href="/reference/sdk/schedules" icon="calendar" />

  <Card horizontal title="Skills" href="/reference/sdk/skills" icon="wand-magic-sparkles" />

  <Card horizontal title="Tools" href="/reference/sdk/tools" icon="wrench" />

  <Card horizontal title="Workspaces Security" href="/reference/sdk/workspacesecurity" icon="lock" />
</CardGroup>

## Router / Gateway

<CardGroup cols={3}>
  <Card horizontal title="Router" href="/reference/sdk/router" icon="network-wired" />

  <Card horizontal title="Chat Completions" href="/reference/sdk/orqcompletions" icon="comments" />

  <Card horizontal title="Completions" href="/reference/sdk/completions" icon="terminal" />

  <Card horizontal title="Embeddings" href="/reference/sdk/embeddings" icon="vector-square" />

  <Card horizontal title="Audio: Speech" href="/reference/sdk/speech" icon="volume-high" />

  <Card horizontal title="Audio: Transcriptions" href="/reference/sdk/transcriptions" icon="microphone" />

  <Card horizontal title="Audio: Translations" href="/reference/sdk/translations" icon="language" />

  <Card horizontal title="Images: Generations" href="/reference/sdk/generations" icon="image" />

  <Card horizontal title="Images: Edits" href="/reference/sdk/edits" icon="pen-to-square" />

  <Card horizontal title="Images: Variations" href="/reference/sdk/variations" icon="clone" />

  <Card horizontal title="Moderations" href="/reference/sdk/moderations" icon="filter" />

  <Card horizontal title="Rerank" href="/reference/sdk/rerank" icon="arrow-up-wide-short" />
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.