Report on a work item
curl --request POST \
--url https://api.sleekplan.com/v2/work-items/{number}/activities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"run_id": 123,
"text": "<string>",
"markdown": "<string>",
"document_id": 123,
"url": "<string>",
"repository": "acme/app",
"pr_number": 123,
"branch": "<string>",
"agent": "<string>"
}
'import requests
url = "https://api.sleekplan.com/v2/work-items/{number}/activities"
payload = {
"run_id": 123,
"text": "<string>",
"markdown": "<string>",
"document_id": 123,
"url": "<string>",
"repository": "acme/app",
"pr_number": 123,
"branch": "<string>",
"agent": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
run_id: 123,
text: '<string>',
markdown: '<string>',
document_id: 123,
url: '<string>',
repository: 'acme/app',
pr_number: 123,
branch: '<string>',
agent: '<string>'
})
};
fetch('https://api.sleekplan.com/v2/work-items/{number}/activities', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sleekplan.com/v2/work-items/{number}/activities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'run_id' => 123,
'text' => '<string>',
'markdown' => '<string>',
'document_id' => 123,
'url' => '<string>',
'repository' => 'acme/app',
'pr_number' => 123,
'branch' => '<string>',
'agent' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sleekplan.com/v2/work-items/{number}/activities"
payload := strings.NewReader("{\n \"run_id\": 123,\n \"text\": \"<string>\",\n \"markdown\": \"<string>\",\n \"document_id\": 123,\n \"url\": \"<string>\",\n \"repository\": \"acme/app\",\n \"pr_number\": 123,\n \"branch\": \"<string>\",\n \"agent\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sleekplan.com/v2/work-items/{number}/activities")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"run_id\": 123,\n \"text\": \"<string>\",\n \"markdown\": \"<string>\",\n \"document_id\": 123,\n \"url\": \"<string>\",\n \"repository\": \"acme/app\",\n \"pr_number\": 123,\n \"branch\": \"<string>\",\n \"agent\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sleekplan.com/v2/work-items/{number}/activities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"run_id\": 123,\n \"text\": \"<string>\",\n \"markdown\": \"<string>\",\n \"document_id\": 123,\n \"url\": \"<string>\",\n \"repository\": \"acme/app\",\n \"pr_number\": 123,\n \"branch\": \"<string>\",\n \"agent\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"data": {
"activity": {
"activity_id": 123,
"type": "plan_ready",
"kind": "report",
"run_id": 123,
"channel": "app",
"agent": "<string>",
"text": "<string>",
"data": {
"from_status": "<string>",
"to_status": "<string>",
"stage": "<string>",
"goal": "<string>",
"reason": "<string>",
"url": "<string>",
"repository": "<string>",
"pr_number": 123,
"branch": "<string>",
"document_id": 123,
"fields": [
"title",
"priority"
],
"feedback_ids": [
123
],
"until": "2023-12-25",
"evidence_id": 123
},
"created": "<string>"
},
"work_item": {
"number": 42,
"key": "WI-42",
"title": "SAML group mapping",
"brief": "<string>",
"priority": 2,
"component": "<string>",
"status": "needs_decision",
"status_reason": "new",
"stage": "spec",
"goal": "spec",
"held_until": "2023-12-25",
"source": "app",
"created": "2026-10-29 12:00:00",
"updated": "2026-10-29 12:05:31",
"closed": "<string>",
"active_run": {
"run_id": 123,
"stage": "spec",
"state": "active",
"agent": "Claude Code",
"channel": "app",
"started": "<string>",
"last_activity": "<string>",
"ended": "<string>"
},
"feedback": [
{
"feedback_id": 123,
"title": "<string>",
"status": "<string>",
"type": "<string>",
"votes": 123,
"impact_score": 123,
"user_priority": 123
}
],
"demand": {
"posts": 123,
"votes": 123,
"impact_score_max": 123,
"user_priority_avg": 123
},
"evidence": [
{
"evidence_id": 123,
"text": "<string>",
"url": "<string>",
"channel": "app",
"agent": "<string>",
"created": "<string>"
}
],
"documents": [
{
"document_id": 123,
"role": "spec",
"title": "<string>",
"updated": "<string>"
}
],
"pull_requests": [
{
"url": "<string>",
"repository": "<string>",
"pr_number": 123,
"branch": "<string>",
"state": "open"
}
]
}
}
}{
"status": "<string>",
"data": {
"key": "validation_error",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"status": "error",
"data": {
"key": "<string>",
"message": "<string>"
}
}{
"status": "error",
"data": {
"key": "<string>",
"message": "<string>"
}
}{
"status": "error",
"data": {
"key": "<string>",
"message": "<string>"
}
}{
"status": "error",
"data": {
"key": "<string>",
"message": "<string>"
}
}{
"status": "error",
"data": {
"key": "<string>",
"message": "<string>"
}
}Work item
Report on a work item
A report from whoever works on the work item. Each type needs its own fields:
type | Needs | When | Then |
|---|---|---|---|
progress | run_id, text | the run is the active one | keeps the run alive |
question | run_id, text | as above | needs_decision until a person answers |
spec_ready, plan_ready | run_id, and markdown or document_id | as above, at that stage | the document is linked; the next stage is ready if the goal lies further, else a person reviews |
pr_opened | run_id, url | as above, at stage build | in_review |
pr_merged | url | in_review | completed |
pr_closed | url | in_review | needs_decision |
failed | run_id, text | the run is the active one | needs_decision |
released | run_id | as above | ready again |
note | text | always | nothing changes |
A report repeated after a timeout (the same type, run and content as the last one) answers with the first entry and changes nothing, so retrying is safe. progress is always recorded.
POST
/
work-items
/
{number}
/
activities
Report on a work item
curl --request POST \
--url https://api.sleekplan.com/v2/work-items/{number}/activities \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"run_id": 123,
"text": "<string>",
"markdown": "<string>",
"document_id": 123,
"url": "<string>",
"repository": "acme/app",
"pr_number": 123,
"branch": "<string>",
"agent": "<string>"
}
'import requests
url = "https://api.sleekplan.com/v2/work-items/{number}/activities"
payload = {
"run_id": 123,
"text": "<string>",
"markdown": "<string>",
"document_id": 123,
"url": "<string>",
"repository": "acme/app",
"pr_number": 123,
"branch": "<string>",
"agent": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
run_id: 123,
text: '<string>',
markdown: '<string>',
document_id: 123,
url: '<string>',
repository: 'acme/app',
pr_number: 123,
branch: '<string>',
agent: '<string>'
})
};
fetch('https://api.sleekplan.com/v2/work-items/{number}/activities', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sleekplan.com/v2/work-items/{number}/activities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'run_id' => 123,
'text' => '<string>',
'markdown' => '<string>',
'document_id' => 123,
'url' => '<string>',
'repository' => 'acme/app',
'pr_number' => 123,
'branch' => '<string>',
'agent' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sleekplan.com/v2/work-items/{number}/activities"
payload := strings.NewReader("{\n \"run_id\": 123,\n \"text\": \"<string>\",\n \"markdown\": \"<string>\",\n \"document_id\": 123,\n \"url\": \"<string>\",\n \"repository\": \"acme/app\",\n \"pr_number\": 123,\n \"branch\": \"<string>\",\n \"agent\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sleekplan.com/v2/work-items/{number}/activities")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"run_id\": 123,\n \"text\": \"<string>\",\n \"markdown\": \"<string>\",\n \"document_id\": 123,\n \"url\": \"<string>\",\n \"repository\": \"acme/app\",\n \"pr_number\": 123,\n \"branch\": \"<string>\",\n \"agent\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sleekplan.com/v2/work-items/{number}/activities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"run_id\": 123,\n \"text\": \"<string>\",\n \"markdown\": \"<string>\",\n \"document_id\": 123,\n \"url\": \"<string>\",\n \"repository\": \"acme/app\",\n \"pr_number\": 123,\n \"branch\": \"<string>\",\n \"agent\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"data": {
"activity": {
"activity_id": 123,
"type": "plan_ready",
"kind": "report",
"run_id": 123,
"channel": "app",
"agent": "<string>",
"text": "<string>",
"data": {
"from_status": "<string>",
"to_status": "<string>",
"stage": "<string>",
"goal": "<string>",
"reason": "<string>",
"url": "<string>",
"repository": "<string>",
"pr_number": 123,
"branch": "<string>",
"document_id": 123,
"fields": [
"title",
"priority"
],
"feedback_ids": [
123
],
"until": "2023-12-25",
"evidence_id": 123
},
"created": "<string>"
},
"work_item": {
"number": 42,
"key": "WI-42",
"title": "SAML group mapping",
"brief": "<string>",
"priority": 2,
"component": "<string>",
"status": "needs_decision",
"status_reason": "new",
"stage": "spec",
"goal": "spec",
"held_until": "2023-12-25",
"source": "app",
"created": "2026-10-29 12:00:00",
"updated": "2026-10-29 12:05:31",
"closed": "<string>",
"active_run": {
"run_id": 123,
"stage": "spec",
"state": "active",
"agent": "Claude Code",
"channel": "app",
"started": "<string>",
"last_activity": "<string>",
"ended": "<string>"
},
"feedback": [
{
"feedback_id": 123,
"title": "<string>",
"status": "<string>",
"type": "<string>",
"votes": 123,
"impact_score": 123,
"user_priority": 123
}
],
"demand": {
"posts": 123,
"votes": 123,
"impact_score_max": 123,
"user_priority_avg": 123
},
"evidence": [
{
"evidence_id": 123,
"text": "<string>",
"url": "<string>",
"channel": "app",
"agent": "<string>",
"created": "<string>"
}
],
"documents": [
{
"document_id": 123,
"role": "spec",
"title": "<string>",
"updated": "<string>"
}
],
"pull_requests": [
{
"url": "<string>",
"repository": "<string>",
"pr_number": 123,
"branch": "<string>",
"state": "open"
}
]
}
}
}{
"status": "<string>",
"data": {
"key": "validation_error",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"status": "error",
"data": {
"key": "<string>",
"message": "<string>"
}
}{
"status": "error",
"data": {
"key": "<string>",
"message": "<string>"
}
}{
"status": "error",
"data": {
"key": "<string>",
"message": "<string>"
}
}{
"status": "error",
"data": {
"key": "<string>",
"message": "<string>"
}
}{
"status": "error",
"data": {
"key": "<string>",
"message": "<string>"
}
}Authorizations
Body
application/json
Markdown.
Maximum string length:
10000Was this page helpful?
