Skip to main content

UploadBook

Use MiaoDu to upload books.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:
  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
  • API: The API that you can call to perform the action.
  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

aimiaobi:UploadBook

create

*All Resource

*

NoneNone

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

WorkspaceId

string

Yes

Unique identifier of your Alibaba Cloud Model Studio workspace. Get your workspace ID

llm-ipe7d81yq4sl5jmk

Docs

array<object>

Yes

Documents

object

No

Document

DocName

string

No

Document name

Document1.pdf

FileUrl

string

No

File URL

http://xxx/ccc.pdf

CategoryId

string

No

Folder ID

default

Response elements

Element

Type

Description

Example

object

Response schema

RequestId

string

Request ID

3f7045e099474ba28ceca1b4eb6d6e21

Code

string

Status code

successful

Data

object

Business data

DocIds

array

Document IDs

string

Document ID

aaaxxx

ExistedIds

array

IDs of duplicate documents

string

Document ID

ccccc

HttpStatusCode

integer

HTTP status code

200

Message

string

Error message

success

Success

boolean

Operation result. Set to true for success. Set to false for failure.

true

Examples

Success response JSON format
{
  "RequestId": "3f7045e099474ba28ceca1b4eb6d6e21",
  "Code": "successful",
  "Data": {
    "DocIds": [
      "aaaxxx"
    ],
    "ExistedIds": [
      "ccccc"
    ]
  },
  "HttpStatusCode": 200,
  "Message": "success",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description

403NoPermissionYou are not authorized to perform this action.Please check the workspaceId assignment
See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.
Token Plan
Model Playground
  • 3D model generation
  • Audio generation
Fine-tuning
Model Compression
Statistics and Monitoring
Support