Agent Types API
API working on registered agent types
undefined
| Path | Method | Protected |
|---|---|---|
/v1/agent-types | GET | Yes |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| project-id | string | No | - |
Example Response JSON
[
{
"agentType": {
"typeName": "string",
"description": "string",
"constructor": {
"name": "string",
"description": "string",
"promptHint": "string",
"inputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
}
},
"methods": [
{
"name": "string",
"description": "string",
"promptHint": "string",
"inputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
},
"outputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
}
}
],
"dependencies": [
{
"typeName": "string",
"description": "string",
"constructor": {
"name": "string",
"description": "string",
"promptHint": "string",
"inputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
}
},
"methods": [
{
"name": "string",
"description": "string",
"promptHint": "string",
"inputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
},
"outputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
}
}
]
}
]
},
"implementedBy": "4477f3c1-21c0-4963-9ef3-4e200af3a9ba"
}
]undefined
| Path | Method | Protected |
|---|---|---|
/v1/agent-types/{agent-type} | GET | Yes |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| project-id | string | No | - |
Example Response JSON
{
"agentType": {
"typeName": "string",
"description": "string",
"constructor": {
"name": "string",
"description": "string",
"promptHint": "string",
"inputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
}
},
"methods": [
{
"name": "string",
"description": "string",
"promptHint": "string",
"inputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
},
"outputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
}
}
],
"dependencies": [
{
"typeName": "string",
"description": "string",
"constructor": {
"name": "string",
"description": "string",
"promptHint": "string",
"inputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
}
},
"methods": [
{
"name": "string",
"description": "string",
"promptHint": "string",
"inputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
},
"outputSchema": {
"type": "Multimodal",
"elements": [
{
"name": "string",
"schema": {
"type": "ComponentModel",
"elementType": {
"type": "Variant",
"name": "string",
"owner": "string",
"cases": [
{
"name": "string",
"typ": {}
}
]
}
}
}
]
}
}
]
}
]
},
"implementedBy": "4477f3c1-21c0-4963-9ef3-4e200af3a9ba"
}Agent Types API Errors
| Status Code | Description | Body |
|---|---|---|
| 400 | Invalid request, returning with a list of issues detected in the request | {"errors":["string"]} |
| 401 | Unauthorized | {"error":"string"} |
| 403 | Maximum number of components exceeded | {"error":"string"} |
| 404 | Component not found | {"error":"string"} |
| 409 | Component already exists | {"error":"string"} |
| 500 | Internal server error | {"error":"string"} |