Files
a2a-platform 197f1bd317 deploy
2026-06-27 01:02:21 +00:00

14 KiB

name, description
name description
files-routes Handle 48 OpenAPI operation(s) under /files for the files route group.

files API Routes

Handle 48 OpenAPI operation(s) under /files for the files route group.

Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.

Operations

get_files_id

  • Operation ID: get_files_id
  • Route: GET /files/{file_id}
  • Mode: READ
  • Summary: Get file information
  • Parameters:
    • file_id in path required
    • fields in query
    • if-none-match in header
    • boxapi in header
    • x-rep-hints in header

post_files_id

  • Operation ID: post_files_id
  • Route: POST /files/{file_id}
  • Mode: WRITE
  • Summary: Restore file
  • Parameters:
    • file_id in path required
    • fields in query
  • Body: JSON request body accepted.

put_files_id

  • Operation ID: put_files_id
  • Route: PUT /files/{file_id}
  • Mode: WRITE
  • Summary: Update file
  • Parameters:
    • file_id in path required
    • fields in query
    • if-match in header
  • Body: JSON request body accepted.

delete_files_id

  • Operation ID: delete_files_id
  • Route: DELETE /files/{file_id}
  • Mode: WRITE
  • Summary: Delete file
  • Parameters:
    • file_id in path required
    • if-match in header

get_files_id_app_item_associations

  • Operation ID: get_files_id_app_item_associations
  • Route: GET /files/{file_id}/app_item_associations
  • Mode: READ
  • Summary: List file app item associations
  • Parameters:
    • file_id in path required
    • limit in query
    • marker in query
    • application_type in query

get_files_id_content

  • Operation ID: get_files_id_content
  • Route: GET /files/{file_id}/content
  • Mode: READ
  • Summary: Download file
  • Parameters:
    • file_id in path required
    • range in header
    • boxapi in header
    • version in query
    • access_token in query

post_files_id_content

  • Operation ID: post_files_id_content
  • Route: POST /files/{file_id}/content
  • Mode: WRITE
  • Summary: Upload file version
  • Parameters:
    • file_id in path required
    • if-match in header
    • fields in query
    • content-md5 in header
  • Body: JSON request body accepted.

options_files_content

  • Operation ID: options_files_content
  • Route: OPTIONS /files/content
  • Mode: READ
  • Summary: Preflight check before upload
  • Body: JSON request body accepted.

post_files_content

  • Operation ID: post_files_content
  • Route: POST /files/content
  • Mode: WRITE
  • Summary: Upload file
  • Parameters:
    • fields in query
    • content-md5 in header
  • Body: JSON request body accepted.

post_files_upload_sessions

  • Operation ID: post_files_upload_sessions
  • Route: POST /files/upload_sessions
  • Mode: WRITE
  • Summary: Create upload session
  • Body: JSON request body accepted.

post_files_id_upload_sessions

  • Operation ID: post_files_id_upload_sessions
  • Route: POST /files/{file_id}/upload_sessions
  • Mode: WRITE
  • Summary: Create upload session for existing file
  • Parameters:
    • file_id in path required
  • Body: JSON request body accepted.

get_files_upload_sessions_id

  • Operation ID: get_files_upload_sessions_id
  • Route: GET /files/upload_sessions/{upload_session_id}
  • Mode: READ
  • Summary: Get upload session
  • Parameters:
    • upload_session_id in path required

put_files_upload_sessions_id

  • Operation ID: put_files_upload_sessions_id
  • Route: PUT /files/upload_sessions/{upload_session_id}
  • Mode: WRITE
  • Summary: Upload part of file
  • Parameters:
    • upload_session_id in path required
    • digest in header required
    • content-range in header required
  • Body: JSON request body accepted.

delete_files_upload_sessions_id

  • Operation ID: delete_files_upload_sessions_id
  • Route: DELETE /files/upload_sessions/{upload_session_id}
  • Mode: WRITE
  • Summary: Remove upload session
  • Parameters:
    • upload_session_id in path required

get_files_upload_sessions_id_parts

  • Operation ID: get_files_upload_sessions_id_parts
  • Route: GET /files/upload_sessions/{upload_session_id}/parts
  • Mode: READ
  • Summary: List parts
  • Parameters:
    • upload_session_id in path required
    • offset in query
    • limit in query

post_files_upload_sessions_id_commit

  • Operation ID: post_files_upload_sessions_id_commit
  • Route: POST /files/upload_sessions/{upload_session_id}/commit
  • Mode: WRITE
  • Summary: Commit upload session
  • Parameters:
    • upload_session_id in path required
    • digest in header required
    • if-match in header
    • if-none-match in header
  • Body: JSON request body accepted.

post_files_id_copy

  • Operation ID: post_files_id_copy
  • Route: POST /files/{file_id}/copy
  • Mode: WRITE
  • Summary: Copy file
  • Parameters:
    • file_id in path required
    • fields in query
  • Body: JSON request body accepted.

get_files_id_thumbnail_id

  • Operation ID: get_files_id_thumbnail_id
  • Route: GET /files/{file_id}/thumbnail.{extension}
  • Mode: READ
  • Summary: Get file thumbnail
  • Parameters:
    • file_id in path required
    • extension in path required
    • min_height in query
    • min_width in query
    • max_height in query
    • max_width in query

get_files_id_collaborations

  • Operation ID: get_files_id_collaborations
  • Route: GET /files/{file_id}/collaborations
  • Mode: READ
  • Summary: List file collaborations
  • Parameters:
    • file_id in path required
    • fields in query
    • limit in query
    • marker in query

get_files_id_comments

  • Operation ID: get_files_id_comments
  • Route: GET /files/{file_id}/comments
  • Mode: READ
  • Summary: List file comments
  • Parameters:
    • file_id in path required
    • fields in query
    • limit in query
    • offset in query

get_files_id_tasks

  • Operation ID: get_files_id_tasks
  • Route: GET /files/{file_id}/tasks
  • Mode: READ
  • Summary: List tasks on file
  • Parameters:
    • file_id in path required

get_files_id_trash

  • Operation ID: get_files_id_trash
  • Route: GET /files/{file_id}/trash
  • Mode: READ
  • Summary: Get trashed file
  • Parameters:
    • file_id in path required
    • fields in query

delete_files_id_trash

  • Operation ID: delete_files_id_trash
  • Route: DELETE /files/{file_id}/trash
  • Mode: WRITE
  • Summary: Permanently remove file
  • Parameters:
    • file_id in path required

get_files_id_versions

  • Operation ID: get_files_id_versions
  • Route: GET /files/{file_id}/versions
  • Mode: READ
  • Summary: List all file versions
  • Parameters:
    • file_id in path required
    • fields in query
    • limit in query
    • offset in query

get_files_id_versions_id

  • Operation ID: get_files_id_versions_id
  • Route: GET /files/{file_id}/versions/{file_version_id}
  • Mode: READ
  • Summary: Get file version
  • Parameters:
    • file_id in path required
    • fields in query
    • file_version_id in path required

delete_files_id_versions_id

  • Operation ID: delete_files_id_versions_id
  • Route: DELETE /files/{file_id}/versions/{file_version_id}
  • Mode: WRITE
  • Summary: Remove file version
  • Parameters:
    • file_id in path required
    • file_version_id in path required
    • if-match in header

put_files_id_versions_id

  • Operation ID: put_files_id_versions_id
  • Route: PUT /files/{file_id}/versions/{file_version_id}
  • Mode: WRITE
  • Summary: Restore file version
  • Parameters:
    • file_id in path required
    • file_version_id in path required
  • Body: JSON request body accepted.

post_files_id_versions_current

  • Operation ID: post_files_id_versions_current
  • Route: POST /files/{file_id}/versions/current
  • Mode: WRITE
  • Summary: Promote file version
  • Parameters:
    • file_id in path required
    • fields in query
  • Body: JSON request body accepted.

get_files_id_metadata

  • Operation ID: get_files_id_metadata
  • Route: GET /files/{file_id}/metadata
  • Mode: READ
  • Summary: List metadata instances on file
  • Parameters:
    • file_id in path required
    • view in query

get_files_id_metadata_enterprise_security_classification_6_vm_vochw_u_wo

  • Operation ID: get_files_id_metadata_enterprise_security_classification_6_vm_vochw_u_wo
  • Route: GET /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo
  • Mode: READ
  • Summary: Get classification on file
  • Parameters:
    • file_id in path required

post_files_id_metadata_enterprise_security_classification_6_vm_vochw_u_wo

  • Operation ID: post_files_id_metadata_enterprise_security_classification_6_vm_vochw_u_wo
  • Route: POST /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo
  • Mode: WRITE
  • Summary: Add classification to file
  • Parameters:
    • file_id in path required
  • Body: JSON request body accepted.

put_files_id_metadata_enterprise_security_classification_6_vm_vochw_u_wo

  • Operation ID: put_files_id_metadata_enterprise_security_classification_6_vm_vochw_u_wo
  • Route: PUT /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo
  • Mode: WRITE
  • Summary: Update classification on file
  • Parameters:
    • file_id in path required
  • Body: JSON request body accepted.

delete_files_id_metadata_enterprise_security_classification_6_vm_vochw_u_wo

  • Operation ID: delete_files_id_metadata_enterprise_security_classification_6_vm_vochw_u_wo
  • Route: DELETE /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo
  • Mode: WRITE
  • Summary: Remove classification from file
  • Parameters:
    • file_id in path required

get_files_id_metadata_id_id

  • Operation ID: get_files_id_metadata_id_id
  • Route: GET /files/{file_id}/metadata/{scope}/{template_key}
  • Mode: READ
  • Summary: Get metadata instance on file
  • Parameters:
    • file_id in path required
    • scope in path required
    • template_key in path required
    • view in query

post_files_id_metadata_id_id

  • Operation ID: post_files_id_metadata_id_id
  • Route: POST /files/{file_id}/metadata/{scope}/{template_key}
  • Mode: WRITE
  • Summary: Create metadata instance on file
  • Parameters:
    • file_id in path required
    • scope in path required
    • template_key in path required
  • Body: JSON request body accepted.

put_files_id_metadata_id_id

  • Operation ID: put_files_id_metadata_id_id
  • Route: PUT /files/{file_id}/metadata/{scope}/{template_key}
  • Mode: WRITE
  • Summary: Update metadata instance on file
  • Parameters:
    • file_id in path required
    • scope in path required
    • template_key in path required
  • Body: JSON request body accepted.

delete_files_id_metadata_id_id

  • Operation ID: delete_files_id_metadata_id_id
  • Route: DELETE /files/{file_id}/metadata/{scope}/{template_key}
  • Mode: WRITE
  • Summary: Remove metadata instance from file
  • Parameters:
    • file_id in path required
    • scope in path required
    • template_key in path required

get_files_id_metadata_global_box_skills_cards

  • Operation ID: get_files_id_metadata_global_box_skills_cards
  • Route: GET /files/{file_id}/metadata/global/boxSkillsCards
  • Mode: READ
  • Summary: List Box Skill cards on file
  • Parameters:
    • file_id in path required

post_files_id_metadata_global_box_skills_cards

  • Operation ID: post_files_id_metadata_global_box_skills_cards
  • Route: POST /files/{file_id}/metadata/global/boxSkillsCards
  • Mode: WRITE
  • Summary: Create Box Skill cards on file
  • Parameters:
    • file_id in path required
  • Body: JSON request body accepted.

put_files_id_metadata_global_box_skills_cards

  • Operation ID: put_files_id_metadata_global_box_skills_cards
  • Route: PUT /files/{file_id}/metadata/global/boxSkillsCards
  • Mode: WRITE
  • Summary: Update Box Skill cards on file
  • Parameters:
    • file_id in path required
  • Body: JSON request body accepted.

delete_files_id_metadata_global_box_skills_cards

  • Operation ID: delete_files_id_metadata_global_box_skills_cards
  • Route: DELETE /files/{file_id}/metadata/global/boxSkillsCards
  • Mode: WRITE
  • Summary: Remove Box Skill cards from file
  • Parameters:
    • file_id in path required

get_files_id_watermark

  • Operation ID: get_files_id_watermark
  • Route: GET /files/{file_id}/watermark
  • Mode: READ
  • Summary: Get watermark on file
  • Parameters:
    • file_id in path required

put_files_id_watermark

  • Operation ID: put_files_id_watermark
  • Route: PUT /files/{file_id}/watermark
  • Mode: WRITE
  • Summary: Apply watermark to file
  • Parameters:
    • file_id in path required
  • Body: JSON request body accepted.

delete_files_id_watermark

  • Operation ID: delete_files_id_watermark
  • Route: DELETE /files/{file_id}/watermark
  • Mode: WRITE
  • Summary: Remove watermark from file
  • Parameters:
    • file_id in path required
  • Operation ID: get_files_id_get_shared_link
  • Route: GET /files/{file_id}#get_shared_link
  • Mode: READ
  • Summary: Get shared link for file
  • Parameters:
    • file_id in path required
    • fields in query required
  • Operation ID: put_files_id_add_shared_link
  • Route: PUT /files/{file_id}#add_shared_link
  • Mode: WRITE
  • Summary: Add shared link to file
  • Parameters:
    • file_id in path required
    • fields in query required
  • Body: JSON request body accepted.
  • Operation ID: put_files_id_update_shared_link
  • Route: PUT /files/{file_id}#update_shared_link
  • Mode: WRITE
  • Summary: Update shared link on file
  • Parameters:
    • file_id in path required
    • fields in query required
  • Body: JSON request body accepted.
  • Operation ID: put_files_id_remove_shared_link
  • Route: PUT /files/{file_id}#remove_shared_link
  • Mode: WRITE
  • Summary: Remove shared link from file
  • Parameters:
    • file_id in path required
    • fields in query required
  • Body: JSON request body accepted.