Skip to content

AI Connectors API

Quick Reference

  • Base URL: https://insights.omisell.com/api/v1/ai/connectors
  • Auth: Authorization: Omi <token>
  • Content-Type: application/json

Endpoints Overview

MethodEndpointMô tảAuth
GET/api/v1/ai/connectorsDanh sách connectorsYes
POST/api/v1/ai/connectorsThêm connectorYes
DELETE/api/v1/ai/connectors/{provider}Xoá connectorYes
POST/api/v1/ai/connectors/testTest connectionYes

GET /api/v1/ai/connectors

Danh sách AI connectors đã cấu hình.

Response (200 OK): AIConnector[]

FieldTypeMô tả
providerstringMã provider (openrouter, openai, anthropic, google, custom)
api_key_maskedstringAPI key đã mask (sk-or-***...***)
is_activebooleanĐang active? (chỉ 1 connector active)
created_atstringThời gian tạo
modelstring?Model ID đã chọn
model_labelstring?Tên hiển thị model

Source: (api.service.ts:76-78)


POST /api/v1/ai/connectors

Thêm connector mới. Nếu provider đã tồn tại, sẽ ghi đè.

Request Body: AIConnectorCreateRequest

FieldTypeRequiredMô tả
providerstringYesopenrouter, openai, anthropic, google, custom
api_keystringYesAPI key (plaintext — backend sẽ mask)
modelstring?NoModel ID

Response (201 Created): AIConnector

Source: (api.service.ts:80-82)

Request Example
json
{
  "provider": "openrouter",
  "api_key": "sk-or-v1-abc123...",
  "model": "anthropic/claude-sonnet-4-6"
}

DELETE /api/v1/ai/connectors/:provider

Xoá connector theo provider.

Parameters

NameLocationTypeRequiredMô tả
providerpathstringYesMã provider

Response: 204 No Content

Source: (api.service.ts:84-86)


POST /api/v1/ai/connectors/test

Test connection với AI provider trước khi lưu.

Request Body: AIConnectorTestRequest

FieldTypeRequiredMô tả
providerstringYesMã provider
api_keystringYesAPI key để test
modelstringYesModel ID để test
base_urlstring?NoCustom base URL (chỉ cho provider custom)

Response (200 OK): AIConnectorTestResponse

FieldTypeMô tả
successbooleanKết nối thành công?
messagestringThông báo chi tiết
latency_msnumber?Thời gian phản hồi (ms)

Source: (api.service.ts:88-93)

Request Example
json
{
  "provider": "openrouter",
  "api_key": "sk-or-v1-abc123...",
  "model": "anthropic/claude-sonnet-4-6"
}
Response Example (Success)
json
{
  "success": true,
  "message": "Connection successful. Model responded in 350ms.",
  "latency_ms": 350
}
Response Example (Failure)
json
{
  "success": false,
  "message": "Invalid API key. Please check your credentials.",
  "latency_ms": null
}

Supported Providers

ProviderIDAPI Key FormatModels
OpenRouteropenroutersk-or-...Multi-provider (Claude, DeepSeek, GPT...)
OpenAIopenaisk-...GPT-4o, GPT-4
Anthropicanthropicsk-ant-...Claude Opus, Claude Sonnet
GooglegoogleAIza...Gemini Pro, Gemini Flash
CustomcustomAnyOpenAI-compatible endpoints

Source: (src/app/core/models/ai-providers.ts:1-222)

Liên kết

Hệ thống tài liệu Boxme AI Insight — Powered by CodyMaster DocKit