API Reference

This section is the authoritative reference for the Syntic Agent SDK surface across both supported languages. Where the conceptual guides explain why and when, these pages document what — every exported function, option, and message shape you can rely on when building against Amara and the Syntic model.

The SDK ships in two flavors that track the same underlying agent runtime. The TypeScript package is published as @syntic/agent-sdk, and the Python package is distributed as syntic-agent-sdk. Both connect to api.syntic.ai and expose an equivalent feature set, so most concepts port cleanly between them even though the idioms differ.

What you’ll find here

• TypeScript SDK — the complete @syntic/agent-sdk API: the query() entry point, the Options configuration type, the streamed message union, and the helpers for defining in-process tools and MCP servers.
• Python SDK — the syntic-agent-sdk API: the query() async generator, the options mapping, message dataclasses, the @tool decorator, and permission callbacks.
• Migration Guide — how to upgrade across SDK releases and how to move off legacy package names onto the current @syntic/agent-sdk and syntic-agent-sdk distributions.

How to read these pages

Type signatures are given in the native syntax of each language. Fields marked optional may be omitted; the SDK applies documented defaults. Because the runtime is shared, a capability introduced in one language typically lands in the other within the same minor release. When a feature is language-specific, the reference calls it out explicitly. Pin an exact SDK version in production and consult the Migration Guide before bumping across a major boundary.