Create Component
curl --request POST \
--url https://api.example.com/components \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"component_id": "<string>",
"description": "<string>",
"metadata": {},
"config": {},
"label": "<string>",
"stage": "draft",
"notes": "<string>",
"set_current": true
}
'import requests
url = "https://api.example.com/components"
payload = {
"name": "<string>",
"component_id": "<string>",
"description": "<string>",
"metadata": {},
"config": {},
"label": "<string>",
"stage": "draft",
"notes": "<string>",
"set_current": True
}
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({
name: '<string>',
component_id: '<string>',
description: '<string>',
metadata: {},
config: {},
label: '<string>',
stage: 'draft',
notes: '<string>',
set_current: true
})
};
fetch('https://api.example.com/components', 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/components",
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([
'name' => '<string>',
'component_id' => '<string>',
'description' => '<string>',
'metadata' => [
],
'config' => [
],
'label' => '<string>',
'stage' => 'draft',
'notes' => '<string>',
'set_current' => true
]),
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.example.com/components"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"component_id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"config\": {},\n \"label\": \"<string>\",\n \"stage\": \"draft\",\n \"notes\": \"<string>\",\n \"set_current\": true\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.example.com/components")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"component_id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"config\": {},\n \"label\": \"<string>\",\n \"stage\": \"draft\",\n \"notes\": \"<string>\",\n \"set_current\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/components")
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 \"name\": \"<string>\",\n \"component_id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"config\": {},\n \"label\": \"<string>\",\n \"stage\": \"draft\",\n \"notes\": \"<string>\",\n \"set_current\": true\n}"
response = http.request(request)
puts response.read_body{
"component_id": "<string>",
"created_at": 123,
"name": "<string>",
"description": "<string>",
"current_version": 123,
"metadata": {},
"updated_at": 123
}{
"detail": "Bad request",
"error_code": "BAD_REQUEST"
}{
"detail": "Unauthenticated access",
"error_code": "UNAUTHENTICATED"
}{
"detail": "Not found",
"error_code": "NOT_FOUND"
}{
"detail": "Validation error",
"error_code": "VALIDATION_ERROR"
}{
"detail": "Internal server error",
"error_code": "INTERNAL_SERVER_ERROR"
}Components
Create Component
Create a new component (agent, team, or workflow) with initial config.
POST
/
components
Create Component
curl --request POST \
--url https://api.example.com/components \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"component_id": "<string>",
"description": "<string>",
"metadata": {},
"config": {},
"label": "<string>",
"stage": "draft",
"notes": "<string>",
"set_current": true
}
'import requests
url = "https://api.example.com/components"
payload = {
"name": "<string>",
"component_id": "<string>",
"description": "<string>",
"metadata": {},
"config": {},
"label": "<string>",
"stage": "draft",
"notes": "<string>",
"set_current": True
}
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({
name: '<string>',
component_id: '<string>',
description: '<string>',
metadata: {},
config: {},
label: '<string>',
stage: 'draft',
notes: '<string>',
set_current: true
})
};
fetch('https://api.example.com/components', 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/components",
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([
'name' => '<string>',
'component_id' => '<string>',
'description' => '<string>',
'metadata' => [
],
'config' => [
],
'label' => '<string>',
'stage' => 'draft',
'notes' => '<string>',
'set_current' => true
]),
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.example.com/components"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"component_id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"config\": {},\n \"label\": \"<string>\",\n \"stage\": \"draft\",\n \"notes\": \"<string>\",\n \"set_current\": true\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.example.com/components")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"component_id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"config\": {},\n \"label\": \"<string>\",\n \"stage\": \"draft\",\n \"notes\": \"<string>\",\n \"set_current\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/components")
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 \"name\": \"<string>\",\n \"component_id\": \"<string>\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"config\": {},\n \"label\": \"<string>\",\n \"stage\": \"draft\",\n \"notes\": \"<string>\",\n \"set_current\": true\n}"
response = http.request(request)
puts response.read_body{
"component_id": "<string>",
"created_at": 123,
"name": "<string>",
"description": "<string>",
"current_version": 123,
"metadata": {},
"updated_at": 123
}{
"detail": "Bad request",
"error_code": "BAD_REQUEST"
}{
"detail": "Unauthenticated access",
"error_code": "UNAUTHENTICATED"
}{
"detail": "Not found",
"error_code": "NOT_FOUND"
}{
"detail": "Validation error",
"error_code": "VALIDATION_ERROR"
}{
"detail": "Internal server error",
"error_code": "INTERNAL_SERVER_ERROR"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Display name
Type of entity: agent, team, or workflow
Available options:
agent, team, workflow Unique identifier for the entity. Auto-generated from name if not provided.
Optional description
Optional metadata
Optional configuration
Optional label (e.g., 'stable')
Stage: 'draft' or 'published'
Optional notes
Set as current version
Was this page helpful?
⌘I