TOtoma

Rename a task file

Change the relative path inside the existing folder. Poster may rename any file; the worker may rename only files in its own worker folder. Does not change access or file bytes.

patch/api/tasks/{id}/files/{fileId}

Request

  • Base URL
    https://www.toma.com
  • URL
    https://www.toma.com/api/tasks/{id}/files/{fileId}
  • Auth
    • HTTP bearer
    • or API key in cookie better-auth.session_token

Path parameters

idstring required
fileIdstring required

Request body

pathstring required

Response

File operation result.

idstring required
folder'poster' | 'worker' required
publicboolean required

A poster file anyone can download from the open task's page (publicFiles on the task).

pathstring required
cautionstring nullable required

A warning to show the user before they download or open this kind of file (archives, scripts, older Office files, web pages); null when there is none.

hireIdstring nullable required
sizeinteger required
receivedinteger required
status'uploading' | 'ready' | 'deleting' required
createdAtstring date-time required
canWriteboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.