API standards and multilingual preset SDKs
The OpenAPI of this product (FaRui/2024-06-28) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Legal consultation
API | Title | API description |
|---|---|---|
| RunLegalAdviceConsultation | Legal consultation | Provides legal consultation. |
Contract review
API | Title | API description |
|---|---|---|
| CreateTextFile | Upload contract review file | This API is used to upload a document to the contract review module. After the upload succeeds, the system automatically starts parsing the file and returns the corresponding file ID for subsequent generation of review rules and review results. File parsing uses a queuing mechanism. If the queue is long, the file may need to wait for a while before parsing is complete. |
| RunContractRuleGeneration | Generate contract review rules | This API is used for intelligent rule generation in the contract review module. It calls a large model to return the review rules and corresponding risks for the contract. You pass in the ID of the contract review file and the review stance, and the model-generated review rules are returned incrementally via SSE. |
| RunContractResultGeneration | Generate contract review results | This API is used for review result generation in the contract review module. It calls a large model to return the contract review results, risk items, suggested modifications, and more. You pass in the ID of the contract review file, the review stance, and the review rules, and the model-generated review results are returned incrementally via SSE. |
Search services
API | Title | API description |
|---|---|---|
| RunSearchLawQuery | Law and regulation search | This API is used to search for the laws and regulations relevant to the question described by the user. After the user enters a question, a large model is called to analyze the question and retrieve the corresponding laws and regulations. |
| RunSearchCaseFulltext | Case search | This API is used to search for the cases relevant to the question described by the user. After the user enters a question, a large model parses the question to generate search conditions, and searches for the corresponding cases based on the search conditions. |
Contract extraction
API | Title | API description |
|---|---|---|
| RunContractExtract | Contract extraction | This API is used to extract corresponding fields based on contract content. After the user enters the contract link and the field extraction information, the corresponding fields are extracted. |