Configuration

Both Deutero and AsyncDeutero accept the same keyword-only options:

client = Deutero(
    api_key="dtro_...",
    base_url="https://dashboard.deutero.ai/study-api",
    timeout=120.0,
    http_client=None,
)

str

Your API key. Defaults to the DEUTERO_API_KEY environment variable.

str

default:"https://dashboard.deutero.ai/study-api"

The API root. Override it to point at a staging environment.

float

default:"120"

Request timeout in seconds. Some calls are model calls that take a minute or more (study drafting, question generation, validation), so keep this generous.

httpx.Client | httpx.AsyncClient

A preconfigured httpx client. Pass httpx.Client to Deutero and httpx.AsyncClient to AsyncDeutero.

Custom base URL

client = Deutero(base_url="https://staging.example.com/study-api")

Custom timeout

client = Deutero(timeout=300.0)  # 5 minutes

A request that exceeds the timeout raises deutero.TimeoutError.

Custom HTTP client

Bring your own httpx client for proxies, custom certificates, retries or other transport settings:

import httpx

from deutero import Deutero

http_client = httpx.Client(
    proxy="http://proxy.example.com:8080",
    verify="/path/to/cert.pem",
    transport=httpx.HTTPTransport(retries=3),
    timeout=300.0,
)

client = Deutero(http_client=http_client)

The SDK still adds the X-API-Key header to every request, and uses its own base_url if your client doesn’t set one.

When you pass http_client, its own timeout applies; the SDK’s timeout argument is not applied to it. The SDK also doesn’t close a client you passed in, so close it yourself when you’re done.

Closing connections

The client keeps a connection pool. Use it as a context manager, or call close():

with Deutero() as client:
    balance = client.credits.get_balance()
    print(balance.net_available)
# connection pool closed here

async with AsyncDeutero() as client:
    balance = await client.credits.get_balance()
    print(balance.net_available)

Health check

client.health() calls GET /health and returns the raw JSON body. It’s handy for a readiness probe.

print(client.health())

Conventions

IDs can be passed as str or uuid.UUID.
Optional arguments left as None are not sent. The server default applies, and on updates the field is left unchanged.
Enums such as StudyType, ModelTier and SearchMode are str enums: pass either the enum member or its string value.
Responses are Pydantic models from deutero.models. Use .model_dump() to get a dict.

Get started

Guides

Resources

Custom base URL

Custom timeout

Custom HTTP client

Closing connections

Health check

Conventions

​Custom base URL

​Custom timeout

​Custom HTTP client

​Closing connections

​Health check

​Conventions

Custom base URL

Custom timeout

Custom HTTP client

Closing connections

Health check

Conventions