Skip to main content
POST
/
components
Create Component
curl --request POST \
  --url https://api.example.com/components

Request Body

FieldTypeRequiredDescription
namestringYesDisplay name for the component
component_idstringNoUnique ID (auto-generated from name if omitted)
component_typestringYesOne of: agent, team, workflow
descriptionstringNoDescription of the component
metadatadictNoAdditional metadata
configdictNoInitial configuration
labelstringNoVersion label
stagestringNoVersion stage (default: draft)
notesstringNoVersion notes
set_currentboolNoSet this version as current
{
  "name": "Research Agent",
  "component_type": "agent",
  "description": "An agent that researches topics",
  "config": {
    "model": "gpt-5-mini",
    "tools": ["WebSearchTools"],
    "instructions": "Research topics thoroughly."
  },
  "stage": "draft"
}

Response 201

Returns a ComponentResponse with the created component.