Skip to Content

Server SDKs

Official Rixl API clients and infrastructure tools for TypeScript, Go, Python, Java, .NET, Rust, Terraform, PHP, and Ruby.

RIXL provides official, production-ready server SDKs and an infrastructure provider generated directly from our OpenAPI specifications. Whether you are running microservices, serverless functions, background workers, or infrastructure-as-code pipelines, our SDKs provide typed, idiomatic access to the Rixl platform.

Supported Languages & Tools


Authentication

All server SDKs authenticate using an API key generated from your RIXL Dashboard. Requests authenticate via the X-API-Key HTTP header. Alternatively, OAuth bearer tokens are supported across all endpoints.

export RIXL_API_KEY="rixl_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Quickstart

npm i @rixl/sdk
import {createClient, imagesV1ImageServiceListImages} from "@rixl/sdk";

const client = createClient({
  baseUrl: "https://api.rixl.com",
  auth: process.env.RIXL_API_KEY,
});

const {data, error} = await imagesV1ImageServiceListImages({
  client,
  path: {project_id: "your_project_id"},
  query: {"pagination.limit": 10},
});

if (error) {
  console.error("Failed to list images:", error);
} else {
  console.log(data?.images?.map((image) => image.id));
}

Language SDK Guides

TypeScript

The official TypeScript and JavaScript SDK (@rixl/sdk) provides a modern, fully typed REST client for backend Node.js, serverless runtimes, and full-stack frameworks.

Installation

npm i @rixl/sdk
# or: pnpm i @rixl/sdk / bun i @rixl/sdk / vp i @rixl/sdk

Key Capabilities

  • Strict TypeScript Types: Fully typed methods, path parameters, query schemas, and response models generated from OpenAPI.
  • Universal Fetch: Works seamlessly across Node.js, Bun, Deno, Next.js, Cloudflare Workers, and browser runtimes.
  • Dynamic Authentication: Accepts a string token or an async token function for dynamic token refresh and multi-tenant credentials.

Go

The official Go client (github.com/rixlhq/rixl-go) is designed for high-concurrency backend services, microservices, and command-line tools.

Installation

go get github.com/rixlhq/rixl-go

Key Capabilities

  • Context-First: Every request accepts standard context.Context for deadlines and cancellation.
  • Resource Clients: Dedicated sub-clients for Images, Videos, Feeds, and Projects.
  • Zero Heavy Dependencies: Lightweight HTTP client wrapper with built-in JSON marshaling.

Python

The official Python SDK (rixl) provides an async-first client suitable for FastAPI, Django, Celery, and data pipelines.

Installation

pip install rixl

Key Capabilities

  • Async Native: Built on httpx and Microsoft Kiota for native async/await workflows.
  • Hierarchical Path Builder: Fluent navigation matching the API route hierarchy (client.media.v1...).
  • Full Type Hinting: Complete type definitions and dataclasses for IDE autocompletion and MyPy validation.

Java

The official Java SDK (com.rixl:sdk) provides strongly typed models and fluent request builders for Spring Boot, Quarkus, and enterprise JVM services.

Installation

Maven:

<dependency>
  <groupId>com.rixl</groupId>
  <artifactId>sdk</artifactId>
  <version>1.1.0</version>
</dependency>

Gradle:

implementation("com.rixl:sdk:1.1.0")

Key Capabilities

  • OkHttp Transport: Battle-tested connection pooling, HTTP/2, and TLS negotiation.
  • Typed Models: Strongly typed request/response POJOs with Jackson serialization.
  • Path-Based Builders: Fluent API navigation matching REST resource structures.

CSharp

The official .NET SDK (Rixl.Sdk) is optimized for ASP.NET Core, Azure Functions, and .NET backend architectures.

Installation

dotnet add package Rixl.Sdk

Key Capabilities

  • Async/Await Throughout: Full async methods with CancellationToken support.
  • Dependency Injection: Seamless integration with Microsoft.Extensions.DependencyInjection.
  • System.Text.Json: High-throughput, zero-allocation serialization.

Rust

The official Rust crate (rixl) provides zero-OpenSSL, memory-safe, asynchronous access to the Rixl platform.

Installation

[dependencies]
rixl = "1.0"

Key Capabilities

  • Pure Rust TLS: Built using reqwest with rustls-tls by default — zero C or OpenSSL system dependencies.
  • Builder Pattern (bon): Parameter structs use compile-time builders for clean, expressive call sites.
  • Modular APIs: Separate modules for images_api, videos_api, feeds_api, and analytics_api.

Terraform

The official Terraform provider (rixlhq/rixl) allows infrastructure and DevOps teams to manage Rixl resources declaratively.

Configuration

terraform {
  required_providers {
    rixl = {
      source  = "rixlhq/rixl"
      version = ">= 0.1.0"
    }
  }
}

provider "rixl" {
  api_key = var.rixl_api_key
}

resource "rixl_feed" "main" {
  project_id  = var.project_id
  name        = "app-feed"
  description = "Media feed managed by Terraform"
}

Managed Resources

  • Feeds: Create and configure dynamic video and image feeds (rixl_feed).
  • Data Sources: Reference existing projects, videos, images, and API keys.
  • State Management: Full support for Terraform plan, apply, drift detection, and state locking.

PHP

The official PHP client (rixl/sdk) supports modern PHP backends, Laravel, and Symfony applications.

Installation

composer require rixl/sdk

Key Capabilities

  • Guzzle Transport: Industry-standard HTTP client integration with PSR-7 compatibility.
  • Typed DTOs: Strict parameter validation and typed response objects.
  • Promise Support: Asynchronous execution via Guzzle promises or synchronous .wait() resolution.

Ruby

The official Ruby gem (rixl) provides idiomatic client bindings for Ruby on Rails, Sidekiq, and Ruby scripts.

Installation

gem install rixl

Or add to your Gemfile:

gem "rixl", "~> 1.0"

Key Capabilities

  • Faraday Integration: Configurable middleware, retries, and HTTP adapters.
  • Fluent Method Chaining: Path navigation matching REST resources (client.media.v1...).
  • Thread Safe: Safe for concurrent background workers like Sidekiq and GoodJob.