# Pibox public API

## API Docs
- v1 > Teams [Invite Member](https://doc.pibox.com/invite-member-36551471e0.md): Invite a new user to a team with an explicit role. Targets `team_id` must belong to the caller's organization. Honors the team's `disable_invite_for_members` setting (admins/owners always pass). Universal handler — works for existing users (added immediately), new users (pending invite via email), and optionally adds to a project via `chat_id`.
- v1 > Teams [Get File Statuses](https://doc.pibox.com/get-file-statuses-36551472e0.md): Return the ordered list of file statuses configured for a team. Useful for decoding `old_status` / `new_status` ids in webhook payloads or building UI dropdowns.
- v1 > Teams [Get Teams](https://doc.pibox.com/get-teams-28353811e0.md): Getting a list of all your teams
- v1 > Groups [Get Groups](https://doc.pibox.com/get-groups-28353812e0.md): 
- v1 > Groups [Get Group Info](https://doc.pibox.com/get-group-info-30860884e0.md): 
- v1 > Groups [Create Group](https://doc.pibox.com/create-group-40164589e0.md): Creates a group inside a team.
- v1 > Projects [Get Project Info](https://doc.pibox.com/get-project-info-30862581e0.md): 
- v1 > Projects [Create Project](https://doc.pibox.com/create-project-28353813e0.md): 
- v1 > Projects [Get Projects by Group](https://doc.pibox.com/get-projects-by-group-28353814e0.md): 
- v1 > Projects [Get Non Group Projects](https://doc.pibox.com/get-non-group-projects-28353815e0.md): 
- v1 > Projects [Get Chat History](https://doc.pibox.com/get-chat-history-28353816e0.md): 
- v1 > Projects [Chat Message](https://doc.pibox.com/chat-message-28353817e0.md): 
- v1 > Account [Get Account Info](https://doc.pibox.com/get-account-info-30865649e0.md): 
- v1 > Files [Find Files](https://doc.pibox.com/find-files-30877577e0.md): Returns a list of files based on the specified filters. Returns only files, not folders
- v1 > Files [Get File Info](https://doc.pibox.com/get-file-info-28353824e0.md): 
- v1 > Files [Create Folder](https://doc.pibox.com/create-folder-28353818e0.md): 
- v1 > Files [Get Files by Folder](https://doc.pibox.com/get-files-by-folder-28353819e0.md): 
- v1 > Files [Get Folder URL](https://doc.pibox.com/get-folder-url-28353820e0.md): 
- v1 > Files [Update Folder Properties](https://doc.pibox.com/update-folder-properties-28353821e0.md): 
- v1 > Files [Delete File](https://doc.pibox.com/delete-file-28353822e0.md): 
- v1 > Files [Upload from External Source](https://doc.pibox.com/upload-from-external-source-28353823e0.md): 
- v1 > Files [Generate Track Tags](https://doc.pibox.com/generate-track-tags-28353825e0.md): Sending files to receive AI tags. Only audio files up to 100 MB in size are supported
- v1 > Files [File Upload](https://doc.pibox.com/file-upload-28353826e0.md): File size limit: 2Gb
- v1 > Tasks [Get Task Template](https://doc.pibox.com/get-task-template-28353827e0.md): 
- v1 > Tasks [Load Tasks from Template](https://doc.pibox.com/load-tasks-from-template-28353828e0.md): 
- v1 > Tasks [Get Tasks by Folder](https://doc.pibox.com/get-tasks-by-folder-28353829e0.md): 
- v1 > Tasks [Create Tasks](https://doc.pibox.com/create-tasks-40164590e0.md): Creates one or more tasks on a folder.
- v1 > Webhooks [Create Webhook Endpoint](https://doc.pibox.com/create-webhook-endpoint-28353830e0.md): 
- v1 > Webhooks [Get Webhook Endpoints](https://doc.pibox.com/get-webhook-endpoints-28353831e0.md): 
- v1 > Webhooks [Delete Webhook Endpoint](https://doc.pibox.com/delete-webhook-endpoint-28353832e0.md): 
- Webhooks [file.uploaded](https://doc.pibox.com/file-uploaded-36552124e0.md): Fired when a file is uploaded (including ingest from external sources like Box, Dropbox, or direct upload). Status may be `ok` (file ready) or `error` (ingest failed). When status is `ok`, the `file` object contains full metadata including a download URL.
- Webhooks [file.renamed](https://doc.pibox.com/file-renamed-36552125e0.md): Fired when a file is renamed. The `data` is the full file object after the rename — use `data.name` for the new name. (Old name is not preserved in the payload; if you need it, store the previous webhook delivery.)
- Webhooks [file.status_changed](https://doc.pibox.com/file-status-changed-36551470e0.md): Fired when a file's status changes (e.g. from "Waiting review" to "Approved"). Delivered to every `webhook_endpoint` subscribed to the `file.status_changed` event type in the same organization as the file. Use `new_status.id` / `new_status.title` to decide whether to act (e.g. trigger final delivery when title == "Approved").
- Webhooks [task.closed](https://doc.pibox.com/task-closed-36552182e0.md): Fired when a task is marked as closed. Use `data.id` to look up the task or `data.file_id` (parent directory containing the task list) for context.
- Webhooks [List webhook endpoints](https://doc.pibox.com/list-webhook-endpoints-40165651e0.md): 
- Webhooks [Create a webhook endpoint](https://doc.pibox.com/create-a-webhook-endpoint-40165652e0.md): 
- Webhooks [Delete a webhook endpoint](https://doc.pibox.com/delete-a-webhook-endpoint-40165653e0.md): 
- v2 (BETA) > AI agent [List the caller's active event subscriptions (newest first)](https://doc.pibox.com/list-the-callers-active-event-subscriptions-newest-first-40165760e0.md): 
- v2 (BETA) > AI agent [Subscribe to a user event (agent reminds the caller when it fires)](https://doc.pibox.com/subscribe-to-a-user-event-agent-reminds-the-caller-when-it-fires-40165761e0.md): Currently supported `event_type`: `deadline_approaching` (a task the caller can access is approaching or past its due date). The reminder is delivered as a proactive agent message in the caller's AI chat.
- v2 (BETA) > AI agent [Cancel an event subscription](https://doc.pibox.com/cancel-an-event-subscription-40165762e0.md): 
- v2 (BETA) > AI agent [List the caller's scheduled agent tasks (soonest first)](https://doc.pibox.com/list-the-callers-scheduled-agent-tasks-soonest-first-40165763e0.md): 
- v2 (BETA) > AI agent [Schedule the agent to run a task later (once / daily / weekly)](https://doc.pibox.com/schedule-the-agent-to-run-a-task-later-once-daily-weekly-40165764e0.md): At the scheduled moment the agent runs the prompt (read-only) and posts the result as a message in the caller's AI chat. Times are resolved in the caller's timezone unless `timezone` is given.
- v2 (BETA) > AI agent [Cancel a scheduled agent task](https://doc.pibox.com/cancel-a-scheduled-agent-task-40165765e0.md): 
- v2 (BETA) > Playlists [List the playlists in a team](https://doc.pibox.com/list-the-playlists-in-a-team-40165753e0.md): 
- v2 (BETA) > Playlists [Create a playlist in a team](https://doc.pibox.com/create-a-playlist-in-a-team-40165754e0.md): 
- v2 (BETA) > Playlists [Get a playlist, including its files](https://doc.pibox.com/get-a-playlist-including-its-files-40165755e0.md): 
- v2 (BETA) > Playlists [Rename a playlist](https://doc.pibox.com/rename-a-playlist-40165756e0.md): 
- v2 (BETA) > Playlists [Delete a playlist](https://doc.pibox.com/delete-a-playlist-40165757e0.md): 
- v2 (BETA) > Playlists [Add a file to a playlist](https://doc.pibox.com/add-a-file-to-a-playlist-40165758e0.md): 
- v2 (BETA) > Playlists [Remove a file from a playlist](https://doc.pibox.com/remove-a-file-from-a-playlist-40165759e0.md): 
- v2 (BETA) > Favorites & Recents [List the caller's favorites (pinned projects, groups and files)](https://doc.pibox.com/list-the-callers-favorites-pinned-projects-groups-and-files-40165749e0.md): 
- v2 (BETA) > Favorites & Recents [Add a project, group or file to favorites](https://doc.pibox.com/add-a-project-group-or-file-to-favorites-40165750e0.md): 
- v2 (BETA) > Favorites & Recents [Remove a project, group or file from favorites](https://doc.pibox.com/remove-a-project-group-or-file-from-favorites-40165751e0.md): The entity to unfavorite is passed in the JSON request body.
- v2 (BETA) > Favorites & Recents [List items (files/projects) the caller recently accessed](https://doc.pibox.com/list-items-filesprojects-the-caller-recently-accessed-40165752e0.md): 
- v2 (BETA) > Notifications [List the caller's notifications (newest first)](https://doc.pibox.com/list-the-callers-notifications-newest-first-40165745e0.md): 
- v2 (BETA) > Notifications [Get the caller's unread-notification counter](https://doc.pibox.com/get-the-callers-unread-notification-counter-40165746e0.md): 
- v2 (BETA) > Notifications [Mark all of the caller's notifications as read](https://doc.pibox.com/mark-all-of-the-callers-notifications-as-read-40165747e0.md): 
- v2 (BETA) > Notifications [Mark a single notification as read](https://doc.pibox.com/mark-a-single-notification-as-read-40165748e0.md): 
- v2 (BETA) > File comments [List a file's comments](https://doc.pibox.com/list-a-files-comments-40165736e0.md): 
- v2 (BETA) > File comments [Leave a comment](https://doc.pibox.com/leave-a-comment-40165737e0.md): 
- v2 (BETA) > File comments [Mark a file's comments as read](https://doc.pibox.com/mark-a-files-comments-as-read-40165738e0.md): 
- v2 (BETA) > File comments [Export a file's comments](https://doc.pibox.com/export-a-files-comments-40165739e0.md): 
- v2 (BETA) > File comments [Edit a comment](https://doc.pibox.com/edit-a-comment-40165740e0.md): 
- v2 (BETA) > File comments [Delete a comment](https://doc.pibox.com/delete-a-comment-40165741e0.md): 
- v2 (BETA) > File comments [Reply to a comment](https://doc.pibox.com/reply-to-a-comment-40165742e0.md): 
- v2 (BETA) > File comments [Toggle like on a comment](https://doc.pibox.com/toggle-like-on-a-comment-40165743e0.md): 
- v2 (BETA) > File comments [Resolve a comment (or reopen it with resolved=false)](https://doc.pibox.com/resolve-a-comment-or-reopen-it-with-resolvedfalse-40165744e0.md): 
- v2 (BETA) > Knowledge base [Search the Pibox Help Center](https://doc.pibox.com/search-the-pibox-help-center-40165733e0.md): 
- v2 (BETA) > Knowledge base [Get a Help Center article by id](https://doc.pibox.com/get-a-help-center-article-by-id-40165734e0.md): 
- v2 (BETA) > Knowledge base [Search the Pro Tools / audio-production knowledge base](https://doc.pibox.com/search-the-pro-tools-audio-production-knowledge-base-40165735e0.md): 
- v2 (BETA) > Search [Global search](https://doc.pibox.com/global-search-40165732e0.md): 
- v2 (BETA) > Accounts [Get an account profile (same organization)](https://doc.pibox.com/get-an-account-profile-same-organization-40165731e0.md): 
- v2 (BETA) > Messages [Project chat history](https://doc.pibox.com/project-chat-history-40165725e0.md): 
- v2 (BETA) > Messages [Send a message (reply via parent_message_id)](https://doc.pibox.com/send-a-message-reply-via-parent-message-id-40165726e0.md): 
- v2 (BETA) > Messages [Forward a message into this project](https://doc.pibox.com/forward-a-message-into-this-project-40165727e0.md): 
- v2 (BETA) > Messages [Mark all messages in the project chat as read](https://doc.pibox.com/mark-all-messages-in-the-project-chat-as-read-40165728e0.md): 
- v2 (BETA) > Messages [Edit a message](https://doc.pibox.com/edit-a-message-40165729e0.md): 
- v2 (BETA) > Messages [Delete a message](https://doc.pibox.com/delete-a-message-40165730e0.md): 
- v2 (BETA) > Metadata [Get a team's metadata template](https://doc.pibox.com/get-a-teams-metadata-template-40165719e0.md): 
- v2 (BETA) > Metadata [Get a file's metadata](https://doc.pibox.com/get-a-files-metadata-40165720e0.md): 
- v2 (BETA) > Metadata [Get a file's custom metadata field values](https://doc.pibox.com/get-a-files-custom-metadata-field-values-40165721e0.md): 
- v2 (BETA) > Metadata [Set the value of a custom metadata field on a file](https://doc.pibox.com/set-the-value-of-a-custom-metadata-field-on-a-file-40165722e0.md): Discover field (item) ids via the team metadata template or the file's metadata-fields.
- v2 (BETA) > Metadata [Export a file's metadata (xlsx)](https://doc.pibox.com/export-a-files-metadata-xlsx-40165723e0.md): 
- v2 (BETA) > Metadata [Export metadata for multiple files](https://doc.pibox.com/export-metadata-for-multiple-files-40165724e0.md): 
- v2 (BETA) > Tasks [List task-list templates of a team](https://doc.pibox.com/list-task-list-templates-of-a-team-40165711e0.md): 
- v2 (BETA) > Tasks [List tasks in a folder](https://doc.pibox.com/list-tasks-in-a-folder-40165712e0.md): 
- v2 (BETA) > Tasks [Create tasks (inline list) or load from a template](https://doc.pibox.com/create-tasks-inline-list-or-load-from-a-template-40165713e0.md): 
- v2 (BETA) > Tasks [Get a task](https://doc.pibox.com/get-a-task-40165714e0.md): 
- v2 (BETA) > Tasks [Update a task](https://doc.pibox.com/update-a-task-40165715e0.md): 
- v2 (BETA) > Tasks [Delete a task](https://doc.pibox.com/delete-a-task-40165716e0.md): 
- v2 (BETA) > Tasks [Add items to a task](https://doc.pibox.com/add-items-to-a-task-40165717e0.md): 
- v2 (BETA) > Tasks [Delete a task item](https://doc.pibox.com/delete-a-task-item-40165718e0.md): 
- v2 (BETA) > Files [Find files in a team (optionally scoped to a group/project)](https://doc.pibox.com/find-files-in-a-team-optionally-scoped-to-a-groupproject-40165692e0.md): 
- v2 (BETA) > Files [List a team's file-status options](https://doc.pibox.com/list-a-teams-file-status-options-40165693e0.md): 
- v2 (BETA) > Files [List folder contents](https://doc.pibox.com/list-folder-contents-40165694e0.md): 
- v2 (BETA) > Files [Create a folder (mkdir) or import a file from a URL](https://doc.pibox.com/create-a-folder-mkdir-or-import-a-file-from-a-url-40165695e0.md): Send `{name, type:"folder", ...}` to create a folder, or `{source_url, name}` to import a file (returns 202 Accepted).
- v2 (BETA) > Files [Upload a file (streamed binary body)](https://doc.pibox.com/upload-a-file-streamed-binary-body-40165696e0.md): 
- v2 (BETA) > Files [Generate AI track tags for files](https://doc.pibox.com/generate-ai-track-tags-for-files-40165697e0.md): 
- v2 (BETA) > Files [Filter-search files across the caller's projects (name fuzzy match + audio-metadata filters)](https://doc.pibox.com/filter-search-files-across-the-callers-projects-name-fuzzy-match-audio-metadata-filters-40165698e0.md): 
- v2 (BETA) > Files [Batch get file info (incl. media metadata + AI tags)](https://doc.pibox.com/batch-get-file-info-incl-media-metadata-ai-tags-40165699e0.md): 
- v2 (BETA) > Files [Generate an XLSX report from structured sheets; returns a download URL](https://doc.pibox.com/generate-an-xlsx-report-from-structured-sheets-returns-a-download-url-40165700e0.md): 
- v2 (BETA) > Files [Get file info (incl. media metadata + AI tags)](https://doc.pibox.com/get-file-info-incl-media-metadata-ai-tags-40165701e0.md): 
- v2 (BETA) > Files [Update file properties](https://doc.pibox.com/update-file-properties-40165702e0.md): 
- v2 (BETA) > Files [Delete a file](https://doc.pibox.com/delete-a-file-40165703e0.md): 
- v2 (BETA) > Files [Deep-link URL to a folder in the app](https://doc.pibox.com/deep-link-url-to-a-folder-in-the-app-40165704e0.md): 
- v2 (BETA) > Files [Resolve a file's download URL](https://doc.pibox.com/resolve-a-files-download-url-40165705e0.md): 
- v2 (BETA) > Files [List a file's versions](https://doc.pibox.com/list-a-files-versions-40165706e0.md): 
- v2 (BETA) > Files [Copy a file into another folder](https://doc.pibox.com/copy-a-file-into-another-folder-40165707e0.md): 
- v2 (BETA) > Files [Move (or rename) a file](https://doc.pibox.com/move-or-rename-a-file-40165708e0.md): 
- v2 (BETA) > Files [Set (or clear) a file's review status](https://doc.pibox.com/set-or-clear-a-files-review-status-40165709e0.md): Discover the team's status ids/labels via `/api/v2/teams/{teamId}/file-statuses`; send `status_id: null` to clear.
- v2 (BETA) > Files [Set a free-form label on a file version](https://doc.pibox.com/set-a-free-form-label-on-a-file-version-40165710e0.md): Replaces the computed `vN` label; an empty string clears it. `fileId` is the id of the version to label.
- v2 (BETA) > Projects [List team projects (non-grouped)](https://doc.pibox.com/list-team-projects-non-grouped-40165677e0.md): 
- v2 (BETA) > Projects [Create a project under a team](https://doc.pibox.com/create-a-project-under-a-team-40165678e0.md): 
- v2 (BETA) > Projects [Members across the team's projects](https://doc.pibox.com/members-across-the-teams-projects-40165679e0.md): 
- v2 (BETA) > Projects [List projects of a group](https://doc.pibox.com/list-projects-of-a-group-40165680e0.md): 
- v2 (BETA) > Projects [Create a project in a group](https://doc.pibox.com/create-a-project-in-a-group-40165681e0.md): 
- v2 (BETA) > Projects [Get a project](https://doc.pibox.com/get-a-project-40165682e0.md): 
- v2 (BETA) > Projects [Update a project (rename / privacy / avatar)](https://doc.pibox.com/update-a-project-rename-privacy-avatar-40165683e0.md): 
- v2 (BETA) > Projects [Delete a project](https://doc.pibox.com/delete-a-project-40165684e0.md): 
- v2 (BETA) > Projects [Add a member (by account_id) or invite one (by email)](https://doc.pibox.com/add-a-member-by-account-id-or-invite-one-by-email-40165685e0.md): Send `{account_id}` to add an existing account, or `{email, role?}` to invite.
- v2 (BETA) > Projects [Remove a member from the project](https://doc.pibox.com/remove-a-member-from-the-project-40165686e0.md): 
- v2 (BETA) > Projects [Cancel a pending project invitation (by email)](https://doc.pibox.com/cancel-a-pending-project-invitation-by-email-40165687e0.md): 
- v2 (BETA) > Projects [Batch get project info](https://doc.pibox.com/batch-get-project-info-40165688e0.md): 
- v2 (BETA) > Projects [List ungrouped projects for one or more teams](https://doc.pibox.com/list-ungrouped-projects-for-one-or-more-teams-40165689e0.md): 
- v2 (BETA) > Projects [List projects for one or more groups](https://doc.pibox.com/list-projects-for-one-or-more-groups-40165690e0.md): 
- v2 (BETA) > Projects [Search projects by name (fuzzy), optionally scoped to a team/group](https://doc.pibox.com/search-projects-by-name-fuzzy-optionally-scoped-to-a-teamgroup-40165691e0.md): 
- v2 (BETA) > Groups [List groups of a team](https://doc.pibox.com/list-groups-of-a-team-40165668e0.md): 
- v2 (BETA) > Groups [Create a group in a team](https://doc.pibox.com/create-a-group-in-a-team-40165669e0.md): 
- v2 (BETA) > Groups [Get a group](https://doc.pibox.com/get-a-group-40165670e0.md): 
- v2 (BETA) > Groups [Update a group](https://doc.pibox.com/update-a-group-40165671e0.md): 
- v2 (BETA) > Groups [Delete a group](https://doc.pibox.com/delete-a-group-40165672e0.md): 
- v2 (BETA) > Groups [Move an existing project into the group](https://doc.pibox.com/move-an-existing-project-into-the-group-40165673e0.md): 
- v2 (BETA) > Groups [Batch get group info](https://doc.pibox.com/batch-get-group-info-40165674e0.md): 
- v2 (BETA) > Groups [List groups for one or more teams](https://doc.pibox.com/list-groups-for-one-or-more-teams-40165675e0.md): 
- v2 (BETA) > Groups [Search groups by name (fuzzy), optionally scoped to a team](https://doc.pibox.com/search-groups-by-name-fuzzy-optionally-scoped-to-a-team-40165676e0.md): 
- v2 (BETA) > Teams [List the caller's teams](https://doc.pibox.com/list-the-callers-teams-40165660e0.md): 
- v2 (BETA) > Teams [Get a team (incl. members and pending members)](https://doc.pibox.com/get-a-team-incl-members-and-pending-members-40165661e0.md): 
- v2 (BETA) > Teams [Add an existing account to the team](https://doc.pibox.com/add-an-existing-account-to-the-team-40165662e0.md): 
- v2 (BETA) > Teams [Change a member's role](https://doc.pibox.com/change-a-members-role-40165663e0.md): 
- v2 (BETA) > Teams [Remove a member from the team](https://doc.pibox.com/remove-a-member-from-the-team-40165664e0.md): 
- v2 (BETA) > Teams [Cancel a pending invitation (by email)](https://doc.pibox.com/cancel-a-pending-invitation-by-email-40165665e0.md): 
- v2 (BETA) > Teams [Invite a member to a team](https://doc.pibox.com/invite-a-member-to-a-team-40165666e0.md): 
- v2 (BETA) > Teams [Caller's role capabilities and plan limits in a team (incl. remaining AI credits)](https://doc.pibox.com/callers-role-capabilities-and-plan-limits-in-a-team-incl-remaining-ai-credits-40165667e0.md): 
- v2 (BETA) > OAuth [Authorization-server metadata (RFC 8414)](https://doc.pibox.com/authorization-server-metadata-rfc-8414-40165654e0.md): 
- v2 (BETA) > OAuth [Consent page (issues an authorization code)](https://doc.pibox.com/consent-page-issues-an-authorization-code-40165655e0.md): 
- v2 (BETA) > OAuth [Confirm consent (api_token bridge) → 302 with code](https://doc.pibox.com/confirm-consent-api-token-bridge-302-with-code-40165656e0.md): 
- v2 (BETA) > OAuth [Exchange code (PKCE) or refresh_token for tokens](https://doc.pibox.com/exchange-code-pkce-or-refresh-token-for-tokens-40165657e0.md): 
- v2 (BETA) > OAuth [Revoke an access or refresh token (RFC 7009)](https://doc.pibox.com/revoke-an-access-or-refresh-token-rfc-7009-40165658e0.md): 
- v2 (BETA) > OAuth [Dynamic client registration (RFC 7591)](https://doc.pibox.com/dynamic-client-registration-rfc-7591-40165659e0.md): 
- v2 (BETA) > team [Get Teams (GET)](https://doc.pibox.com/get-teams-get-40164591e0.md): Getting a list of all your teams.

## Schemas
- v1 [Team](https://doc.pibox.com/team-12840136d0.md): 
- v1 [Track Info](https://doc.pibox.com/track-info-13006320d0.md): 
- v1 [Video Info](https://doc.pibox.com/video-info-13006321d0.md): 
- v1 [Image Info](https://doc.pibox.com/image-info-13006322d0.md): 
- v1 [AI Tags](https://doc.pibox.com/ai-tags-13006323d0.md): 
- v1 [Empty Schema](https://doc.pibox.com/empty-schema-13006324d0.md): 
- [FileStatus](https://doc.pibox.com/filestatus-15234728d0.md): 
- [Error](https://doc.pibox.com/error-16486815d0.md): 
- [ListEnvelope](https://doc.pibox.com/listenvelope-16486816d0.md): 
- [ObjectEnvelope](https://doc.pibox.com/objectenvelope-16486817d0.md): 
- [TokenResponse](https://doc.pibox.com/tokenresponse-16486818d0.md): 
- [ClientRegistration](https://doc.pibox.com/clientregistration-16486819d0.md): 
- [AuthServerMetadata](https://doc.pibox.com/authservermetadata-16486820d0.md):