API Reference

The Cadenya API gives you programmatic control over every resource in the platform: tool sets, agents, objectives, memory, and more. Every endpoint here is generated from the OpenAPI specification, with request and response schemas and copy-paste SDK snippets in TypeScript, Go, Ruby, and cURL.

Base URL

https://api.cadenya.com

Authentication

Every request is authenticated with an HTTP bearer token (a JWT minted from a workspace-scoped API key):

Authorization: Bearer $CADENYA_API_KEY

See the API Design guide for how keys are issued, rotated, and scoped to workspaces.

SDKs

Official SDKs wrap the API in idiomatic clients:

TypeScript

npm install @cadenya/cadenya

View on GitHub

Go

go get github.com/cadenya/cadenya-go

View on GitHub

Ruby

gem install cadenya

View on GitHub

CLI

brew install cadenya/tools/cadenya

View on GitHub

Conventions

External IDs. Pass your own external_id: value anywhere the API accepts a Cadenya ID. See External IDs are first-class in paths.
Field masks. Updates are PUT-shaped but behave like PATCH through update_mask. See Updates use field masks.
Pagination. List endpoints share a common shape with limit, cursor, prefix, and query. See List requests.

Browse the endpoints in the sidebar to get started.

Overview

Tool Sets

Tools

Tool Set Secrets

Agents

Agent Variations

Agent Schedules

Objectives

Widgets

Widget Sessions

Tenants

Memory Layers

Memory Entries

Models

Uploads

Workspaces

Workspace Secrets

Workspace Admin

Accounts

API Keys

Global API Key

AI Provider Keys

Webhook Events

Base URL

Authentication

SDKs

TypeScript

Go

Ruby

CLI

Conventions

​Base URL

​Authentication

​SDKs

TypeScript

Go

Ruby

CLI

​Conventions

Base URL

Authentication

SDKs

Conventions