Skip to main content
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_type": "agent",
  "component_id": "<string>",
  "description": "<string>",
  "metadata": {},
  "config": {},
  "label": "<string>",
  "stage": "draft",
  "notes": "<string>",
  "set_current": true
}
'
{
  "component_id": "<string>",
  "component_type": "agent",
  "created_at": 123,
  "name": "<string>",
  "description": "<string>",
  "current_version": 123,
  "metadata": {},
  "updated_at": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Display name

​
component_type
enum<string>
required

Type of entity: agent, team, or workflow

Available options:
agent,
team,
workflow
​
component_id
string | null

Unique identifier for the entity. Auto-generated from name if not provided.

​
description
string | null

Optional description

​
metadata
Metadata · object

Optional metadata

​
config
Config · object

Optional configuration

​
label
string | null

Optional label (e.g., 'stable')

​
stage
string
default:draft

Stage: 'draft' or 'published'

​
notes
string | null

Optional notes

​
set_current
boolean
default:true

Set as current version

Response

Successful Response

​
component_id
string
required
​
component_type
enum<string>
required
Available options:
agent,
team,
workflow
​
created_at
integer
required
​
name
string | null
​
description
string | null
​
current_version
integer | null
​
metadata
Metadata · object
​
updated_at
integer | null