跳转到主要内容
POST
/
v1
/
files
/
upload
Upload A File
curl --request POST \
  --url https://files.uqpaytech.com/api/v1/files/upload \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --form file='@example-file'
{
  "create_time": "2024-08-22T17:12:58+08:00",
  "file_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
  "file_name": "example.png",
  "file_type": "png",
  "size": 123456,
  "notes": "This is a note"
}

Documentation Index

Fetch the complete documentation index at: https://developers-sandbox.uqpaytech.com/llms.txt

Use this file to discover all available pages before exploring further.

授权

​
x-auth-token
string
header
必填

Token used to request APIs

请求头

​
x-on-behalf-of
string

The value set to the connected account's ID. More information at List Connected Accounts

​
x-idempotency-key
string<uuid>
必填

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

查询参数

​
notes
string

The notes of the uploaded file, max length is 50 characters

Maximum string length: 50

请求体

multipart/form-data
​
file
file

响应

200 - application/json

OK - Successfully uploaded a file.

​
create_time
string
必填

Timestamp when the file was uploaded.

示例:

"2024-08-22T17:12:58+08:00"

​
file_id
string
必填

Unique identifier for the uploaded file. Use this ID to reference the file in other API calls.

示例:

"b3d9d2d5-4c12-4946-a09d-953e82sed2b0"

​
file_name
string
必填

Original name of the uploaded file including extension.

示例:

"example.png"

​
file_type
string
必填

File extension type (e.g., png, pdf, docx).

示例:

"png"

​
size
integer
必填

File size in bytes.

示例:

123456

​
notes
string
必填

Optional notes associated with the file.

示例:

"This is a note"