API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (AiContent/20240611) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Model router
|
API |
Title |
Description |
| ModelRouterCreateBalanceTransaction | ModelRouterCreateBalanceTransaction | Client management / Create balance transaction |
| ModelRouterGetClientBalanceLogs | ModelRouterGetClientBalanceLogs | Gets the balance change log for a specified department. |
| ModelRouterGetClientBalance | ModelRouterGetClientBalance | Client Management/Get department balance |
| ModelRouterConfigureClientBalance | ModelRouterConfigureClientBalance | Configures balance throttling for a department. |
| ModelRouterQueryUsageBreakdown | Batch Query Usage Details | Usage management / Query usage breakdown |
| ModelRouterQueryBillingCostBreakdown | Batch Query Billing Details | Billing > Query billing cost breakdown |
| ModelRouterUpdateBillingRule | Billing Management / Update Billing Rule | Billing management/Update billing rules |
| ModelRouterQueryClientTree | Customer Management / Retrieve Customer Tree | Returns a hierarchical tree of customers. |
| ModelRouterQueryClientDiscountLogs | Customer Management / Retrieve Department Discount Modification History | Retrieves the discount modification history for a client. |
| ModelRouterQueryBillingRuleList | Billing Management / Query Billing Rule List | Billing management / Query billing rule list |
| ModelRouterCreateBillingRule | Billing Management / Creation of Billing Rule | Billing Management/Create Billing Rule |
| ModelRouterBillingCostTabs | Retrieve the usage monitoring Tab configuration | Retrieves the tab configuration for usage monitoring. |
| ModelRouterQueryCostOverviewMetrics | Obtain Usage Overview Metrics | billing management / Get cost overview metrics |
| ModelRouterQueryCostTrendMetrics | Retrieve Usage Trend | billing management / Cost trends |
| ModelRouterQueryCostModelList | Retrieve Model Usage List | billing management / Retrieves a list of invoked models |
| ModelRouterQueryCostModelDetail | Retrieve Model Usage Details | billing management / Model details |
| ModelRouterCreateModel | Model Creation | Creates a model. |
| ModelRouterUpdateModel | Update model information | Model Management / Update Model |
| ModelRouterUpdateConversation | Update session information | Conversation management / Update conversation |
| ModelRouterUpdateClient | Update Customer Information | Updates a specified client's information. |
| ModelRouterQueryObservationMetrics | View API call report type information | Model Observation > Get Observation Metric Data |
| ModelRouterQueryObservationLogs | View API invocation records | Model Observation / Observation Logs |
| ModelRouterQueryObservationCharts | View API real-time monitoring data | Retrieves chart data for model observation. |
| ModelRouterQueryNacosTags | Retrieve model label information | Retrieves a list of tags from Nacos. |
| ModelRouterQueryNacosProviders | Obtain model identity information | Configure Nacos or retrieve the list of Nacos service providers. |
| ModelRouterQueryModelList | Retrieve Model List | Model management/Get model list |
| ModelRouterQueryModel | Retrieve Model Information | Retrieves details for a specific model. |
| ModelRouterQueryConversationList | Retrieve session list | Conversation management/Conversation list |
| ModelRouterQueryConversation | Retrieve Session Details | Retrieves the details of a conversation. |
| ModelRouterQueryClientList | Retrieve customer information | Retrieves a list of clients. |
| ModelRouterQueryApiKeyList | Retrieve API key list | Retrieves a list of API keys. |
| ModelRouterQueryApiKey | Retrieve API key information | Retrieves the details of a specific API key. |
| ModelRouterDeleteModel | Delete Model | Model Management / Delete Model |
| ModelRouterDeleteClient | Delete Customer | Deletes a client. |
| ModelRouterDeleteConversation | Delete Session | Conversation management/Delete conversation |
| ModelRouterDeleteApiKey | Delete API key | API Key Management / Delete API Key |
| ModelRouterCreateApiKey | Create API key | API key management / Create an API key |
| ModelRouterCreateClient | Create Customer | Client management / Create client |
| ModelRouterCreateConversation | Create Session | Conversation management / Create conversation |
| ModelRouterChatCompletions | Chat conversation | Generates a chat completion. |
| ModelRouterCopyApiKey | Copy API key | Copies an API key. |
oral evaluation
|
API |
Title |
Description |
| CreateAccessWarrant | 创建授权信息 | Creates an access warrant. |
| QueryApplicationAccessId | Query application access ID | Queries information about an application access ID (appkey). |
| QueryProjectList | Query project List | Alibaba Cloud console / Project List |
| QueryProject | Query project information | Alibaba Cloud console / Project list |
| CreateProject | Create Project | Alibaba Cloud console > Create Project |
| UpdateProject | Update Project Information | Alibaba Cloud Console / Update project information |
| QueryPurchasedService | Query purchased services | Alibaba Cloud Console / Purchased Services |
AI Chinese teacher
|
API |
Title |
Description |
| ExecuteAITeacherChineseCompositionTutoringWorkflowRun | Chinese Composition Tutoring | Executes a workflow for Chinese composition tutoring. |
English textbook AI teacher
|
API |
Title |
Description |
| GetTextbookAssistantToken | Obtain an authorization code for using the English textbook-style AI teacher feature | Obtains an authorization token to make API calls. |
| ListTextbookAssistantGradeVolumes | Obtain the list of grades that have English textbook resources. | Retrieves the available grades and volumes for the Textbook Assistant. |
| ListTextbookAssistantBooks | Obtain English textbook books | Retrieves a list of books for a specified grade. |
| ListTextbookAssistantBookDirectories | Retrieve the book directory of English textbooks | Gets the table of contents of a book. |
| ListTextbookAssistantArticles | Obtain the article list of English textbooks | Returns a list of articles. |
| ListTextbookAssistantArticleDetails | Retrieve article details | Batch get article details |
| ListTextbookAssistantSceneDetails | Retrieve scenario details | Get Article Details |
| ExecuteTextbookAssistantStartConversation | Start a conversation with the AI teacher | Starts a conversation with the AI teacher. The teacher then sends the initial message. |
| ExecuteTextbookAssistantDialogue | Chat with the AI teacher | Executes a dialogue turn with the Textbook Assistant. |
| ExecuteTextbookAssistantSseDialogue | AI Teacher Conversation – Streaming Output | Starts a conversation and returns a streaming output. |
| ExecuteTextbookAssistantTranslate | Retrieve the translation result of a conversation message | Translates the content of a message. |
| ExecuteTextbookAssistantSuggestion | Obtain suggested reply content for questions asked by the AI teacher in a conversation | Generates a suggested response from the textbook-based AI teacher. |
| ExecuteTextbookAssistantDifficulty | Adjust the difficulty of the AI teacher's response content | Adjusts the difficulty of the textbook assistant's dialogue. |
| ExecuteTextbookAssistantRefineByContext | Obtain the result of the polished user reply message content | Refines a sentence based on the conversational context. |
| ExecuteTextbookAssistantGrammarCheck | Obtain the result of syntax detection for user reply content | Performs a grammar check. |
| ExecuteTextbookAssistantRetryConversation | Regenerate the AI teacher's question content | This operation retries a conversation. |
AI English teacher
|
API |
Title |
Description |
| ExecuteAITeacherEnglishParaphraseChatMessage | English Q&A | Answers English-related questions. |
| ExecuteAITeacherEnglishCompositionTutoringWorkflowRun | English composition generation | English Composition Tutoring |
| AITeacherSyncPracticeTaskGenerate | Generate Synchronization Exercise Dialog Task | Synchronous basic practice is primarily for dialogue tasks with a ground truth. Although this mode allows some deviation from the ground truth, the AI strictly requires users to follow it. |
| ExecuteAITeacherSyncDialogue | Execute synchronization job | Practice synchronous dialogue. |
| ExecuteAITeacherSyncDialogueTranslate | Execute synchronization exercise translation | You can practice contextual translation in real-time. |
| GetAITeacherSyncDialogueSuggestion | Obtain synchronization practice assistant suggestions | Sync Practice Assistant |
| AITeacherExpansionPracticeTaskGenerate | Generate extended practice dialogue tasks | Generate Q&A pairs to expand data. |
| ExecuteAITeacherExpansionDialogue | Execute extended practice | Expansion dialogues are for open-ended conversations. In these conversations, the AI poses open-ended questions, but the user must stay on topic. If a user's response is off-topic, the AI steers the conversation back on topic. If the user gives two consecutive off-topic responses, the AI moves on to the next topic. |
| ExecuteAITeacherExpansionDialogueTranslate | Execute extended practice translation | Further Contextual Translation Practice. |
| GetAITeacherExpansionDialogueSuggestion | Obtain suggestions from the Extended Practice Assistant | Supplemental Practice Assistant |
| ExecuteAITeacherExpansionDialogueRefine | Execute refinement for extended practice | Uses context to polish the expanded text. |
| ExecuteAITeacherGrammarCheck | Execute syntax detection | Performs a grammar check. |
Other
|
API |
Title |
Description |
| AliyunConsoleOpenApiQueryAliyunConsoleServcieList | List of Open Service Capabilities | Lists the services available on the Alibaba Cloud Console. |
| CountOralEvaluationStatisticsConcurrent | Concurrent Count Statistics for Oral Evaluation Service | Intelligent grading / oral evaluation / statistics / concurrency |
| CountOralEvaluationStatisticsCalls | Query Oral Evaluation Service Invocation Usage | Intelligent Correction / Oral Evaluation / Statistics / call volume |
| CountOralEvaluationStatisticsError | Statistics of Error Codes for Oral Evaluation Service | Retrieves statistics about API call errors for the oral evaluation service. |
| AliyunConsoleOpenApiQueryPaidResource | Purchased resources | Alibaba Cloud Management Console / List purchased resources |
| Personalizedtxt2imgAddInferenceJob | Personalized text-to-image / Create an image inference job based on a model | Creates an inference job to generate images based on a personalized text-to-image model. |
| Personalizedtxt2imgAddModelTrainJob | Personalized text-to-image / Create a model training Job | Personalized text-to-image: Create a model training task. |
| Personalizedtxt2imgQueryModelTrainJobList | Personalized text-to-image / Query model training Job List | Your personalized model training tasks: image generation and query models. |
| Personalizedtxt2imgQueryInferenceJobInfo | Personalized text-to-image / Query the status and result information of a model inference job | Retrieves the status and results of a Personalizedtxt2img inference job. |
| Personalizedtxt2imgQueryModelTrainStatus | Query the status of personalized text-to-image/model training | Queries the training status of a personalized text-to-image model. |
| Personalizedtxt2imgQueryImageAsset | Retrieve personalized text-to-image or image binary content. | Retrieves the binary data of an image generated by the personalized text-to-image service. |
| PersonalizedTextToImageQueryPreModelInferenceJobInfo | Query preset model inference job information | Queries the status of a personalized text-to-image inference job. |
| PersonalizedTextToImageQueryImageAsset | Retrieve image resource | Retrieves the content of an image from the personalized text-to-image service using its unique image ID. |
| AliyunConsoleOpenApiQueryAliyunConsoleServiceList | Service List Query | Lists the services available in the Alibaba Cloud console. |
| PersonalizedTextToImageAddInferenceJob | Add a preset model inference job | Personalized text-to-image: Create image inference tasks using a pre-trained model. |
| ModelRouterSaveFlowConfig | ModelRouterSaveFlowConfig | Flow control management / Save flow control configuration |
该文章对您有帮助吗？