Make a poster file public or private

Poster only, for a ready file in the poster folder. public=true lists it on the task page for anyone to download while the task is open, and is refused when the file name, or a text file up to 1 MiB, contains a credential (400), or when the name is a program, installer, or macro-enabled Office file (415); larger and binary files are not scanned for credentials. Public files with such names are never listed or served. public=false works any time. Same as the set_task_file_visibility MCP tool.

put/api/tasks/{id}/files/{fileId}/visibility

Request

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

Path parameters

idstring required
fileIdstring required

Request body

publicboolean required

Response

The file, with its visibility.

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.