Documentation

1. Create an Account

Sign up for a free account to get your API key and start building.

2. Install the SDK

Install the Relytics SDK for your preferred language:

npm install @relytics/sdk

3. Initialize the Client

Initialize the client with your API key:

import { Relytics } from '@relytics/sdk';

const client = new Relytics({
  apiKey: process.env.RELYTICS_API_KEY
});

Search Endpoint

Search for items in your collection:

POST /client/api/search

{
  "query": "action movies",
  "collection": "movies",
  "limit": 10,
  "use_hybrid": true
}

Recommendation Endpoint

Get personalized recommendations:

POST /client/api/recommend

{
  "item_ids": ["item1", "item2"],
  "collection": "movies",
  "limit": 10
}

JavaScript Example

const results = await client.search({
  query: "sci-fi",
  collection: "movies",
  limit: 20
});

console.log(results);

Python Example

from relytics import Relytics

client = Relytics(api_key="your-api-key")
results = client.search(
    query="sci-fi",
    collection="movies",
    limit=20
)
print(results)