Skip to main content
POST
/
api
/
v1
/
tasks
/
plan
/
stream
Plan Task Stream
curl --request POST \
  --url https://control-plane.kubiya.ai/api/v1/tasks/plan/stream \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "priority": "medium",
  "project_id": "<string>",
  "agents": [
    {
      "id": "<string>",
      "name": "<string>",
      "model_id": "<string>",
      "description": "<string>",
      "capabilities": [
        "<string>"
      ],
      "status": "active"
    }
  ],
  "teams": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "agent_count": 0,
      "status": "active"
    }
  ],
  "environments": [
    {
      "id": "<string>",
      "name": "<string>",
      "display_name": "<string>",
      "status": "active"
    }
  ],
  "worker_queues": [
    {
      "id": "<string>",
      "name": "<string>",
      "environment_id": "<string>",
      "status": "active",
      "active_workers": 0
    }
  ],
  "refinement_feedback": "<string>",
  "conversation_context": "<string>",
  "previous_plan": {},
  "iteration": 1,
  "planning_strategy": "claude_code_sdk",
  "quick_mode": false
}
'
import requests

url = "https://control-plane.kubiya.ai/api/v1/tasks/plan/stream"

payload = {
"description": "<string>",
"priority": "medium",
"project_id": "<string>",
"agents": [
{
"id": "<string>",
"name": "<string>",
"model_id": "<string>",
"description": "<string>",
"capabilities": ["<string>"],
"status": "active"
}
],
"teams": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"agent_count": 0,
"status": "active"
}
],
"environments": [
{
"id": "<string>",
"name": "<string>",
"display_name": "<string>",
"status": "active"
}
],
"worker_queues": [
{
"id": "<string>",
"name": "<string>",
"environment_id": "<string>",
"status": "active",
"active_workers": 0
}
],
"refinement_feedback": "<string>",
"conversation_context": "<string>",
"previous_plan": {},
"iteration": 1,
"planning_strategy": "claude_code_sdk",
"quick_mode": False
}
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({
description: '<string>',
priority: 'medium',
project_id: '<string>',
agents: [
{
id: '<string>',
name: '<string>',
model_id: '<string>',
description: '<string>',
capabilities: ['<string>'],
status: 'active'
}
],
teams: [
{
id: '<string>',
name: '<string>',
description: '<string>',
agent_count: 0,
status: 'active'
}
],
environments: [{id: '<string>', name: '<string>', display_name: '<string>', status: 'active'}],
worker_queues: [
{
id: '<string>',
name: '<string>',
environment_id: '<string>',
status: 'active',
active_workers: 0
}
],
refinement_feedback: '<string>',
conversation_context: '<string>',
previous_plan: {},
iteration: 1,
planning_strategy: 'claude_code_sdk',
quick_mode: false
})
};

fetch('https://control-plane.kubiya.ai/api/v1/tasks/plan/stream', 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://control-plane.kubiya.ai/api/v1/tasks/plan/stream",
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([
'description' => '<string>',
'priority' => 'medium',
'project_id' => '<string>',
'agents' => [
[
'id' => '<string>',
'name' => '<string>',
'model_id' => '<string>',
'description' => '<string>',
'capabilities' => [
'<string>'
],
'status' => 'active'
]
],
'teams' => [
[
'id' => '<string>',
'name' => '<string>',
'description' => '<string>',
'agent_count' => 0,
'status' => 'active'
]
],
'environments' => [
[
'id' => '<string>',
'name' => '<string>',
'display_name' => '<string>',
'status' => 'active'
]
],
'worker_queues' => [
[
'id' => '<string>',
'name' => '<string>',
'environment_id' => '<string>',
'status' => 'active',
'active_workers' => 0
]
],
'refinement_feedback' => '<string>',
'conversation_context' => '<string>',
'previous_plan' => [

],
'iteration' => 1,
'planning_strategy' => 'claude_code_sdk',
'quick_mode' => false
]),
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://control-plane.kubiya.ai/api/v1/tasks/plan/stream"

payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"priority\": \"medium\",\n \"project_id\": \"<string>\",\n \"agents\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"model_id\": \"<string>\",\n \"description\": \"<string>\",\n \"capabilities\": [\n \"<string>\"\n ],\n \"status\": \"active\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agent_count\": 0,\n \"status\": \"active\"\n }\n ],\n \"environments\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"status\": \"active\"\n }\n ],\n \"worker_queues\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"status\": \"active\",\n \"active_workers\": 0\n }\n ],\n \"refinement_feedback\": \"<string>\",\n \"conversation_context\": \"<string>\",\n \"previous_plan\": {},\n \"iteration\": 1,\n \"planning_strategy\": \"claude_code_sdk\",\n \"quick_mode\": false\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://control-plane.kubiya.ai/api/v1/tasks/plan/stream")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"priority\": \"medium\",\n \"project_id\": \"<string>\",\n \"agents\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"model_id\": \"<string>\",\n \"description\": \"<string>\",\n \"capabilities\": [\n \"<string>\"\n ],\n \"status\": \"active\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agent_count\": 0,\n \"status\": \"active\"\n }\n ],\n \"environments\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"status\": \"active\"\n }\n ],\n \"worker_queues\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"status\": \"active\",\n \"active_workers\": 0\n }\n ],\n \"refinement_feedback\": \"<string>\",\n \"conversation_context\": \"<string>\",\n \"previous_plan\": {},\n \"iteration\": 1,\n \"planning_strategy\": \"claude_code_sdk\",\n \"quick_mode\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://control-plane.kubiya.ai/api/v1/tasks/plan/stream")

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 \"description\": \"<string>\",\n \"priority\": \"medium\",\n \"project_id\": \"<string>\",\n \"agents\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"model_id\": \"<string>\",\n \"description\": \"<string>\",\n \"capabilities\": [\n \"<string>\"\n ],\n \"status\": \"active\"\n }\n ],\n \"teams\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"agent_count\": 0,\n \"status\": \"active\"\n }\n ],\n \"environments\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"status\": \"active\"\n }\n ],\n \"worker_queues\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"status\": \"active\",\n \"active_workers\": 0\n }\n ],\n \"refinement_feedback\": \"<string>\",\n \"conversation_context\": \"<string>\",\n \"previous_plan\": {},\n \"iteration\": 1,\n \"planning_strategy\": \"claude_code_sdk\",\n \"quick_mode\": false\n}"

response = http.request(request)
puts response.read_body
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Enter your Kubiya API token (format: Bearer )

Body

application/json

Request to plan a task

description
string
required

Task description

priority
enum<string>
default:medium

Task priority

Available options:
low,
medium,
high,
critical
project_id
string | null

Associated project ID

agents
AgentInfo · object[]

Available agents (outer context from CLI)

teams
TeamInfo · object[]

Available teams (outer context from CLI)

environments
EnvironmentInfo · object[]

Available execution environments

worker_queues
WorkerQueueInfo · object[]

Available worker queues

refinement_feedback
string | null

User feedback for plan refinement

conversation_context
string | null

Conversation history for context

previous_plan
Previous Plan · object | null

Previous plan for refinement

iteration
integer
default:1

Planning iteration number

planning_strategy
enum<string> | null
default:claude_code_sdk

Planning strategy to use (claude_code_sdk or agno)

Available options:
claude_code_sdk,
agno
quick_mode
boolean
default:false

Use fast planning for --local mode (Haiku vs Sonnet)

Response

Successful Response