Skip to main content
PATCH
/
components
/
{component_id}
Update Component
curl --request PATCH \
  --url https://api.example.com/components/{component_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "component_type": "<string>",
  "metadata": {},
  "current_version": 123
}
'
{
  "component_id": "<string>",
  "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.

Path Parameters

​
component_id
string
required

Component ID

Body

application/json

Component fields to update

​
name
string | null
​
description
string | null
​
component_type
string | null
​
metadata
Metadata · object
​
current_version
integer | null

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