Quickstart

This guide walks you from a new account to a working API call. Expect about 10–15 minutes for account setup and model deployment.

Prerequisites

A Google or GitHub account for sign-up
A Hugging Face account with a model in Safetensors format, or use a public model from the Hub

Step 1: Create your account

Go to synapsai.cloud/login.
Sign in with Google or GitHub.

Planning to collaborate with teammates? Create a team and invite members before deploying shared models.

Step 2: Review your credits

SynapsAI Cloud includes starter credits for new accounts. Check your balance on the Billing page before deploying. See Billing for purchasing additional credits and enabling auto-pay.

Step 3: Understand core concepts

Before deploying, read Core concepts — especially readiness levels and pricing. Estimated costs are shown in the deployment UI before you confirm.

Step 4: Deploy a model

Launch a model

Open the deployment wizard in the dashboard.

Follow Deploy a model for Hugging Face requirements, readiness levels, precision, and scaling options. If you need to prepare a repository first, see Launch a custom model or Convert models to Safetensors. Wait until deployment finishes — the model status should be Sleeping or Ready, not Building. You can send inference requests in either state. When Sleeping, the platform automatically loads an instance on your request.

Step 5: Create an API key

Open API keys.
Click Create Secret Key.
Name the key and restrict it to your newly deployed model.
Click Create Key and copy the value — it is shown only once.

Store the key securely. See API keys for rotation and permission guidance.

export SYNAPSAI_API_KEY="your-api-key"

Step 6: Run inference

Install the Python SDK:

pip install --upgrade synapsai-python

Send a chat completion request. Replace your-model-id with the ID from the Models page:

from synapsai import SynapsAI

client = SynapsAI()

response = client.chat.completions.create(
    model="your-model-id",
    messages=[{"role": "user", "content": "Hello! What can you help me with?"}],
)

print(response.choices[0].message.content)

Or use cURL:

curl https://api.synapsai.cloud/v1/chat/completions \
  -H "Authorization: Bearer $SYNAPSAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "your-model-id",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

For streaming, tool calling, and other pipelines, see Inference quickstart and Examples.

Next steps

Migrate from OpenAI

Use OpenAI-compatible clients with SynapsAI.

API reference

Authentication, errors, and endpoint details.

Optimize costs

Tune readiness, quantization, and context length.

Integrations

LangChain, LlamaIndex, FAISS, and more.

Getting started

Guides

Examples

Manage

Platform

Resources

Support

Legal

Prerequisites

Step 1: Create your account

Step 2: Review your credits

Step 3: Understand core concepts

Step 4: Deploy a model

Launch a model

Step 5: Create an API key

Step 6: Run inference

Next steps

Migrate from OpenAI

API reference

Optimize costs

Integrations

​Prerequisites

​Step 1: Create your account

​Step 2: Review your credits

​Step 3: Understand core concepts

​Step 4: Deploy a model

Launch a model

​Step 5: Create an API key

​Step 6: Run inference

​Next steps

Migrate from OpenAI

API reference

Optimize costs

Integrations

Prerequisites

Step 1: Create your account

Step 2: Review your credits

Step 3: Understand core concepts

Step 4: Deploy a model

Step 5: Create an API key

Step 6: Run inference

Next steps