Connic
Getting Started

Quick Start

Get up and running with Connic in under 5 minutes. This guide walks you through creating a project, deploying an agent, and triggering your first run.

Prerequisites

• Python 3.10+ installed

• A GitHub, GitLab, or Bitbucket account

• An API key for your model provider (e.g., Google AI, OpenAI)

1

Create a Project in Connic

Create a new project in the Connic dashboard. The wizard will guide you through connecting your repository.

a

Go to Projects and click Create Project

b

Click Connect and authorize Connic to access your repositories

c

Select the repository you want to connect

d

Enter a project name and select your deployment region

e

Create an environment (e.g., Production) and select the branch to deploy from

f

Add your API key for your model provider (e.g., OpenAI, Anthropic, Gemini)

2

Set Up Your Local Project

Install the SDK, then either scaffold from a template or create a minimal project.

terminal
pip install connic-composer-sdk

Option A: Start from a template (recommended). Browse agent templates and run:

terminal
connic init my-project --templates=invoice,customer-support
cd my-project

Option B: Start from scratch. Creates a minimal structure:

terminal
connic init my-agents
cd my-agents
3

Define Your Agent

Edit the agent YAML file to configure your agent.

agents/assistant.yaml
name: assistant
model: gemini/gemini-2.5-flash
description: "A helpful assistant"
system_prompt: |
  You are a helpful assistant. Answer questions
  clearly and concisely.

temperature: 0.7
max_concurrent_runs: 5

Each YAML file in the agents/ folder defines one agent. You can have multiple agents in a single project. For simple projects, keep them at the top level; for larger projects, you can optionally organize agents into subfolders under agents/.

4

Deploy

Choose Git (auto-deploy on push) or CLI (works with any provider).

Git integration
  1. Connect your repo in Project Settings → Git
  2. Map branch in Settings → Environments
  3. Push to trigger deployment
terminal
git add .
git commit -m "Initial agent setup"
git push origin main
CLI deploy
  1. Create API key in Project Settings → CLI
  2. Run connic login in your project folder
  3. connic test to try, or connic deploy for production
terminal
connic login
connic deploy
5

Create a Connector

To trigger your agent, create a connector from the marketplace. For example, you can create an HTTP webhook to trigger agents via API calls.

a

Open your agent's detail page in the Agents section

b

Click the + button on the connector flow diagram, then choose Create New Connector

c

Pick a connector type from the marketplace and configure it (name, mode, etc.)

d

The connector is automatically linked to the agent once created

6

Test Your Agent

Trigger your agent using the connector you created. For example, if you created an HTTP webhook connector, you can trigger it with a curl command:

terminal
curl -X POST <webhook-url> \
  -H "Content-Type: application/json" \
  -H "X-Connic-Secret: <your-secret-key>" \
  -d '{"message": "Hello, agent!"}'

Check the Runs section in your project to see the agent's response and trace details.

You're all set!

Your agent is now deployed and ready to use.

Agent Templates

Browse production-ready templates to scaffold from

SDK Overview

Understand how Connic Composer SDK works

Agent Configuration

Configure LLM, Sequential, and Tool agents

Write Custom Tools

Create Python functions your agents can call

Connectors

Integrate agents with external systems

Local Testing

Run agents locally with hot-reload before shipping