Getting Started - Snow Leopard

This documentation is for Snow Leopard enterprise deployments. Enterprise deployments are dedicated instances configured for your specific dataset and infrastructure.

Not an enterprise customer? Contact us to get Snow Leopard for your org. You can also see our Cloud documentation to get started for free with Snow Leopard Cloud.

To build AI agents on Snow Leopard’s Enterprise deployment you need to:

Retrieve your deployment URL
Get your authentication information from Snow Leopard
Use our SDKs or the API directly

See below for details.

Deployment Configuration

Your Snow Leopard Enterprise deployment is hosted at a custom URL specific to your infrastructure. You will receive the VM IP address and port from the Snow Leopard team during setup.

Authentication

All API endpoints are authenticated using API Keys, also known as Bearer Tokens. Your API token will be provided to you by the Snow Leopard team during your initial deployment setup.

Contact your Snow Leopard representative if you need a new API token.

Using the API

There are currently multiple ways of interacting with the Snow Leopard API:

Python SDK (pypi)
TypeScript SDK (npm)
REST endpoints

from snowleopard import SnowLeopardClient

client = SnowLeopardClient(
    url="https://{vm_ip_address}:{port}",
    api_key="{api_key}"
)
response = client.retrieve(
    user_query="How many users signed up last month?"
)
print(response.data)

from snowleopard import AsyncSnowLeopardClient

async def main():
    client = AsyncSnowLeopardClient(
        url="https://{vm_ip_address}:{port}",
        api_key="{api_key}"
    )
    response = await client.retrieve(
        user_query="How many users signed up last month?"
    )
    print(response.data)

import { SnowLeopardClient } from '@snowleopard-ai/client';

const client = new SnowLeopardClient({
    url: 'https://{vm_ip_address}:{port}',
    apiKey: '{api_key}'
});

const response = await client.retrieve({
    userQuery: 'How many users signed up last month?'
});

console.log(response.data);
await client.close();

curl --request POST \
  --url https://{vm_ip_address}:{port}/retrieve \
  --header 'Authorization: Bearer {api_key}' \
  --header 'Content-Type: application/json' \
  --data '{"userQuery": "How many users signed up last month?"}'

Feedback Retrieve

​Deployment Configuration

​Authentication

​Using the API

Deployment Configuration

Authentication

Using the API