File Upload Skill

fx-api-cli

is the provided command-line program, all operations are completed by executing the

fx-api-cli

command.

fx-api-cli file <interface name> '<json input parameters>'

Interface List

app.entry.file.get_upload_token — Interface for obtaining file upload credentials and upload address

fx-api-cli file get_upload_token '{"app_id": "app_id_1", "entry_id": "entry_id_1", "transaction_id": "transaction_id_1"}'

file.upload — File Upload Interface

fx-api-cli file upload '{"url": "upload_url", "token": "upload_token", "file": "/path/to/file"}'

Core Rules

File Upload Process

1. Obtain upload credentials: Call

   app.entry.file.get_upload_token

   to get the upload address and credentials
2. Upload file: Call

   file.upload

   to upload the file using the obtained address and credentials
3. Obtain file key: Get the file key after successful upload, which is used for subsequent create or modify operations

Transaction ID Rules

• Transaction ID: Generated by the user, UUID format is recommended
• Validity period: The valid time of both transaction_id and token is 1 hour
• Format restriction: Text in patterns such as ${var}, $(var), $(var}, ${var) are not allowed in transaction_id

File Key Rules

• File key: The unique identifier returned after the file is uploaded
• Multiple files: Support querying upload information of multiple files at one time, up to 100 files

Typical Workflow

Upload File

• "Help me upload a file"
• "Upload file to the form"

1. Collect the app ID, form ID and file path provided by the user
2. Generate transaction_id (UUID format)
3. Call

   app.entry.file.get_upload_token

   to obtain the upload address and credentials
4. Call

   file.upload

   to upload the file
5. Display the upload result, including the file key
6. Inform the user that the file key can be used for subsequent create or modify operations

Query File Upload Information

• "Help me query file upload information"
• "Check file upload status"

1. Collect the list of file keys provided by the user
2. Call

   file.upload_info_list

   to obtain file upload information
3. Display the upload status, file size, file type and other information of each file
4. If there are files that failed to upload, display the failure reason

Error Handling

• Transaction ID format error: Clearly inform the user that the transaction ID format does not meet the requirements
• Upload credential expired: Inform the user that the upload credential has expired and needs to be obtained again
• Invalid file key: Clearly inform the user of the invalid file key
• API error: Display specific error information, retry if necessary
• Network problem: Actively retry up to 3 times when HTTP error occurs