Documentation Index
Fetch the complete documentation index at: https://bytestream.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Request bodies accept camelCase for common fields. Responses use snake_case.
Task fields
{
"title": "Fix login bug",
"description": "Markdown supported",
"status": "todo",
"priority": 1,
"assigneeId": "member-uuid",
"assigneeIds": ["member-uuid-1", "member-uuid-2"],
"projectId": "project-uuid",
"milestoneId": "milestone-uuid",
"teamId": "team-uuid",
"startDate": "2026-03-01",
"dueDate": "2026-04-01",
"recurrenceType": "weekly",
"recurrenceInterval": 1,
"labelIds": ["label-uuid-1", "label-uuid-2"]
}
Goal fields
{
"title": "Reach 100 paying customers by Q2",
"description": "Primary growth objective",
"owner_id": "member-uuid",
"status": "active",
"target_date": "2026-06-30"
}
KPI fields
{
"name": "paying_customers",
"description": "Total active paying customers",
"goal_id": "goal-uuid",
"unit": "count",
"unit_label": "customers",
"target_value": 100,
"target_direction": "increase",
"source_type": "manual",
"stale_after_hours": 168
}
KPI snapshot fields
{
"value": 34,
"source": "agent",
"attribution_note": "Checked Stripe dashboard",
"attributed_to_initiative_id": "initiative-uuid",
"attributed_to_issue_id": "issue-uuid"
}
current_value.
Initiative fields
{
"title": "Launch self-serve onboarding flow",
"description": "Reduce friction for new signups",
"goal_id": "goal-uuid",
"owner_id": "member-uuid",
"status": "active",
"target_date": "2026-05-15"
}
Automation rule fields
{
"name": "Auto-assign urgent bugs",
"trigger_event": "issue.created",
"conditions": [
{ "field": "priority", "operator": "eq", "value": 0 }
],
"actions": [
{ "type": "set_assignee", "value": "member-uuid" }
],
"enabled": true,
"project_id": "project-uuid"
}
{
"issue_id": "issue-uuid"
}
{
"issue": {
"status": "todo",
"priority": 2
}
}
Custom view fields
{
"name": "My sprint view",
"filters": { "status": ["in_progress", "todo"], "priority": [0, 1] },
"sort": { "field": "priority", "direction": "asc" },
"display_mode": "board",
"color": "#6B7280",
"icon": "list"
}
Webhook fields
{
"url": "https://example.com/webhook",
"events": ["issue.created", "issue.updated"],
"enabled": true
}
secret for HMAC verification.
Enums
| Domain | Field | Values |
|---|
| Task | status | backlog, todo, in_progress, done, cancelled, or custom board statuses |
| Task | priority | 0, 1, 2, 3 |
| Task | recurrenceType | daily, weekly, monthly, yearly |
| Goal | status | active, achieved, missed, paused, cancelled |
| KPI | unit | count, percentage, currency, duration, ratio, custom |
| KPI | target_direction | increase, decrease, maintain |
| KPI | source_type | manual, webhook, api_poll, formula |
| KPI snapshot | source | manual, webhook, api_poll, formula, agent |
| Initiative | status | proposed, active, completed, paused, cancelled |
| Status update | status | on_track, at_risk, off_track |
| Member | role | owner, admin, member, guest |
| Project member | accessLevel | view, edit, admin |
| Automation | trigger_event | issue.created, issue.status_changed, issue.assigned, issue.priority_changed |
| Heartbeat signal | severity | info, warning, critical |
| Custom view | display_mode | board, list |
