Quickstart

This guide installs the Syntic Agent SDK and runs your first agent programmatically in both TypeScript and Python. In a few minutes you’ll have Amara reading your prompt, deciding on tools, and returning a result.

Install and authenticate

Install the SDK for your language of choice. The TypeScript package is published as @syntic/agent-sdk; the Python package is syntic-agent-sdk.

# TypeScript
npm install @syntic/agent-sdk
 
# Python
pip install syntic-agent-sdk

The SDK authenticates against api.syntic.ai. Set your key in the environment before running an agent:

export SYNTIC_API_KEY="sk-syntic-..."

You can generate and rotate keys from the Syntic AI console. Keep keys out of source control and prefer a secrets manager in production.

Run your first agent

The core entry point is a query that sends a prompt to Amara and yields messages as the agent works. Iterate the stream to observe each step, or collect the final result.

import { query } from "@syntic/agent-sdk";
 
for await (const message of query({
  prompt: "List the files in this project and summarize what it does.",
  options: { cwd: process.cwd() },
})) {
  if (message.type === "result") {
    console.log(message.result);
  }
}

import asyncio
from syntic_agent_sdk import query
 
async def main():
    async for message in query(
        prompt="List the files in this project and summarize what it does.",
        options={"cwd": "."},
    ):
        if message.type == "result":
            print(message.result)
 
asyncio.run(main())

Next steps

You now have a working agent. To go further, read Core Concepts to understand the agent loop and sessions, then explore Tools to extend what Amara can do and Control & Governance to set permissions before shipping to production.