A valid request URL is required to generate request examples{
"status": "success",
"message": "Operation completed successfully"
}{
"event_id": "<string>",
"type": "<string>",
"is_vikat_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "openai",
"model_requested": "<string>",
"request_type": "<string>"
}
}{
"event_id": "<string>",
"type": "<string>",
"is_vikat_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "openai",
"model_requested": "<string>",
"request_type": "<string>"
}
}Add MCP client
Adds a new MCP client with the specified configuration. Note: tool_pricing is not available when creating a new client as tools are fetched after client creation.
A valid request URL is required to generate request examples{
"status": "success",
"message": "Operation completed successfully"
}{
"event_id": "<string>",
"type": "<string>",
"is_vikat_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "openai",
"model_requested": "<string>",
"request_type": "<string>"
}
}{
"event_id": "<string>",
"type": "<string>",
"is_vikat_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "openai",
"model_requested": "<string>",
"request_type": "<string>"
}
}Authorizations
Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>.
Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.
Body
- Option 1
- Option 2
- Option 3
MCP client configuration for creating a new client (tool_pricing not available at creation). The schema varies based on connection_type:
- HTTP/SSE: connection_string is required
- STDIO: stdio_config is required
- InProcess: server instance must be provided programmatically (Go package only)
Display name for the MCP client
Connection type for MCP client
http HTTP URL (required for HTTP connection type)
Unique identifier for the MCP client (optional, auto-generated if not provided)
Whether the MCP server supports ping for health checks. If true, uses lightweight ping method for health checks. If false, uses listTools method for health checks instead.
Authentication type for the MCP connection
none, headers, oauth, per_user_oauth, per_user_headers OAuth config ID for OAuth authentication. Set after OAuth flow is completed. References the oauth_configs table. Only relevant when auth_type is "oauth".
Custom headers to include in requests. Only used when auth_type is "headers".
Show child attributes
Show child attributes
OAuth configuration for initiating OAuth flow. Only include this when creating a client with auth_type "oauth". This will trigger the OAuth flow and return an authorization URL.
Show child attributes
Show child attributes
Include-only list for tools. ["*"] => all tools are included [] => no tools are included ["tool1", "tool2"] => include only the specified tools
List of tools that can be auto-executed without user approval. Must be a subset of tools_to_execute. ["*"] => all executable tools can be auto-executed [] => no tools are auto-executed ["tool1", "tool2"] => only specified tools can be auto-executed
When true, this MCP client's tools are available to all virtual keys by default, without requiring an explicit virtual key assignment. An explicit virtual key config always overrides this setting for that key.
TLS configuration for HTTP and SSE connections. Not applicable to stdio or inprocess connection types.
Show child attributes
Show child attributes
Required when auth_type is per_user_headers. List of header names each
end-user must supply the first time they hit this MCP server. Values are
submitted per user via the inline-401 flow — never persisted on the MCP
client config.
Used only at create time when auth_type is per_user_headers. A sample
set of header values the admin supplies so Vikat can run a one-time
upstream verify and discover the tool list. Discarded after the create
call — not persisted. Mirrors how the admin's temp OAuth token is used
for per_user_oauth setup.
Show child attributes
Show child attributes