API概览

更新时间:
复制为 MD 格式

API标准及多语言预置SDK

本产品(智能教育内容生成/20240611)的 OpenAPI 采用 ROA 签名机制,具体签名方式请参见签名机制说明我们已为开发者封装了主流编程语言的 SDK,您可通过 下载 SDK 快速调用 API,无需关注签名等底层实现细节,显著降低开发门槛与集成复杂度。

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的 RAM 用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

Model Router

API标题API概述
ModelRouterCreateBalanceTransaction客户管理/创建余额交易
ModelRouterGetClientBalanceLogs客户管理/获取部门余额变更日志
ModelRouterGetClientBalance客户管理/获取部门余额
ModelRouterConfigureClientBalance客户管理/启用部门余额限流
ModelRouterQueryUsageBreakdown用量批量明细查询
ModelRouterQueryBillingCostBreakdown计费批量明细查询
ModelRouterUpdateBillingRule计费管理/更新计费规则
ModelRouterQueryClientTree客户管理/获取客户树
ModelRouterQueryClientDiscountLogs客户管理/获取部门折扣修改历史
ModelRouterQueryBillingRuleList计费管理/查询计费规则列表
ModelRouterCreateBillingRule计费管理/创建计费规则
ModelRouterBillingCostTabs获取用量监控Tab配置获取用量监控Tab配置
ModelRouterQueryCostOverviewMetrics获取用量概览指标
ModelRouterQueryCostTrendMetrics获取用量趋势
ModelRouterQueryCostModelList获取模型用量列表
ModelRouterQueryCostModelDetail获取模型用量明细
ModelRouterCreateModel创建模型模型管理/创建模型。
ModelRouterUpdateModel更新模型信息模型管理/更新模型。
ModelRouterUpdateConversation更新会话信息对话管理/更新对话。
ModelRouterUpdateClient更新客户信息客户管理/更新客户。
ModelRouterQueryObservationMetrics查看api调用报表类型信息模型观测/获取观测指标数据。
ModelRouterQueryObservationLogs查看api调用记录模型观测/获取观测日志列表。
ModelRouterQueryObservationCharts查看api实时监控数据模型观测/获取观测图表数据。
ModelRouterQueryNacosTags获取模型标签信息Nacos配置/获取Nacos标签列表。
ModelRouterQueryNacosProviders获取模型标识信息Nacos配置/获取Nacos服务提供者列表。
ModelRouterQueryModelList获取模型列表模型管理/获取模型列表。
ModelRouterQueryModel获取模型信息模型管理/获取模型详情。
ModelRouterQueryConversationList获取会话列表对话管理/获取对话列表。
ModelRouterQueryConversation获取会话详情对话管理/获取对话详情。
ModelRouterQueryClientList获取客户信息客户管理/获取客户列表。
ModelRouterQueryApiKeyList获取api密钥列表API密钥管理/获取API密钥列表。
ModelRouterQueryApiKey获取api密钥信息API密钥管理/获取API密钥详情。
ModelRouterDeleteModel删除模型模型管理/删除模型。
ModelRouterDeleteClient删除客户客户管理/删除客户。
ModelRouterDeleteConversation删除会话对话管理/删除对话。
ModelRouterDeleteApiKey删除api密钥API密钥管理/删除API密钥。
ModelRouterCreateApiKey创建api密钥API密钥管理/创建API密钥。
ModelRouterCreateClient创建客户客户管理/创建客户。
ModelRouterCreateConversation创建会话对话管理/创建对话。
ModelRouterChatCompletions聊天对话聊天/聊天接口。
ModelRouterCopyApiKey复制api密钥API密钥管理/复制API密钥。

口语评测

API标题API概述
CreateAccessWarrant创建授权信息阿里云控制台/授权凭证创建。
QueryApplicationAccessId查询应用访问编号阿里云控制台/获取应用访问识别码(appkey)信息。
QueryProjectList查询项目列表阿里云控制台/获取项目列表
QueryProject查询项目信息阿里云控制台/获取项目列表
CreateProject创建项目阿里云控制台/创建项目
UpdateProject更新项目信息阿里云控制台/更新项目信息
QueryPurchasedService查询已购买的服务阿里云控制台/已经购买过的服务项目

AI语文老师

API标题API概述
ExecuteAITeacherChineseCompositionTutoringWorkflowRun语文作文辅导中文作文辅导。

英语教材式AI老师

API标题API概述
GetTextbookAssistantToken获取英语教材式AI老师功能使用授权码获取请求调用授权码。
ListTextbookAssistantGradeVolumes获取拥有英语教材资源的年级列表获取拥有英语教材资源的年级列表。
ListTextbookAssistantBooks获取英语教材的书本获取包含年级下的书本列表。
ListTextbookAssistantBookDirectories获取英语教材的书本目录获取书本下的目录信息。
ListTextbookAssistantArticles获取英语教材的文章列表获取文章列表。
ListTextbookAssistantArticleDetails获取文章详情批量获取文章详情
ListTextbookAssistantSceneDetails获取场景详情获取文章内容详情
ExecuteTextbookAssistantStartConversation开启与AI老师的对话发起与AI老师的对话,由Ai老师率先发起第一句对话内容。
ExecuteTextbookAssistantDialogueAI老师进行对话进行AI对话。
ExecuteTextbookAssistantSseDialogueAI老师进行对话-流式输出进行对话-流式输出
ExecuteTextbookAssistantTranslate获取对话消息的翻译结果翻译消息内容
ExecuteTextbookAssistantSuggestion获取对话中AI老师提问的建议回复内容获取鉴权参数
ExecuteTextbookAssistantDifficulty调整AI老师回复内容的难度调整难度
ExecuteTextbookAssistantRefineByContext获取润色用户回复消息内容的结果句子润色
ExecuteTextbookAssistantGrammarCheck获取用户回复内容的语法检测的结果语法检测
ExecuteTextbookAssistantRetryConversation重新生成AI老师的提问内容对话重试

AI英语老师

API标题API概述
ExecuteAITeacherEnglishParaphraseChatMessage英语答疑英语答疑
ExecuteAITeacherEnglishCompositionTutoringWorkflowRun英语作文生成英语作文辅导
AITeacherSyncPracticeTaskGenerate同步练对话任务生成同步基础练主要面向有标准答案的对话任务,虽然该模式允许用户和标准答案有一定的区别或偏差,但AI会相对严格的要求用户使用标准答案回复问题,
ExecuteAITeacherSyncDialogue执行同步练进行同步练对话。
ExecuteAITeacherSyncDialogueTranslate执行同步练翻译同步练语境翻译。
GetAITeacherSyncDialogueSuggestion获取同步练小助手提示同步练小助手。
AITeacherExpansionPracticeTaskGenerate拓展练对话任务生成拓展练问答对生成。
ExecuteAITeacherExpansionDialogue执行拓展练拓展练习对话主要针对较为开放的交流场景。在练习过程中,虽然AI提出的问题没有预设答案,但用户仍需在相关话题内进行回答。若用户回答偏离主题,AI会尝试引导其回归话题。如果用户连续两次跑题,AI将引导其继续下一个话题。
ExecuteAITeacherExpansionDialogueTranslate执行拓展练翻译拓展练语境翻译。
GetAITeacherExpansionDialogueSuggestion获取拓展练小助手提示拓展练小助手。
ExecuteAITeacherExpansionDialogueRefine执行拓展练润色拓展练根据上下文进行润色。
ExecuteAITeacherGrammarCheck执行语法检测语法检测。

其他

API标题API概述
AliyunConsoleOpenApiQueryAliyunConsoleServcieList开放的服务能力列表阿里云控制台/列出阿里云控制台上可使用的服务列表。
CountOralEvaluationStatisticsConcurrent口语评测服务并发数统计智能批改/口语评测/统计/并发数
CountOralEvaluationStatisticsCalls口语评测服务调用量查询智能批改/口语评测/统计/调用量
CountOralEvaluationStatisticsError口语评测服务错误码统计智能批改/口语评测/统计/调用错误
AliyunConsoleOpenApiQueryPaidResource已购买资源列表
Personalizedtxt2imgAddInferenceJob个性化文生图/基于一个模型创建图片推理任务个性化文生图/基于一个模型创建图片推理任务。
Personalizedtxt2imgAddModelTrainJob个性化文生图/创建一个模型训练任务个性化文生图/创建一个模型训练任务。
Personalizedtxt2imgQueryModelTrainJobList个性化文生图/查询模型训练任务列表个性化文生图/查询模型训练任务列表。
Personalizedtxt2imgQueryInferenceJobInfo个性化文生图/查询模型推理任务的状态和结果信息个性化文生图/查询模型推理任务的状态和结果信息。
Personalizedtxt2imgQueryModelTrainStatus个性化文生图/模型训练状态查询个性化文生图/模型训练状态查询。
Personalizedtxt2imgQueryImageAsset个性化文生图/图片二进制内容获取个性化文生图/图片二进制内容获取。
PersonalizedTextToImageQueryPreModelInferenceJobInfo查询预置模型推理任务信息个性化文生图/查询预制模型推理任务的状态。
PersonalizedTextToImageQueryImageAsset图片资源获取个性化文生图/通过唯一的图片编号获取图片内容。
AliyunConsoleOpenApiQueryAliyunConsoleServiceList服务列表查询阿里云控制台/列出阿里云控制台上可使用的服务列表。
PersonalizedTextToImageAddInferenceJob添加预置模型推理任务个性化文生图/基于一个预训练模型创建图片推理任务。
ModelRouterSaveFlowConfigModelRouterSaveFlowConfig