Update Component

Partially update a component by ID.

PATCH /components/{component_id}

Update Component

cURL

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
}
'

import requests

url = "https://api.example.com/components/{component_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "component_type": "<string>",
    "metadata": {},
    "current_version": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    component_type: '<string>',
    metadata: {},
    current_version: 123
  })
};

fetch('https://api.example.com/components/{component_id}', 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/{component_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'component_type' => '<string>',
    'metadata' => [
        
    ],
    'current_version' => 123
  ]),
  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/{component_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"component_type\": \"<string>\",\n  \"metadata\": {},\n  \"current_version\": 123\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/components/{component_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"component_type\": \"<string>\",\n  \"metadata\": {},\n  \"current_version\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/components/{component_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"component_type\": \"<string>\",\n  \"metadata\": {},\n  \"current_version\": 123\n}"

response = http.request(request)
puts response.read_body

200

{
  "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

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 | null

current_version · integer | null

Response

200

application/json

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 | null

updated_at · integer | null