Inference quickstart

Run inference against your deployed models with the Python SDK, cURL, or any OpenAI-compatible client. The API follows industry-standard formats — LLM endpoints match OpenAI’s v1/chat/completions and v1/completions, and embeddings match v1/embeddings.

Test requests interactively in the Playground and copy the generated code into your application.

Installation

Install the Python SDK:

pip install --upgrade synapsai-python

Authentication

Initialize the client or send a request with your API key. Treat the key like a password.

Create and manage API keys

Set the environment variable:

set SYNAPSAI_API_KEY=your-api-key

export SYNAPSAI_API_KEY=your-api-key

Initialize the client

from synapsai import SynapsAI

client = SynapsAI()  # reads SYNAPSAI_API_KEY from the environment
# or
client = SynapsAI("your-api-key")

curl https://api.synapsai.cloud/v1/models \
  -H "Authorization: Bearer $SYNAPSAI_API_KEY"

Send a request

Replace your-model-id with the ID from the Models page (click Model ID on your deployment).

response = client.chat.completions.create(
    model="your-model-id",
    messages=[
        {"role": "user", "content": "Hello, how are you?"}
    ],
)

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

curl -X POST 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, how are you?"}]
  }'

Stream a response

Add stream=True to receive tokens as they are generated:

stream = client.chat.completions.create(
    model="your-model-id",
    messages=[{"role": "user", "content": "Hello, how are you?"}],
    stream=True,
)

for chunk in stream:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

See Streaming for SSE format details and production tips.

Next steps

Browse Examples for every supported pipeline task.
Migrate from OpenAI if you already use OpenAI-compatible libraries.
Read the API overview for errors, rate limits, and endpoint compatibility.

Getting started

Guides

Examples

Manage

Platform

Resources

Support

Legal

Installation

Authentication

Create and manage API keys

Initialize the client

Send a request

Stream a response

Next steps

​Installation

​Authentication

Create and manage API keys

​Initialize the client

​Send a request

​Stream a response

​Next steps

Installation

Authentication

Initialize the client

Send a request

Stream a response

Next steps