Quickstart
Get started with Cloud Coding API in minutes
Setup
Get started with the Cloud Coding API in just a few simple steps.
API Reference
The Cloud Coding API provides a powerful, production-ready streaming endpoint for all your coding tasks.
The /invoke/stdout
endpoint is recommended for production use. It provides a real-time, unfiltered stream of events from the agent, including stdout
from executed tools.
Endpoint
Headers
Request Body
Field | Type | Required | Description |
---|---|---|---|
repo_url | string | ✅ | The URL of the GitHub repository for the agent to work with. |
github_token | string | ✅ | A GitHub personal access token with repository access. |
messages | array | ▶️ | An array of messages for a single task invocation. |
parallel_tasks | array | ▶️ | An array of task objects to execute in parallel. |
branch | string | ❌ | The Git branch to work with. Defaults to main . |
haiku | boolean | ❌ | Whether to use the Haiku model. Defaults to false . |
thread_id | string | ❌ | An existing thread ID to continue a conversation. |
Note: You must provide either messages
or parallel_tasks
.
Response Stream
The API returns a stream of Server-Sent Events (SSE). Each event has an event
type (updates
or custom
) and a data
payload.
Example updates
event:
Example custom
event (tool stdout):
Quick Examples
Single Task Invocation
Invoke the agent to perform a single task.
Parallel Task Invocation
Run multiple tasks concurrently. The stream will contain interleaved events from each task, identified by task_name
.