Skip to main content
Anything you can do in the Caylex Platform UI, you can also do programmatically through the Platform API. These cookbooks are complete, copy-pasteable recipes for the workflows teams automate most often — provisioning projects for new customers, keeping skills in sync from CI, and replicating configuration across environments. Each recipe is self-contained: it lists the endpoints it uses, walks through the procedure, and gives a full worked example you can adapt.

​
Before you start

Every recipe authenticates the same way: a platform access token sent as a Bearer token against the Platform API base URL.
If you haven’t created a token yet, follow Platform Authentication first.
A platform access token has admin scope over your entire workspace. Keep it server-side (backend or CI only), store it in a secret manager, and never expose it to a browser.

​
Conventions used in these recipes

  • Base URL & auth are factored into a small client/helper at the top of each example so the recipe body stays focused on the workflow.
  • List endpoints return a page of items. Responses are shaped { "items": [...], "meta": { "next_cursor": "...", "has_next": true } }, with up to 100 items per call (size query parameter, max 100). The recipes request size=100, which is enough for most workspaces; if you have more, pass meta.next_cursor back as the cursor parameter to fetch the next page until has_next is false.
  • Idempotency matters. Recipes check whether a resource already exists before creating it, so they’re safe to re-run (for example, in a nightly CI job).

​
The recipes

Provision customer projects

Clone a model project for a new customer — servers, navigators, permissions, and runtime keys — in one call.

Generate navigator API keys

Mint a runtime API key for each navigator instance and store it securely.

Copy tool permissions

Replicate a navigator’s tool-permission policy from a model project onto other projects.

Sync skills from your repo

Keep a folder of SKILL.md files in version control and push changes to a Caylex project from CI.

Search skills by tag

Find every skill carrying a given tag across all of your projects — or a specific set — in one call.

Get all messages for a session

Pull a chat session’s full transcript — user turns, assistant replies, and tool calls — and find the session ID.

Background sync

Collect content from connected services with background agents and transform tool traces for downstream indexes.

REST API Reference

Every endpoint with its parameters, request bodies, and response schemas.
The machine-readable OpenAPI spec is available at https://api.caylex.ai/api/v1/docs/openapi.yaml — handy for generating a typed client or feeding to an agent.