Files

The files APIs provide users to make preparations for creating NFTs including uploading files and the corresponding query functions.

Upload File

Upload file API helps users to upload a file to get the corresponding url for creating NFT metadata. The file can be a video, a figure and so on.

Upload file

post

http://api.nftrainbow.cnhttps://api.nftrainbow.cn

/v1/files/

Upload a file which can be a video, an image and so on

Authorizations

ApiKeyAuth

Header parameters

AuthorizationstringRequired

Bearer openapi_token

Body

multipart/form-data

filestringRequired

uploaded file

Responses

200

OK

application/json

file_namestringOptional

file_sizeintegerOptional

file_typestringOptional

file_urlstringOptional

500

Internal Server error

application/json

post

/v1/files/

HTTPcURLJavaScriptPython

POST /v1/files/ HTTP/1.1
Host: api.nftrainbow.cn
Authorization: text
Content-Type: multipart/form-data
Accept: */*
Content-Length: 15

{
  "file": "text"
}

{
  "file_name": "text",
  "file_size": 1,
  "file_type": "text",
  "file_url": "text"
}

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameters

Responses

Response Example

Request Sample

Upload File to OSS

OSS is a storage service provided by Alibaba. Users can choose to upload the files to OSS storage. Upload file to OSS API helps users to achieve the target. The file can be a video, a figure and so on.

Upload file to OSS

post

http://api.nftrainbow.cnhttps://api.nftrainbow.cn

/v1/files/oss

Upload a file to OSS, which can be a video, an image and so on

Authorizations

ApiKeyAuth

Header parameters

AuthorizationstringRequired

Bearer openapi_token

Body

multipart/form-data

filestringRequired

uploaded file

Responses

200

OK

application/json

file_namestringOptional

file_sizeintegerOptional

file_typestringOptional

file_urlstringOptional

500

Internal Server error

application/json

post

/v1/files/oss

HTTPcURLJavaScriptPython

POST /v1/files/oss HTTP/1.1
Host: api.nftrainbow.cn
Authorization: text
Content-Type: multipart/form-data
Accept: */*
Content-Length: 15

{
  "file": "text"
}

{
  "file_name": "text",
  "file_size": 1,
  "file_type": "text",
  "file_url": "text"
}

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameters

Responses

Response Example

Request Sample

Upload File List

Upload File List API helps users to upload a folder to the server. The files can be a video, a figure and so on.

Upload folder

post

http://api.nftrainbow.cnhttps://api.nftrainbow.cn

/v1/files/folder

Upload a folder containing the files which can be a video, an image and so on

Authorizations

ApiKeyAuth

Header parameters

AuthorizationstringRequired

Bearer openapi_token

Body

multipart/form-data

folderstringRequired

uploaded folder

Responses

200

OK

application/json

file_numintegerOptional

folder_urlstringOptional

500

Internal Server error

application/json

post

/v1/files/folder

HTTPcURLJavaScriptPython

POST /v1/files/folder HTTP/1.1
Host: api.nftrainbow.cn
Authorization: text
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "folder": "text"
}

{
  "file_num": 1,
  "folder_url": "text"
}

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameters

Responses

Response Example

Request Sample

Upload File List To OSS

Upload File List To OSS API helps users to upload a folder to oss. The files in this folder can be a video, a figure and so on.

Upload folder to oss

post

http://api.nftrainbow.cnhttps://api.nftrainbow.cn

/v1/files/folder/oss

Upload a folder containing the files which can be a video, an image and so on, to oss

Authorizations

ApiKeyAuth

Header parameters

AuthorizationstringRequired

Bearer openapi_token

Body

multipart/form-data

folderstringRequired

uploaded folder

Responses

200

OK

application/json

file_numintegerOptional

folder_urlstringOptional

500

Internal Server error

application/json

post

/v1/files/folder/oss

HTTPcURLJavaScriptPython

POST /v1/files/folder/oss HTTP/1.1
Host: api.nftrainbow.cn
Authorization: text
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "folder": "text"
}

{
  "file_num": 1,
  "folder_url": "text"
}

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameters

Responses

Response Example

Request Sample

Obtain File List

Obtain file list API helps users to obtain the list including the inforamion of the files uploaded in the specified app. The information of each file contains file_url, file_size, file_type and file_name.

Obtain file list

get

http://api.nftrainbow.cnhttps://api.nftrainbow.cn

/v1/files/

Get the file list containing the info of the files uploaded in the specified app

Authorizations

ApiKeyAuth

Query parameters

pagestringOptional

page

limitstringOptional

limit

Header parameters

AuthorizationstringRequired

Bearer openapi_token

Responses

200

OK

application/json

countintegerOptional

500

Internal Server error

application/json

get

/v1/files/

HTTPcURLJavaScriptPython

GET /v1/files/ HTTP/1.1
Host: api.nftrainbow.cn
Authorization: text
Accept: */*

{
  "count": 1,
  "items": [
    {
      "created_at": "text",
      "deleted_at": {
        "time": "text",
        "valid": true
      },
      "file_name": "text",
      "file_size": 1,
      "file_type": "text",
      "file_url": "text",
      "id": 1,
      "updated_at": "text"
    }
  ]
}

Auth

Name	Meaning	Param Type	Data Type
Authorization	Bearer Token	Header	string

Parameter

Response

Response Example

Request Sample