Update agent type

PATCH/workspaces/{organizationId}/agent-types/{id}

Path parameters

organizationIdstringrequired

idstringrequired

Request body

application/json

slugstring

min length 1

namestring

min length 1

providerAgentIdstring

min length 1

kindstring

Allowed:agenthumanexternal

endpointUrlstring<uri> | null

endpointSecretstring | null

promptstring | null

modelstring | null

toolsstring | null

jobSpecstring | null

toolScopestring | null

permissionsTierstring | null

enabledboolean

Responses

200

Agent type updated

idstringrequired

organizationIdstringrequired

slugstringrequired

namestringrequired

providerAgentIdstringrequired

jobSpecstring | nullrequired

promptstring | nullrequired

modelstring | nullrequired

toolsstring | nullrequired

kindstringrequired

endpointUrlstring | nullrequired

hasEndpointSecretbooleanrequired

toolScopestring | nullrequired

permissionsTierstring | nullrequired

enablednumberrequired

createdBystring | nullrequired

createdAtstringrequired

updatedAtstringrequired

400

Unknown providerAgentId

404

Agent type not found

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*idpath*

Bodyapplication/json

slugstringnamestringproviderAgentIdstringkindstringendpointUrlstringendpointSecretstringpromptstringmodelstringtoolsstringjobSpecstringtoolScopestringpermissionsTierstringenabledboolean

Request

curl -X PATCH '/workspaces/string/agent-types/string' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "slug": "string",
  "name": "string",
  "providerAgentId": "string",
  "kind": "agent",
  "endpointUrl": "http://example.com",
  "endpointSecret": "string",
  "prompt": "string",
  "model": "string",
  "tools": "string",
  "jobSpec": "string",
  "toolScope": "string",
  "permissionsTier": "string",
  "enabled": true
}'

const response = await fetch("/workspaces/string/agent-types/string", {
  method: "PATCH",
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"slug\": \"string\",\n  \"name\": \"string\",\n  \"providerAgentId\": \"string\",\n  \"kind\": \"agent\",\n  \"endpointUrl\": \"http://example.com\",\n  \"endpointSecret\": \"string\",\n  \"prompt\": \"string\",\n  \"model\": \"string\",\n  \"tools\": \"string\",\n  \"jobSpec\": \"string\",\n  \"toolScope\": \"string\",\n  \"permissionsTier\": \"string\",\n  \"enabled\": true\n}"
});

import requests

response = requests.patch(
    "/workspaces/string/agent-types/string",
    headers={
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"slug\": \"string\",\n  \"name\": \"string\",\n  \"providerAgentId\": \"string\",\n  \"kind\": \"agent\",\n  \"endpointUrl\": \"http://example.com\",\n  \"endpointSecret\": \"string\",\n  \"prompt\": \"string\",\n  \"model\": \"string\",\n  \"tools\": \"string\",\n  \"jobSpec\": \"string\",\n  \"toolScope\": \"string\",\n  \"permissionsTier\": \"string\",\n  \"enabled\": true\n}",
)

Response

{
  "id": "string",
  "organizationId": "string",
  "slug": "string",
  "name": "string",
  "providerAgentId": "string",
  "jobSpec": "string",
  "prompt": "string",
  "model": "string",
  "tools": "string",
  "kind": "string",
  "endpointUrl": "string",
  "hasEndpointSecret": true,
  "toolScope": "string",
  "permissionsTier": "string",
  "enabled": 0,
  "createdBy": "string",
  "createdAt": "string",
  "updatedAt": "string"
}