Deutero and AsyncDeutero

from deutero import AsyncDeutero, Deutero

client = Deutero()
async_client = AsyncDeutero()

Deutero is synchronous and AsyncDeutero is its asyncio counterpart. They expose the same resources, and every method takes the same arguments; on AsyncDeutero each method is a coroutine.

Constructor

Deutero(
    *,
    api_key: str | None = None,
    base_url: str | None = None,
    timeout: float | None = None,
    http_client: httpx.Client | None = None,
)

str

Your Deutero API key. Falls back to the DEUTERO_API_KEY environment variable. Raises ValueError if neither is set.

str

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

Override the API root.

float

default:"120"

Request timeout in seconds. Not applied to a client you pass as http_client.

httpx.Client

A preconfigured client. AsyncDeutero takes an httpx.AsyncClient. The SDK adds the API key header and, if the client has no base_url, its own.

See Configuration for examples.

Resources

Attribute	Purpose
`projects`	Group studies into projects
`studies`	Create, draft, validate, publish and pause studies
`welcome`	Welcome and consent message, and its translations
`screening`	Qualifying questions that gate participation
`characteristics`	Participant attributes for segmentation
`questions`	The linear interview question list
`graph`	Branching interview flows
`recruitment`	Participation links, quotas and redirects
`embed`	Publishable keys and widget snippets
`personas`	AI participant personas
`simulations`	Simulated interview runs
`interviews`	Interview records, transcripts and flow effects
`transcripts`	Bulk transcript export and search
`analysis`	Response tallies and thematic clustering
`webhooks`	Organization webhook endpoints
`credits`	Credit balance

Methods

health()

client.health() -> dict[str, Any]

Liveness check (GET /health). Doesn’t require a valid API key. Returns the raw JSON body.

close()

client.close() -> None

Closes the underlying connection pool. On AsyncDeutero, await client.close(). A client you passed as http_client is left open.

Context manager

with Deutero() as client:
    ...

async with AsyncDeutero() as client:
    ...

The pool is closed on exit.

Conventions

IDs accept str or uuid.UUID.
Keyword arguments left as None aren’t sent, so the server default applies, and on updates the field is unchanged.
Enum arguments accept the enum member or its string value.
Responses are Pydantic models. Errors raise exceptions.

Client

Study setup

Recruitment

Simulation

Results

Organization

Utilities

Constructor

Resources

Methods

health()

close()

Context manager

Conventions

​Constructor

​Resources

​Methods

​health()

​close()

​Context manager

​Conventions

Constructor

Resources

Methods

health()

close()

Context manager

Conventions