Create a proposal
curl --request POST \
--url https://api.journeybee.io/v1/proposals/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"canonical_action": {
"name": "<string>",
"operationId": "<string>"
},
"input": {},
"rationale": "<string>",
"idempotency_key": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"target_records": [
{
"kind": "<string>",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"conversation_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.journeybee.io/v1/proposals/"
payload = {
"canonical_action": {
"name": "<string>",
"operationId": "<string>"
},
"input": {},
"rationale": "<string>",
"idempotency_key": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"target_records": [
{
"kind": "<string>",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"conversation_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
canonical_action: {name: '<string>', operationId: '<string>'},
input: {},
rationale: '<string>',
idempotency_key: '<string>',
expires_at: '2023-11-07T05:31:56Z',
target_records: [{kind: '<string>', uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}],
conversation_uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.journeybee.io/v1/proposals/', 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.journeybee.io/v1/proposals/",
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([
'canonical_action' => [
'name' => '<string>',
'operationId' => '<string>'
],
'input' => [
],
'rationale' => '<string>',
'idempotency_key' => '<string>',
'expires_at' => '2023-11-07T05:31:56Z',
'target_records' => [
[
'kind' => '<string>',
'uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'conversation_uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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.journeybee.io/v1/proposals/"
payload := strings.NewReader("{\n \"canonical_action\": {\n \"name\": \"<string>\",\n \"operationId\": \"<string>\"\n },\n \"input\": {},\n \"rationale\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"target_records\": [\n {\n \"kind\": \"<string>\",\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"conversation_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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.journeybee.io/v1/proposals/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"canonical_action\": {\n \"name\": \"<string>\",\n \"operationId\": \"<string>\"\n },\n \"input\": {},\n \"rationale\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"target_records\": [\n {\n \"kind\": \"<string>\",\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"conversation_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/proposals/")
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 \"canonical_action\": {\n \"name\": \"<string>\",\n \"operationId\": \"<string>\"\n },\n \"input\": {},\n \"rationale\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"target_records\": [\n {\n \"kind\": \"<string>\",\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"conversation_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"version": 123,
"state": "draft",
"canonical_action": {
"source": "internal",
"name": "<string>",
"operationId": "<string>",
"method": "GET",
"surface": "admin"
},
"input_digest": "<string>",
"input": {},
"risk_class": "read",
"approval_policy": "none",
"rationale": "<string>",
"conversation_uuid": "<string>",
"outcome": {},
"error_summary": "<string>",
"execution_run_uuid": "<string>",
"proposed_by_uuid": "<string>",
"canceled_by_uuid": "<string>",
"cancel_reason": "<string>",
"source_host": "buzz",
"expires_at": "<string>",
"proposed_at": "<string>",
"decided_at": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"parent_uuid": "<string>",
"batch_seq": 123,
"input_scrubbed_at": "<string>",
"presentation": {
"title": "<string>",
"body": "<string>",
"entity_refs": [
{
"kind": "<string>",
"ref": "<string>",
"label": "<string>"
}
],
"presentation_verification": {
"kind": "canonical_generic_wrapper",
"descriptor": "archive_task",
"version": 1,
"targets": [
{
"kind": "<string>",
"ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
},
"batch": {
"children": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_seq": 0,
"version": 0,
"state": "draft",
"included": true,
"outcome": "pending"
}
],
"progress": {
"total": 0,
"included": 0,
"succeeded": 0,
"failed": 0,
"skipped": 0,
"canceled": 0,
"outcome_unknown": 0,
"pending": 0
}
},
"children": [
{
"uuid": "<string>",
"version": 123,
"state": "draft",
"canonical_action": {
"source": "internal",
"name": "<string>",
"operationId": "<string>",
"method": "GET",
"surface": "admin"
},
"input_digest": "<string>",
"input": {},
"risk_class": "read",
"approval_policy": "none",
"rationale": "<string>",
"conversation_uuid": "<string>",
"outcome": {},
"error_summary": "<string>",
"execution_run_uuid": "<string>",
"proposed_by_uuid": "<string>",
"canceled_by_uuid": "<string>",
"cancel_reason": "<string>",
"source_host": "buzz",
"expires_at": "<string>",
"proposed_at": "<string>",
"decided_at": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"parent_uuid": "<string>",
"batch_seq": 123,
"input_scrubbed_at": "<string>",
"presentation": {
"title": "<string>",
"body": "<string>",
"entity_refs": [
{
"kind": "<string>",
"ref": "<string>",
"label": "<string>"
}
],
"presentation_verification": {
"kind": "canonical_generic_wrapper",
"descriptor": "archive_task",
"version": 1,
"targets": [
{
"kind": "<string>",
"ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
}
}
]
}Proposals
Create a proposal
Create a durable action proposal and submit it for review. API keys, OAuth apps, the Journeybee app’s assistant and the hosted MCP server may call it. An AI channel can propose but can never approve, confirm, exclude or execute. The agent scope is advertised for discovery; the action’s own permission is what is enforced.
POST
/
proposals
/
Create a proposal
curl --request POST \
--url https://api.journeybee.io/v1/proposals/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"canonical_action": {
"name": "<string>",
"operationId": "<string>"
},
"input": {},
"rationale": "<string>",
"idempotency_key": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"target_records": [
{
"kind": "<string>",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"conversation_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.journeybee.io/v1/proposals/"
payload = {
"canonical_action": {
"name": "<string>",
"operationId": "<string>"
},
"input": {},
"rationale": "<string>",
"idempotency_key": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"target_records": [
{
"kind": "<string>",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"conversation_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
canonical_action: {name: '<string>', operationId: '<string>'},
input: {},
rationale: '<string>',
idempotency_key: '<string>',
expires_at: '2023-11-07T05:31:56Z',
target_records: [{kind: '<string>', uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}],
conversation_uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.journeybee.io/v1/proposals/', 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.journeybee.io/v1/proposals/",
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([
'canonical_action' => [
'name' => '<string>',
'operationId' => '<string>'
],
'input' => [
],
'rationale' => '<string>',
'idempotency_key' => '<string>',
'expires_at' => '2023-11-07T05:31:56Z',
'target_records' => [
[
'kind' => '<string>',
'uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'conversation_uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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.journeybee.io/v1/proposals/"
payload := strings.NewReader("{\n \"canonical_action\": {\n \"name\": \"<string>\",\n \"operationId\": \"<string>\"\n },\n \"input\": {},\n \"rationale\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"target_records\": [\n {\n \"kind\": \"<string>\",\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"conversation_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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.journeybee.io/v1/proposals/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"canonical_action\": {\n \"name\": \"<string>\",\n \"operationId\": \"<string>\"\n },\n \"input\": {},\n \"rationale\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"target_records\": [\n {\n \"kind\": \"<string>\",\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"conversation_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/proposals/")
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 \"canonical_action\": {\n \"name\": \"<string>\",\n \"operationId\": \"<string>\"\n },\n \"input\": {},\n \"rationale\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"target_records\": [\n {\n \"kind\": \"<string>\",\n \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"conversation_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"version": 123,
"state": "draft",
"canonical_action": {
"source": "internal",
"name": "<string>",
"operationId": "<string>",
"method": "GET",
"surface": "admin"
},
"input_digest": "<string>",
"input": {},
"risk_class": "read",
"approval_policy": "none",
"rationale": "<string>",
"conversation_uuid": "<string>",
"outcome": {},
"error_summary": "<string>",
"execution_run_uuid": "<string>",
"proposed_by_uuid": "<string>",
"canceled_by_uuid": "<string>",
"cancel_reason": "<string>",
"source_host": "buzz",
"expires_at": "<string>",
"proposed_at": "<string>",
"decided_at": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"parent_uuid": "<string>",
"batch_seq": 123,
"input_scrubbed_at": "<string>",
"presentation": {
"title": "<string>",
"body": "<string>",
"entity_refs": [
{
"kind": "<string>",
"ref": "<string>",
"label": "<string>"
}
],
"presentation_verification": {
"kind": "canonical_generic_wrapper",
"descriptor": "archive_task",
"version": 1,
"targets": [
{
"kind": "<string>",
"ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
},
"batch": {
"children": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"batch_seq": 0,
"version": 0,
"state": "draft",
"included": true,
"outcome": "pending"
}
],
"progress": {
"total": 0,
"included": 0,
"succeeded": 0,
"failed": 0,
"skipped": 0,
"canceled": 0,
"outcome_unknown": 0,
"pending": 0
}
},
"children": [
{
"uuid": "<string>",
"version": 123,
"state": "draft",
"canonical_action": {
"source": "internal",
"name": "<string>",
"operationId": "<string>",
"method": "GET",
"surface": "admin"
},
"input_digest": "<string>",
"input": {},
"risk_class": "read",
"approval_policy": "none",
"rationale": "<string>",
"conversation_uuid": "<string>",
"outcome": {},
"error_summary": "<string>",
"execution_run_uuid": "<string>",
"proposed_by_uuid": "<string>",
"canceled_by_uuid": "<string>",
"cancel_reason": "<string>",
"source_host": "buzz",
"expires_at": "<string>",
"proposed_at": "<string>",
"decided_at": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"parent_uuid": "<string>",
"batch_seq": 123,
"input_scrubbed_at": "<string>",
"presentation": {
"title": "<string>",
"body": "<string>",
"entity_refs": [
{
"kind": "<string>",
"ref": "<string>",
"label": "<string>"
}
],
"presentation_verification": {
"kind": "canonical_generic_wrapper",
"descriptor": "archive_task",
"version": 1,
"targets": [
{
"kind": "<string>",
"ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
}
}
]
}Authorizations
API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
read, write, destructive, financial, outbound_communication, external_side_effect Available options:
none, configurable, mandatory Maximum string length:
4000Required string length:
1 - 255Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Maximum array length:
64Show child attributes
Show child attributes
Only for the Journeybee app's assistant session credential; refused for every other caller.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Response
201 - application/json
Default Response
Available options:
draft, proposed, approved, executing, succeeded, partially_succeeded, failed, denied, canceled, expired Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
read, write, destructive, financial, outbound_communication, external_side_effect Available options:
none, configurable, mandatory Show child attributes
Show child attributes
Available options:
buzz, mcp, v1, workflow, internal Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes