API Reference — Introduction

Nexrall's API lets you integrate agents directly into your own product or scripts, rather than only through the web app, VS Code extension, or CLI.

Reference status

This section is being expanded. For the fastest path to automating a task today, the Nexrall CLI with --output-format json and the GitHub Action cover most CI/scripting use cases without needing to call the HTTP API directly.

Base URL

https://api.nexrall.com

What you can do with the API

• Send and receive messages, manage contacts and groups.
• Start and drive a coding-agent build session for an app.
• Create, run, and dry-run Agent Workflows.
• Create and edit Canvas artifacts.

Request format

All endpoints accept and return JSON. Requests that stream agent output (builds, chat, workflow runs) use Server-Sent Events (SSE).

Next steps

• Authentication — how to get and use an API token.
• Errors — the error shape and common status codes.