API referenceEndpoints

Read a personal agent's pinned template

Requires an authenticated user JWT. Generated from the production route registered in `internal/features/agents/inbound/roles.go`. Reads the exact trusted definition and presentation pinned to the personally owned hire. Migration preserves existing hires only when their saved definition exactly matches the Engine edition; owner text cannot replace the definition.

GET/v1/agents/{id}/template

Requires an authenticated user JWT. Generated from the production route registered in internal/features/agents/inbound/roles.go. Reads the exact trusted definition and presentation pinned to the personally owned hire. Migration preserves existing hires only when their saved definition exactly matches the Engine edition; owner text cannot replace the definition.

Authorization

bearerAuth
AuthorizationBearer <token>

Engine-issued API key or tenant-signed JWT.

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/template"
{  "role_id": "string",  "edition": 1,  "name": "string",  "description": "string",  "expertise": "string",  "setup_instructions": "string",  "requirements": [    {      "key": "string",      "kind": "answer",      "label": "string",      "prompt": "string",      "shared": true,      "tool": "string"    }  ],  "preferences": [    {      "key": "string",      "label": "string",      "kind": "text",      "options": [        "string"      ],      "max_length": 1    }  ],  "setup_required": true,  "blinq_id": "163ce100-8211-4522-93e1-e382b5984dbb",  "blinq_version": 1,  "presentation": {    "color": "string",    "avatar": "string",    "availability": "available"  },  "color": "string",  "avatar": "string",  "availability": "available",  "details": "string",  "capabilities": {    "accepts_messages": true,    "models": [      "string"    ],    "starts_on_hire": true,    "schedule_cron": "string",    "inbox_actions": [      "string"    ],    "reads_context": true,    "tools": [      "string"    ],    "limits": {      "max_model_calls": 0,      "max_input_tokens": 0,      "max_output_tokens": 0,      "max_cost_micros": 0    }  },  "executor_mode": "internal",  "core_workflow": [],  "jobs": []}