Execute Orchestration
curl --request POST \
--url https://api.truthlocks.com/v1/orchestrate/execute \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"agent_ids": [
"<string>"
],
"orchestrator_id": "<string>",
"pattern": "<string>"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({agent_ids: ['<string>'], orchestrator_id: '<string>', pattern: '<string>'})
};
fetch('https://api.truthlocks.com/v1/orchestrate/execute', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.truthlocks.com/v1/orchestrate/execute"
payload = {
"agent_ids": ["<string>"],
"orchestrator_id": "<string>",
"pattern": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.truthlocks.com/v1/orchestrate/execute"
payload := strings.NewReader("{\n \"agent_ids\": [\n \"<string>\"\n ],\n \"orchestrator_id\": \"<string>\",\n \"pattern\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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))
}{
"orchestration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agents": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"parameters": {},
"status": "pending",
"steps": [
{
"step_id": "<string>",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": "<string>",
"status": "<string>",
"result": {},
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}
],
"results": {},
"receipts": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"created_at": "2023-11-07T05:31:56Z"
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}Orchestrations & Workflows
Create an Orchestration Execution Record
Creates a tracking record for a multi-agent orchestration.
POST
/
v1
/
orchestrate
/
execute
Execute Orchestration
curl --request POST \
--url https://api.truthlocks.com/v1/orchestrate/execute \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"agent_ids": [
"<string>"
],
"orchestrator_id": "<string>",
"pattern": "<string>"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({agent_ids: ['<string>'], orchestrator_id: '<string>', pattern: '<string>'})
};
fetch('https://api.truthlocks.com/v1/orchestrate/execute', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.truthlocks.com/v1/orchestrate/execute"
payload = {
"agent_ids": ["<string>"],
"orchestrator_id": "<string>",
"pattern": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.truthlocks.com/v1/orchestrate/execute"
payload := strings.NewReader("{\n \"agent_ids\": [\n \"<string>\"\n ],\n \"orchestrator_id\": \"<string>\",\n \"pattern\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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))
}{
"orchestration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agents": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"parameters": {},
"status": "pending",
"steps": [
{
"step_id": "<string>",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": "<string>",
"status": "<string>",
"result": {},
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}
],
"results": {},
"receipts": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"created_at": "2023-11-07T05:31:56Z"
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}Creates a tracking record for a multi-agent orchestration.
Supply
pattern, orchestrator_id, and agent_ids, with optional input_payload and metadata. The current handler records an execution and returns HTTP 201. It does not itself execute your agents or guarantee that work has completed. An execution record or initial status is not evidence of completed tool calls. The generated orchestration receipt uses a system marker, not a cryptographic signature.
Use the generated parameter fields above for the request contract. Authenticate with a credential for the target workspace and environment; do not supply a tenant-selection header.Authorizations
API key for machine-to-machine authentication
Body
application/json
Response
Orchestration started

