Guides
Pick the task you want to complete and follow it to a visible result.
Each guide covers one task end to end: the requests to send, the response fields to read, the permissions the calls need, and the errors they return. Start with the task that matches your goal.
Start work
- Start a workflow and read its result - publish a Workflow, start it, and follow the Workflow Run to a terminal status with the Developer API.
- Schedule a recurring workflow run - create a schedule trigger source, enable it, and follow the Workflow Run it fires into.
- Start a project Run and read its result - dispatch the agent a Project already configures, then read the Run's output.
Work inside a Chat
- Send a message to a Chat and follow the turn - post a user message to an existing Chat and read what the turn produced.
- Answer a pending chat approval - list the approvals the latest turn waits on and answer one to resume it.
Ship an agent and receive events
- Deploy and activate a Factory - take a local Factory directory to an active revision with the command-line interface.
- Send events to custom webhook ingestion - post Alertmanager notifications or generic events and read the stored event ids.
Before you start
Every guide authenticates with a personal API key or the command-line interface, and each one names the capabilities and action grants its requests need. Create a key with API keys and read the API overview for the capability levels, action grants, and error contract.
Next steps
- Core concepts - the nouns every guide uses
- API overview - authentication, capabilities, and endpoint families
- API keys - create a key scoped to one task
- Command-line interface - install, authenticate, and automate the CLI