SaaS APIagents

Create agent

View as Markdown

Create agent and auto-create Virtual Key. Returns fullToken once. Owner or admin.

Headers

AuthorizationstringRequired

Bearer {access_token}

X-Workspace-IdstringRequired
Workspace UUID

Request

name, provider, and masterKeyId are required; model is optional

masterKeyIdstringRequired
namestringRequired
providerstringRequired
aboutstringOptional
allowedModelslist of stringsOptional
budgetdoubleOptional
budgetActionstringOptional
budgetWindowstringOptional
departmentIdstringOptional
descriptionstringOptional
environmentstringOptional
expiresAtstringOptional
frameworkstringOptional
linkedEndpointSlugstringOptional
modelstringOptional
modelsInfomap from strings to objectsOptional

ModelsInfo 是 custom provider 时的模型价格，格式：{“modelId”: {“prompt”: 1.5, “completion”: 2.0}} 单位：美元 / 1M tokens

rateLimitRpmintegerOptional
runtimeobjectOptional

Required when source is n8n_workflow or custom_webhook. The runtimeType must match that source.

sourceenumOptionalDefaults to manual

Agent source. n8n_workflow and custom_webhook require runtime.

Response

data: agent + virtualKey (id, keyPrefix, fullToken)

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error