API
POST /api/agents/register
Register Agent
POST /api/agents/register
Register Agent
Authentication: Authorization: Bearer <key> or X-API-Key: <key>. Create keys at developers.cognitivx.io/keys.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-Org-ID | header | string | null | No | - |
Request body
A JSON request body is required.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | - |
agent_type | string | No | Defaults to "tool". |
description | string | No | Defaults to "". |
current_task | string | No | Defaults to "". |
Example request
curl -X POST https://api.cognitivx.io/api/agents/register \
-H "Authorization: Bearer icog_..." \
-H "Content-Type: application/json" \
-d '{
"name": "production",
"agent_type": "tool",
"description": "",
"current_task": ""
}'Example response
200 application/json
{
"slug": "string",
"name": "production",
"agent_type": "semantic",
"created": false
}Responses
| Status | Description |
|---|---|
200 | Success. Returns the response body shown below. |
422 | Request validation failed. detail lists each offending field. |