@cherrystudio/api-sdk

@cherrystudio/api-sdk@0.0.54

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @cherrystudio/api-sdk@0.0.54 --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
DefaultApi	agentCreate	POST /agents	创建Agent
DefaultApi	agentFindAll	GET /agents	获取所有Agent
DefaultApi	agentFindOne	GET /agents/{id}	根据ID获取Agent
DefaultApi	agentRemove	DELETE /agents/{id}	删除Agent
DefaultApi	agentUpdate	PATCH /agents/{id}	更新Agent
DefaultApi	anthropicMessages	POST /v1/messages
DefaultApi	apiusageGetChatHistory	GET /api-usage/chat-history	获取聊天记录
DefaultApi	appGetCasdoorDemo	GET /casdoor-demo	Casdoor 登录演示页面
DefaultApi	appInfo	GET /	应用信息
DefaultApi	assistantCreate	POST /assistants	创建智能体
DefaultApi	assistantFindAll	GET /assistants	获取所有智能体
DefaultApi	assistantFindByGroupId	GET /assistants/group/{groupId}	获取指定组的智能体列表
DefaultApi	assistantFindOne	GET /assistants/{id}	获取指定智能体
DefaultApi	assistantRemove	DELETE /assistants/{id}	删除智能体
DefaultApi	assistantUpdate	PUT /assistants/{id}	更新智能体
DefaultApi	authCasdoorCallback	GET /auth/casdoor/callback	Casdoor 登录回调
DefaultApi	authCasdoorLogin	GET /auth/casdoor	Casdoor 登录
DefaultApi	authLogin	POST /auth/login	用户登录
DefaultApi	authRefresh	POST /auth/refresh	刷新访问令牌
DefaultApi	chatCheck	POST /v1/check	检查模型可用性
DefaultApi	chatModels	GET /v1/models
DefaultApi	configurationGetConfigurations	GET /configurations	获取用户配置
DefaultApi	filedownloadDownloadFile	GET /files/download/{id}	下载文件
DefaultApi	filesFindAll	GET /files	获取所有文件
DefaultApi	filesFindOne	GET /files/{id}	根据ID获取文件
DefaultApi	filesRemove	DELETE /files/{id}	删除文件
DefaultApi	filesUploadFile	POST /files/upload	上传文件
DefaultApi	geminiCompletions	POST /v1beta/models/{id}
DefaultApi	geminiEmbeddings	POST /v1beta/openai/embeddings
DefaultApi	groupCreate	POST /groups	创建新分组
DefaultApi	groupFindAll	GET /groups	获取所有分组
DefaultApi	groupFindOne	GET /groups/{id}	根据ID获取分组
DefaultApi	groupRemove	DELETE /groups/{id}	删除分组
DefaultApi	groupUpdate	PATCH /groups/{id}	更新分组信息
DefaultApi	knowledgebaseAddItem	POST /knowledge-base/{id}/items	添加知识库条目
DefaultApi	knowledgebaseAddItemsBatch	POST /knowledge-base/{id}/items/batch	批量添加知识库条目
DefaultApi	knowledgebaseCreate	POST /knowledge-base	创建新的知识库
DefaultApi	knowledgebaseFindAll	GET /knowledge-base	获取所有知识库
DefaultApi	knowledgebaseFindOne	GET /knowledge-base/{id}	获取指定知识库
DefaultApi	knowledgebaseRemove	DELETE /knowledge-base/{id}	删除知识库
DefaultApi	knowledgebaseRemoveItem	DELETE /knowledge-base/{id}/items/{itemId}	删除知识库条目
DefaultApi	knowledgebaseRerank	POST /knowledge-base/{id}/rerank	重排序搜索结果
DefaultApi	knowledgebaseSearch	POST /knowledge-base/{id}/search	搜索知识库
DefaultApi	knowledgebaseUpdate	PATCH /knowledge-base/{id}	更新知识库
DefaultApi	knowledgebaseprocessorGetFailedItems	GET /knowledge-base-processor/failed	获取失败的项目
DefaultApi	knowledgebaseprocessorGetPendingItems	GET /knowledge-base-processor/pending	获取待处理的项目
DefaultApi	knowledgebaseprocessorGetProcessingItems	GET /knowledge-base-processor/processing	获取正在处理的项目
DefaultApi	knowledgebaseprocessorGetStats	GET /knowledge-base-processor/stats	获取队列统计信息
DefaultApi	knowledgebaseprocessorGetStatus	GET /knowledge-base-processor/status	获取队列状态
DefaultApi	knowledgebaseprocessorRetryFailedItem	GET /knowledge-base-processor/retry/{id}	重试失败的项目
DefaultApi	licenseGetCurrentLicense	GET /licenses/current	获取当前有效 License
DefaultApi	licenseImportLicense	POST /licenses/import	导入 License
DefaultApi	licenseRevokeLicense	DELETE /licenses/revoke	撤销当前 License
DefaultApi	mcpserverAddServerToAssistant	POST /mcp-servers/{serverId}/assistant/{assistantId}	为助手添加 MCP 服务器
DefaultApi	mcpserverCreate	POST /mcp-servers	创建 MCP 服务器
DefaultApi	mcpserverFindAll	GET /mcp-servers	获取所有 MCP 服务器
DefaultApi	mcpserverFindByKey	GET /mcp-servers/key/{key}	通过 key 获取 MCP 服务器
DefaultApi	mcpserverFindOne	GET /mcp-servers/{id}	获取指定 MCP 服务器
DefaultApi	mcpserverGetServersByAssistant	GET /mcp-servers/assistant/{assistantId}	获取助手关联的 MCP 服务器
DefaultApi	mcpserverRemove	DELETE /mcp-servers/{id}	删除 MCP 服务器
DefaultApi	mcpserverRemoveServerFromAssistant	DELETE /mcp-servers/{serverId}/assistant/{assistantId}	从助手移除 MCP 服务器
DefaultApi	mcpserverUpdate	PUT /mcp-servers/{id}	更新 MCP 服务器
DefaultApi	minappCreate	POST /minapps	创建小程序
DefaultApi	minappFindAll	GET /minapps	获取所有小程序
DefaultApi	minappFindOne	GET /minapps/{id}	获取指定小程序
DefaultApi	minappRemove	DELETE /minapps/{id}	删除小程序
DefaultApi	minappUpdate	PATCH /minapps/{id}	更新小程序
DefaultApi	modelFindAll	GET /models	获取所有模型
DefaultApi	modelFindByModelId	GET /models/search/{modelId}	根据模型ID搜索模型
DefaultApi	modelFindByProviderId	GET /models/provider/{providerId}	根据提供商ID获取模型列表
DefaultApi	modelFindOne	GET /models/{id}	获取指定模型
DefaultApi	modelUpdate	PUT /models/{id}	更新模型信息
DefaultApi	openaiChatCompletions	POST /v1/chat/completions
DefaultApi	openaiEmbeddings	POST /v1/embeddings
DefaultApi	openaiGenerateImage	POST /v1/images/generations	生成图片
DefaultApi	openaiRerank	POST /v1/rerank
DefaultApi	openaiResponse	POST /v1/responses
DefaultApi	permissionCreate	POST /permissions	创建权限
DefaultApi	permissionFindAll	GET /permissions	获取所有权限
DefaultApi	permissionFindOne	GET /permissions/{id}	获取指定权限
DefaultApi	permissionRemove	DELETE /permissions/{id}	删除权限
DefaultApi	permissionUpdate	PUT /permissions/{id}	更新权限信息
DefaultApi	providerAddModel	POST /providers/{id}/models	为服务商添加模型
DefaultApi	providerBatchUpdateModels	POST /providers/{id}/models/batch	批量更新服务商的模型（会删除原有模型）
DefaultApi	providerCreate	POST /providers	创建服务商
DefaultApi	providerFindAll	GET /providers	获取所有服务商
DefaultApi	providerFindOne	GET /providers/{id}	获取指定服务商
DefaultApi	providerGetTokenUsage	GET /providers/{id}/token-usage	获取 Cherryin 服务商的 token 用量信息
DefaultApi	providerRemove	DELETE /providers/{id}	删除服务商
DefaultApi	providerRemoveModel	DELETE /providers/{id}/models/{modelId}	删除服务商的指定模型
DefaultApi	providerRemoveModels	DELETE /providers/{id}/models	批量删除服务商的模型
DefaultApi	providerUpdate	PUT /providers/{id}	更新服务商
DefaultApi	roleAddPermissions	POST /roles/{id}/permissions	添加角色权限
DefaultApi	roleCreate	POST /roles	创建角色
DefaultApi	roleFindAll	GET /roles	获取所有角色
DefaultApi	roleFindOne	GET /roles/{id}	获取指定角色
DefaultApi	roleRemove	DELETE /roles/{id}	删除角色
DefaultApi	roleRemovePermissions	DELETE /roles/{id}/permissions	移除角色权限
DefaultApi	roleUpdate	PUT /roles/{id}	更新角色信息
DefaultApi	settingDelete	DELETE /settings/{key}	删除设置
DefaultApi	settingGet	GET /settings/{key}	获取指定设置
DefaultApi	settingList	GET /settings	获取所有设置
DefaultApi	settingSet	POST /settings/{key}	创建或更新设置
DefaultApi	tokenCreate	POST /tokens	Create new API token
DefaultApi	tokenUpdate	PATCH /tokens/{id}	Update API token
DefaultApi	userCreate	POST /users	创建用户
DefaultApi	userFindAll	GET /users	获取所有用户
DefaultApi	userFindOne	GET /users/{id}	获取指定用户
DefaultApi	userRemove	DELETE /users/{id}	删除用户
DefaultApi	userUpdate	PUT /users/{id}	更新用户信息
DefaultApi	workflowCreate	POST /workflows	创建工作流
DefaultApi	workflowFindAll	GET /workflows	获取所有工作流
DefaultApi	workflowFindOne	GET /workflows/{id}	获取指定工作流
DefaultApi	workflowRemove	DELETE /workflows/{id}	删除工作流
DefaultApi	workflowUpdate	PATCH /workflows/{id}	更新工作流

Documentation For Models

• AddModelDto
• AddModelsDto
• Agent
• ApiUsage
• ApiUsageListResponse
• AppInfoDto
• Assistant
• AuthLoginRequest
• CheckDto
• CheckResponseDto
• ConfigurationResponseDto
• ConfigurationResponseDtoMcpServersInner
• CreateAgentDto
• CreateAssistantDto
• CreateGroupDto
• CreateKnowledgeBaseDto
• CreateKnowledgeBaseItemDto
• CreateKnowledgeBaseItemsBatchDto
• CreateMcpServerDto
• CreateProviderDto
• CreateTokenDto
• CreateUserDto
• CreateWorkflowDto
• DeleteSettingResponseDto
• Group
• ImportLicenseDto
• KnowledgeBase
• KnowledgeBaseItem
• LicenseImportLicense201Response
• LoginResponseDto
• McpServer
• McpServerConfig
• McpServerResponseDto
• MinApp
• Model
• ModelFile
• Permission
• PermissionCreateRequest
• PermissionUpdateRequest
• Provider
• RefreshTokenDto
• RefreshTokenResponseDto
• RemoveModelsDto
• RerankKnowledgeBaseDto
• Role
• RoleAddPermissionsRequest
• RoleCreateRequest
• RoleUpdateRequest
• SearchKnowledgeBaseDto
• SearchKnowledgeBaseResponseDto
• ServerModel
• SetSettingDto
• Setting
• SettingResponseDto
• Token
• TokenUsageResponseDto
• UpdateAgentDto
• UpdateAssistantDto
• UpdateGroupDto
• UpdateKnowledgeBaseDto
• UpdateMcpServerDto
• UpdateModelDto
• UpdateTokenDto
• UpdateUserDto
• UpdateWorkflowDto
• User
• Workflow

Documentation For Authorization

Authentication schemes defined for the API:

bearer

• Type: Bearer authentication (JWT)