Getting Started

Introduction

Orkosi is an AI agent platform that lets you deploy autonomous agents to run your business operations — from shipping code to reconciling invoices to resolving customer tickets.

New to Orkosi?

Start with the Quickstart guide to deploy your first agent in under 5 minutes.

What are agents?

Agents are autonomous AI workers that connect to your existing tools and execute tasks based on protocols you define. They can read data, make decisions, take actions, and report results — all without human intervention.

Each agent specializes in a domain: development, finance, support, research, or marketing. You can also create custom agents for unique business processes.

Quickstart

Get your first agent running in three steps.

1 Create an account

Sign up at orkosi.com/register. You get 50 free credits per month.

2 Connect an integration

Go to Settings → Integrations and connect your first tool. GitHub is the fastest to set up.

Dashboard → Settings → Integrations

Click "Connect GitHub" → Authorize → Select repos

3 Deploy your first agent

Create a new agent and assign it a protocol. The agent will start working immediately.

// Example: Create a Dev Agent via API
const agent = await orkosi.agents.create({
  type: "dev",
  name: "PR Reviewer",
  protocol: "Review all PRs on main branch",
  integrations: ["github"]
});

Authentication

All API requests require an API key. Generate one from your dashboard under Settings → API Keys.

curl https://api.orkosi.com/v1/agents \
  -H "Authorization: Bearer ork_sk_..." \
  -H "Content-Type: application/json"

Core Concepts

Agents

Agents are the core building blocks of Orkosi. Each agent is an autonomous worker that connects to your tools and executes tasks.

Agent types

Dev Agent

Code review, bug fixes, deployments, PR management

Research Agent

Web browsing, competitor analysis, market intelligence

Finance Agent

Invoice reconciliation, expense tracking, reporting

Support Agent

Ticket resolution, escalation, satisfaction tracking

Marketing Agent

Content creation, campaign management, conversion optimization

Custom Agent

Build agents for your unique business processes

Protocols

Protocols are natural language instructions that define how agents should work. Think of them as playbooks for your AI workers.

// Example protocol for a Dev Agent
{
  "name": "PR Review Protocol",
  "instructions": "Review every PR on the main branch. Check for security issues, performance regressions, and code style. Approve if all checks pass, request changes otherwise.",
  "triggers": ["pull_request.opened", "pull_request.updated"]
}

API Reference

API Overview

The Orkosi API is a REST API that uses JSON for request and response bodies. All endpoints require authentication via API key.

Base URL

https://api.orkosi.com/v1

Endpoints

GET /agents List all agents
POST /agents Create an agent
GET /agents/:id Get agent details
POST /protocols Create a protocol
GET /protocols List protocols