SDKs & toolsPython reference

Python SDK reference

⚠️
Preview — this feature is being built; the design below is the spec.

Method-by-method reference for the syntic Python package. Each page lists the methods for one resource, the endpoint each calls, what it returns, and an example.

Client options

OptionDefaultMeaning
api_keySYNTIC_API_KEY env varInference key.
base_urlhttps://app.syntic.ai/v1Override for testing against a mock server.
timeout600 s (non-streaming)Per request; accepts an httpx.Timeout.
max_retries2Retries on 408, 409, 429, 5xx and connection errors, with exponential back-off honouring Retry-After.
default_headers{}Added to every request, e.g. syntic-version.
http_clientbuilt inBring your own httpx.Client for proxies or custom TLS.
from syntic import Syntic, AsyncSyntic
 
client = Syntic(max_retries=4, default_headers={"syntic-version": "2026-11-01"})
aclient = AsyncSyntic()  # same methods, awaitable

Error classes

ClassHTTP status
syntic.BadRequestError400
syntic.AuthenticationError401
syntic.QuotaExhaustedError402
syntic.PermissionDeniedError403
syntic.NotFoundError404
syntic.ConflictError409
syntic.UnprocessableEntityError422
syntic.RateLimitError429
syntic.InternalServerError5xx
syntic.APIConnectionErrornetwork failure, no response

Each HTTP error has .status_code, .code (the error envelope’s code), .request_id and .body.

Was this page helpful?