Get agent type

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

Path parameters

organizationIdstringrequired

idstringrequired

Responses

200

Agent type

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

404

Agent type not found

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*idpath*

Request

curl -X GET '/workspaces/string/agent-types/string' \
  -H 'Accept: application/json'

const response = await fetch("/workspaces/string/agent-types/string", {
  method: "GET",
  headers: {
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "/workspaces/string/agent-types/string",
    headers={
        "Accept": "application/json"
    },
)

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