Stream App Conversation Start
curl --request POST \
--url https://api.example.com/api/v1/app-conversations/stream-start \
--header 'Content-Type: application/json' \
--header 'X-Access-Token: <api-key>' \
--data '
{
"sandbox_id": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"initial_message": {
"role": "user",
"content": [
{
"text": "<string>",
"cache_prompt": false,
"type": "text"
}
],
"run": false
},
"system_message_suffix": "<string>",
"processors": [
{
"bitbucket_view_data": {},
"should_request_summary": true,
"kind": "BitbucketV1CallbackProcessor"
}
],
"llm_model": "<string>",
"agent_profile_id": "<string>",
"selected_repository": "<string>",
"selected_branch": "<string>",
"suggested_task": {
"repo": "<string>",
"issue_number": 123,
"title": "<string>"
},
"title": "<string>",
"pr_number": [
123
],
"parent_conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_type": "default",
"public": true,
"observability_metadata": {},
"observability_tags": [
"<string>"
],
"observability_span_name": "<string>",
"plugins": [
{
"source": "<string>",
"ref": "<string>",
"repo_path": "<string>",
"parameters": {}
}
],
"secrets": {}
}
'import requests
url = "https://api.example.com/api/v1/app-conversations/stream-start"
payload = {
"sandbox_id": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"initial_message": {
"role": "user",
"content": [
{
"text": "<string>",
"cache_prompt": False,
"type": "text"
}
],
"run": False
},
"system_message_suffix": "<string>",
"processors": [
{
"bitbucket_view_data": {},
"should_request_summary": True,
"kind": "BitbucketV1CallbackProcessor"
}
],
"llm_model": "<string>",
"agent_profile_id": "<string>",
"selected_repository": "<string>",
"selected_branch": "<string>",
"suggested_task": {
"repo": "<string>",
"issue_number": 123,
"title": "<string>"
},
"title": "<string>",
"pr_number": [123],
"parent_conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_type": "default",
"public": True,
"observability_metadata": {},
"observability_tags": ["<string>"],
"observability_span_name": "<string>",
"plugins": [
{
"source": "<string>",
"ref": "<string>",
"repo_path": "<string>",
"parameters": {}
}
],
"secrets": {}
}
headers = {
"X-Access-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Access-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sandbox_id: '<string>',
conversation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
initial_message: {
role: 'user',
content: [{text: '<string>', cache_prompt: false, type: 'text'}],
run: false
},
system_message_suffix: '<string>',
processors: [
{
bitbucket_view_data: {},
should_request_summary: true,
kind: 'BitbucketV1CallbackProcessor'
}
],
llm_model: '<string>',
agent_profile_id: '<string>',
selected_repository: '<string>',
selected_branch: '<string>',
suggested_task: {repo: '<string>', issue_number: 123, title: '<string>'},
title: '<string>',
pr_number: [123],
parent_conversation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
agent_type: 'default',
public: true,
observability_metadata: {},
observability_tags: ['<string>'],
observability_span_name: '<string>',
plugins: [{source: '<string>', ref: '<string>', repo_path: '<string>', parameters: {}}],
secrets: {}
})
};
fetch('https://api.example.com/api/v1/app-conversations/stream-start', 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.example.com/api/v1/app-conversations/stream-start",
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([
'sandbox_id' => '<string>',
'conversation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'initial_message' => [
'role' => 'user',
'content' => [
[
'text' => '<string>',
'cache_prompt' => false,
'type' => 'text'
]
],
'run' => false
],
'system_message_suffix' => '<string>',
'processors' => [
[
'bitbucket_view_data' => [
],
'should_request_summary' => true,
'kind' => 'BitbucketV1CallbackProcessor'
]
],
'llm_model' => '<string>',
'agent_profile_id' => '<string>',
'selected_repository' => '<string>',
'selected_branch' => '<string>',
'suggested_task' => [
'repo' => '<string>',
'issue_number' => 123,
'title' => '<string>'
],
'title' => '<string>',
'pr_number' => [
123
],
'parent_conversation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'agent_type' => 'default',
'public' => true,
'observability_metadata' => [
],
'observability_tags' => [
'<string>'
],
'observability_span_name' => '<string>',
'plugins' => [
[
'source' => '<string>',
'ref' => '<string>',
'repo_path' => '<string>',
'parameters' => [
]
]
],
'secrets' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Access-Token: <api-key>"
],
]);
$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.example.com/api/v1/app-conversations/stream-start"
payload := strings.NewReader("{\n \"sandbox_id\": \"<string>\",\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"initial_message\": {\n \"role\": \"user\",\n \"content\": [\n {\n \"text\": \"<string>\",\n \"cache_prompt\": false,\n \"type\": \"text\"\n }\n ],\n \"run\": false\n },\n \"system_message_suffix\": \"<string>\",\n \"processors\": [\n {\n \"bitbucket_view_data\": {},\n \"should_request_summary\": true,\n \"kind\": \"BitbucketV1CallbackProcessor\"\n }\n ],\n \"llm_model\": \"<string>\",\n \"agent_profile_id\": \"<string>\",\n \"selected_repository\": \"<string>\",\n \"selected_branch\": \"<string>\",\n \"suggested_task\": {\n \"repo\": \"<string>\",\n \"issue_number\": 123,\n \"title\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"pr_number\": [\n 123\n ],\n \"parent_conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agent_type\": \"default\",\n \"public\": true,\n \"observability_metadata\": {},\n \"observability_tags\": [\n \"<string>\"\n ],\n \"observability_span_name\": \"<string>\",\n \"plugins\": [\n {\n \"source\": \"<string>\",\n \"ref\": \"<string>\",\n \"repo_path\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"secrets\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Access-Token", "<api-key>")
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.example.com/api/v1/app-conversations/stream-start")
.header("X-Access-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sandbox_id\": \"<string>\",\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"initial_message\": {\n \"role\": \"user\",\n \"content\": [\n {\n \"text\": \"<string>\",\n \"cache_prompt\": false,\n \"type\": \"text\"\n }\n ],\n \"run\": false\n },\n \"system_message_suffix\": \"<string>\",\n \"processors\": [\n {\n \"bitbucket_view_data\": {},\n \"should_request_summary\": true,\n \"kind\": \"BitbucketV1CallbackProcessor\"\n }\n ],\n \"llm_model\": \"<string>\",\n \"agent_profile_id\": \"<string>\",\n \"selected_repository\": \"<string>\",\n \"selected_branch\": \"<string>\",\n \"suggested_task\": {\n \"repo\": \"<string>\",\n \"issue_number\": 123,\n \"title\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"pr_number\": [\n 123\n ],\n \"parent_conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agent_type\": \"default\",\n \"public\": true,\n \"observability_metadata\": {},\n \"observability_tags\": [\n \"<string>\"\n ],\n \"observability_span_name\": \"<string>\",\n \"plugins\": [\n {\n \"source\": \"<string>\",\n \"ref\": \"<string>\",\n \"repo_path\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"secrets\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/app-conversations/stream-start")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Access-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sandbox_id\": \"<string>\",\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"initial_message\": {\n \"role\": \"user\",\n \"content\": [\n {\n \"text\": \"<string>\",\n \"cache_prompt\": false,\n \"type\": \"text\"\n }\n ],\n \"run\": false\n },\n \"system_message_suffix\": \"<string>\",\n \"processors\": [\n {\n \"bitbucket_view_data\": {},\n \"should_request_summary\": true,\n \"kind\": \"BitbucketV1CallbackProcessor\"\n }\n ],\n \"llm_model\": \"<string>\",\n \"agent_profile_id\": \"<string>\",\n \"selected_repository\": \"<string>\",\n \"selected_branch\": \"<string>\",\n \"suggested_task\": {\n \"repo\": \"<string>\",\n \"issue_number\": 123,\n \"title\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"pr_number\": [\n 123\n ],\n \"parent_conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agent_type\": \"default\",\n \"public\": true,\n \"observability_metadata\": {},\n \"observability_tags\": [\n \"<string>\"\n ],\n \"observability_span_name\": \"<string>\",\n \"plugins\": [\n {\n \"source\": \"<string>\",\n \"ref\": \"<string>\",\n \"repo_path\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"secrets\": {}\n}"
response = http.request(request)
puts response.read_body[
{
"created_by_user_id": "<string>",
"request": {
"sandbox_id": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"initial_message": {
"role": "user",
"content": [
{
"text": "<string>",
"cache_prompt": false,
"type": "text"
}
],
"run": false
},
"system_message_suffix": "<string>",
"processors": [
{
"kind": "BitbucketV1CallbackProcessor",
"bitbucket_view_data": {},
"should_request_summary": true
}
],
"llm_model": "<string>",
"agent_profile_id": "<string>",
"selected_repository": "<string>",
"selected_branch": "<string>",
"suggested_task": {
"repo": "<string>",
"issue_number": 123,
"title": "<string>"
},
"title": "<string>",
"pr_number": [
123
],
"parent_conversation_id": "<string>",
"agent_type": "default",
"public": true,
"observability_metadata": {},
"observability_tags": [
"<string>"
],
"observability_span_name": "<string>",
"plugins": [
{
"source": "<string>",
"ref": "<string>",
"repo_path": "<string>",
"parameters": {}
}
],
"secrets": {}
},
"id": "<string>",
"status": "WORKING",
"detail": "<string>",
"app_conversation_id": "<string>",
"sandbox_id": "<string>",
"agent_server_url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Conversations
Stream App Conversation Start
Start an app conversation start task and stream updates from it. Leaves the connection open until either the conversation starts or there was an error
POST
/
api
/
v1
/
app-conversations
/
stream-start
Stream App Conversation Start
curl --request POST \
--url https://api.example.com/api/v1/app-conversations/stream-start \
--header 'Content-Type: application/json' \
--header 'X-Access-Token: <api-key>' \
--data '
{
"sandbox_id": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"initial_message": {
"role": "user",
"content": [
{
"text": "<string>",
"cache_prompt": false,
"type": "text"
}
],
"run": false
},
"system_message_suffix": "<string>",
"processors": [
{
"bitbucket_view_data": {},
"should_request_summary": true,
"kind": "BitbucketV1CallbackProcessor"
}
],
"llm_model": "<string>",
"agent_profile_id": "<string>",
"selected_repository": "<string>",
"selected_branch": "<string>",
"suggested_task": {
"repo": "<string>",
"issue_number": 123,
"title": "<string>"
},
"title": "<string>",
"pr_number": [
123
],
"parent_conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_type": "default",
"public": true,
"observability_metadata": {},
"observability_tags": [
"<string>"
],
"observability_span_name": "<string>",
"plugins": [
{
"source": "<string>",
"ref": "<string>",
"repo_path": "<string>",
"parameters": {}
}
],
"secrets": {}
}
'import requests
url = "https://api.example.com/api/v1/app-conversations/stream-start"
payload = {
"sandbox_id": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"initial_message": {
"role": "user",
"content": [
{
"text": "<string>",
"cache_prompt": False,
"type": "text"
}
],
"run": False
},
"system_message_suffix": "<string>",
"processors": [
{
"bitbucket_view_data": {},
"should_request_summary": True,
"kind": "BitbucketV1CallbackProcessor"
}
],
"llm_model": "<string>",
"agent_profile_id": "<string>",
"selected_repository": "<string>",
"selected_branch": "<string>",
"suggested_task": {
"repo": "<string>",
"issue_number": 123,
"title": "<string>"
},
"title": "<string>",
"pr_number": [123],
"parent_conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_type": "default",
"public": True,
"observability_metadata": {},
"observability_tags": ["<string>"],
"observability_span_name": "<string>",
"plugins": [
{
"source": "<string>",
"ref": "<string>",
"repo_path": "<string>",
"parameters": {}
}
],
"secrets": {}
}
headers = {
"X-Access-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Access-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sandbox_id: '<string>',
conversation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
initial_message: {
role: 'user',
content: [{text: '<string>', cache_prompt: false, type: 'text'}],
run: false
},
system_message_suffix: '<string>',
processors: [
{
bitbucket_view_data: {},
should_request_summary: true,
kind: 'BitbucketV1CallbackProcessor'
}
],
llm_model: '<string>',
agent_profile_id: '<string>',
selected_repository: '<string>',
selected_branch: '<string>',
suggested_task: {repo: '<string>', issue_number: 123, title: '<string>'},
title: '<string>',
pr_number: [123],
parent_conversation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
agent_type: 'default',
public: true,
observability_metadata: {},
observability_tags: ['<string>'],
observability_span_name: '<string>',
plugins: [{source: '<string>', ref: '<string>', repo_path: '<string>', parameters: {}}],
secrets: {}
})
};
fetch('https://api.example.com/api/v1/app-conversations/stream-start', 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.example.com/api/v1/app-conversations/stream-start",
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([
'sandbox_id' => '<string>',
'conversation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'initial_message' => [
'role' => 'user',
'content' => [
[
'text' => '<string>',
'cache_prompt' => false,
'type' => 'text'
]
],
'run' => false
],
'system_message_suffix' => '<string>',
'processors' => [
[
'bitbucket_view_data' => [
],
'should_request_summary' => true,
'kind' => 'BitbucketV1CallbackProcessor'
]
],
'llm_model' => '<string>',
'agent_profile_id' => '<string>',
'selected_repository' => '<string>',
'selected_branch' => '<string>',
'suggested_task' => [
'repo' => '<string>',
'issue_number' => 123,
'title' => '<string>'
],
'title' => '<string>',
'pr_number' => [
123
],
'parent_conversation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'agent_type' => 'default',
'public' => true,
'observability_metadata' => [
],
'observability_tags' => [
'<string>'
],
'observability_span_name' => '<string>',
'plugins' => [
[
'source' => '<string>',
'ref' => '<string>',
'repo_path' => '<string>',
'parameters' => [
]
]
],
'secrets' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Access-Token: <api-key>"
],
]);
$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.example.com/api/v1/app-conversations/stream-start"
payload := strings.NewReader("{\n \"sandbox_id\": \"<string>\",\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"initial_message\": {\n \"role\": \"user\",\n \"content\": [\n {\n \"text\": \"<string>\",\n \"cache_prompt\": false,\n \"type\": \"text\"\n }\n ],\n \"run\": false\n },\n \"system_message_suffix\": \"<string>\",\n \"processors\": [\n {\n \"bitbucket_view_data\": {},\n \"should_request_summary\": true,\n \"kind\": \"BitbucketV1CallbackProcessor\"\n }\n ],\n \"llm_model\": \"<string>\",\n \"agent_profile_id\": \"<string>\",\n \"selected_repository\": \"<string>\",\n \"selected_branch\": \"<string>\",\n \"suggested_task\": {\n \"repo\": \"<string>\",\n \"issue_number\": 123,\n \"title\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"pr_number\": [\n 123\n ],\n \"parent_conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agent_type\": \"default\",\n \"public\": true,\n \"observability_metadata\": {},\n \"observability_tags\": [\n \"<string>\"\n ],\n \"observability_span_name\": \"<string>\",\n \"plugins\": [\n {\n \"source\": \"<string>\",\n \"ref\": \"<string>\",\n \"repo_path\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"secrets\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Access-Token", "<api-key>")
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.example.com/api/v1/app-conversations/stream-start")
.header("X-Access-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sandbox_id\": \"<string>\",\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"initial_message\": {\n \"role\": \"user\",\n \"content\": [\n {\n \"text\": \"<string>\",\n \"cache_prompt\": false,\n \"type\": \"text\"\n }\n ],\n \"run\": false\n },\n \"system_message_suffix\": \"<string>\",\n \"processors\": [\n {\n \"bitbucket_view_data\": {},\n \"should_request_summary\": true,\n \"kind\": \"BitbucketV1CallbackProcessor\"\n }\n ],\n \"llm_model\": \"<string>\",\n \"agent_profile_id\": \"<string>\",\n \"selected_repository\": \"<string>\",\n \"selected_branch\": \"<string>\",\n \"suggested_task\": {\n \"repo\": \"<string>\",\n \"issue_number\": 123,\n \"title\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"pr_number\": [\n 123\n ],\n \"parent_conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agent_type\": \"default\",\n \"public\": true,\n \"observability_metadata\": {},\n \"observability_tags\": [\n \"<string>\"\n ],\n \"observability_span_name\": \"<string>\",\n \"plugins\": [\n {\n \"source\": \"<string>\",\n \"ref\": \"<string>\",\n \"repo_path\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"secrets\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/app-conversations/stream-start")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Access-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sandbox_id\": \"<string>\",\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"initial_message\": {\n \"role\": \"user\",\n \"content\": [\n {\n \"text\": \"<string>\",\n \"cache_prompt\": false,\n \"type\": \"text\"\n }\n ],\n \"run\": false\n },\n \"system_message_suffix\": \"<string>\",\n \"processors\": [\n {\n \"bitbucket_view_data\": {},\n \"should_request_summary\": true,\n \"kind\": \"BitbucketV1CallbackProcessor\"\n }\n ],\n \"llm_model\": \"<string>\",\n \"agent_profile_id\": \"<string>\",\n \"selected_repository\": \"<string>\",\n \"selected_branch\": \"<string>\",\n \"suggested_task\": {\n \"repo\": \"<string>\",\n \"issue_number\": 123,\n \"title\": \"<string>\"\n },\n \"title\": \"<string>\",\n \"pr_number\": [\n 123\n ],\n \"parent_conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"agent_type\": \"default\",\n \"public\": true,\n \"observability_metadata\": {},\n \"observability_tags\": [\n \"<string>\"\n ],\n \"observability_span_name\": \"<string>\",\n \"plugins\": [\n {\n \"source\": \"<string>\",\n \"ref\": \"<string>\",\n \"repo_path\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"secrets\": {}\n}"
response = http.request(request)
puts response.read_body[
{
"created_by_user_id": "<string>",
"request": {
"sandbox_id": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"initial_message": {
"role": "user",
"content": [
{
"text": "<string>",
"cache_prompt": false,
"type": "text"
}
],
"run": false
},
"system_message_suffix": "<string>",
"processors": [
{
"kind": "BitbucketV1CallbackProcessor",
"bitbucket_view_data": {},
"should_request_summary": true
}
],
"llm_model": "<string>",
"agent_profile_id": "<string>",
"selected_repository": "<string>",
"selected_branch": "<string>",
"suggested_task": {
"repo": "<string>",
"issue_number": 123,
"title": "<string>"
},
"title": "<string>",
"pr_number": [
123
],
"parent_conversation_id": "<string>",
"agent_type": "default",
"public": true,
"observability_metadata": {},
"observability_tags": [
"<string>"
],
"observability_span_name": "<string>",
"plugins": [
{
"source": "<string>",
"ref": "<string>",
"repo_path": "<string>",
"parameters": {}
}
],
"secrets": {}
},
"id": "<string>",
"status": "WORKING",
"detail": "<string>",
"app_conversation_id": "<string>",
"sandbox_id": "<string>",
"agent_server_url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Body
application/json
Start conversation request object.
Although a user can go directly to the sandbox and start conversations, they would need to manually supply required startup parameters such as LLM key. Starting from the app server copies these from the user info.
Payload to send a message to the agent.
Show child attributes
Show child attributes
processors
(BitbucketV1CallbackProcessor · object | GithubV1CallbackProcessor · object | GitlabV1CallbackProcessor · object | JiraV1CallbackProcessor · object | JiraDcV1CallbackProcessor · object | SlackV1CallbackProcessor · object | LoggingCallbackProcessor · object | SetTitleCallbackProcessor · object)[] | null
V1 callback processor for the Bitbucket Cloud resolver.
Posts a summary comment back to the originating PR when the agent
finishes successfully. Mirrors :class:GitlabV1CallbackProcessor.
- BitbucketV1CallbackProcessor
- GithubV1CallbackProcessor
- GitlabV1CallbackProcessor
- JiraV1CallbackProcessor
- JiraDcV1CallbackProcessor
- SlackV1CallbackProcessor
- LoggingCallbackProcessor
- SetTitleCallbackProcessor
Show child attributes
Show child attributes
Available options:
github, gitlab, bitbucket, bitbucket_data_center, forgejo, azure_devops, enterprise_sso Show child attributes
Show child attributes
Available options:
resolver, gui, suggested_task, openhands_api, slack, microagent_management, jira, jira_dc, linear, bitbucket, automation Agent type for conversation.
Available options:
default, plan Trace-level metadata to attach to observability backends. Values must be scalars or homogeneous scalar lists supported by OpenTelemetry.
Show child attributes
Show child attributes
Tags to attach to the conversation root observability span.
Optional named child span to emit under the conversation root. Use stable, low-cardinality names because observability backends may use span names for grouping or signal routing.
List of plugins to load for this conversation. Plugins are loaded and their skills/MCP config are merged into the agent.
Show child attributes
Show child attributes
Secrets to pass to the conversation. These are merged with any existing secrets (from database or git providers), with API-provided secrets taking precedence (overriding any existing secret with the same name). Keys are secret names (e.g., "MY_API_KEY"), values are the secret values. Warning: Providing a secret that already exists will silently override it.
Show child attributes
Show child attributes
Response
Successful Response
Start conversation request object.
Although a user can go directly to the sandbox and start conversations, they would need to manually supply required startup parameters such as LLM key. Starting from the app server copies these from the user info.
Show child attributes
Show child attributes
Available options:
WORKING, WAITING_FOR_SANDBOX, PREPARING_REPOSITORY, RUNNING_SETUP_SCRIPT, SETTING_UP_GIT_HOOKS, SETTING_UP_SKILLS, STARTING_CONVERSATION, READY, ERROR The id of the app_conversation, if READY
The id of the sandbox, if READY
The agent server url, if READY
Was this page helpful?
⌘I