# Side Space

> Side Space is a shared drive for media teams. Every save is a version; every version can carry
> JSON sidecars (the AI prompt that made it, transcripts, tags, media facts, your own data).
> Programs and AI agents use the same HTTP API as the apps, plus MCP, webhooks, plugins and an
> S3-compatible gateway.

These are the developer guides as Markdown. Each Side Space server also serves its own API
description at /v1/openapi.yaml and a short guide for agents at /llms.txt.

## Guides

- [Build on Side Space](https://side.cliptap.ai/docs/index.md): A shared drive your AI agents and pipelines can work in, next to your team. One API behind the Mac app, the web app, the CLI, MCP, the Linux mount and the SDKs.
- [Quickstart](https://side.cliptap.ai/docs/quickstart.md): Try Side Space in one container with sample clips, or make a token on your server, then search, upload a file and attach metadata to it from the shell, TypeScript or Python.
- [Authentication](https://side.cliptap.ai/docs/authentication.md): Personal access tokens with scopes, AI agents as members of their own, and OAuth for apps that act for people.
- [Performance](https://side.cliptap.ai/docs/performance.md): What Side Space feels like, measured, including what it does badly. Every number here, how it was measured and on what machine.
- [Files and versions](https://side.cliptap.ai/docs/files.md): Spaces, paths and nodes; uploading and downloading through the block gateway; version history, names and comparisons.
- [History and rewind](https://side.cliptap.ai/docs/history.md): Read any folder or file as it was at a moment, even after a rename or delete, and put a whole folder back with one call that can itself be undone.
- [Sidecars](https://side.cliptap.ai/docs/sidecars.md): JSON metadata on every version, by namespace. The built-in schemas, writing your own, and keeping a namespace to one tool.
- [Search](https://side.cliptap.ai/docs/search.md): Find files by name, metadata, transcripts and review comments, or by describing what's in them. Results point at the moment in a video.
- [Changes and webhooks](https://side.cliptap.ai/docs/changes.md): Every space keeps an ordered journal of what changed. Read it, get a push signal over a WebSocket, or have it POSTed to your URL, signed and in order.
- [Review comments and share links](https://side.cliptap.ai/docs/comments.md): Notes pinned to a moment of a video or a region of a frame, replies and resolve, review links for people without an account, and how agents take part.
- [Forks](https://side.cliptap.ai/docs/forks.md): Copy a space, or one folder of it, into a sandbox in an instant, work there, see what changed, and apply what you keep.
- [Organizations, teams and folder access](https://side.cliptap.ai/docs/organizations.md): Put a studio's people, teams and spaces together, give teams roles in spaces, limit who may change a folder, sign in through your identity provider and export the audit trail.
- [Use it in Claude](https://side.cliptap.ai/docs/claude.md): Connect Side Space to Claude and ask in plain words: find a line in a video, see what changed since lunch, tidy a folder, send the client a link.
- [MCP for AI agents](https://side.cliptap.ai/docs/mcp.md): Connect Claude, Cursor or your own agent to Side Space over the Model Context Protocol. It signs in through the browser, and every tool respects the token's scopes and spaces.
- [AI actions and pipelines](https://side.cliptap.ai/docs/actions.md): Transcribe, tag or convert a file with one call, cached by content; or run actions on every file that lands in a folder, with conditions, chains and ready-made templates.
- [Plugins](https://side.cliptap.ai/docs/plugins.md): Add your own actions to a space: an HTTPS service in any language, or a command on your own machine through a runner. Signed jobs, ranged reads of the input, results as sidecars and files.
- [SDKs](https://side.cliptap.ai/docs/sdks.md): TypeScript, Python, Go and Rust clients that pass one shared test suite. Paths instead of ids, streaming uploads and ranged downloads, safe writes, edits, sidecars, search, changes, webhooks and actions.
- [Linux mount](https://side.cliptap.ai/docs/linux.md): Mount every space as an ordinary folder on a render node, server or CI machine with no desktop, through FUSE, with a token and a systemd service.
- [S3-compatible gateway](https://side.cliptap.ai/docs/s3.md): Use aws, rclone, Cyberduck, boto3 or any AWS SDK with Side Space. A space is a bucket, a path is a key, every put is a version, and S3 versioning shows the whole history.

## API reference

- [API reference](https://side.cliptap.ai/docs/api): every endpoint with parameters, bodies, responses and examples, generated from the OpenAPI file

## 中文

- [在 Side Space 上开发](https://side.cliptap.ai/zh-CN/docs/index.md): 一个能让 AI agent 和流水线跟团队一起干活的共享盘。Mac 应用、网页版、CLI、MCP、Linux 挂载和 SDK 背后是同一套 API。
- [快速上手](https://side.cliptap.ai/zh-CN/docs/quickstart.md): 用一个带示例视频的容器先试一试，或者在你的服务器上生成令牌，然后用命令行、TypeScript 或 Python 搜索、上传文件，并给它加上元数据。
- [认证](https://side.cliptap.ai/zh-CN/docs/authentication.md): 带权限范围的个人访问令牌、作为独立成员的 AI agent，以及代表用户操作的应用所用的 OAuth。
- [性能](https://side.cliptap.ai/zh-CN/docs/performance.md): 用起来的实际感受，实测数字，也包括做得不好的地方：每个数字是怎么测的、在什么机器上测的。
- [文件与版本](https://side.cliptap.ai/zh-CN/docs/files.md): 空间、路径和节点；通过块网关上传和下载；版本历史、版本命名和比较。
- [看过去和整体回滚](https://side.cliptap.ai/zh-CN/docs/history.md): 看任何文件夹、文件在某一刻的样子，改过名或删掉的也行；一次调用把整个文件夹退回去，这一步本身也能再撤回。
- [附加信息](https://side.cliptap.ai/zh-CN/docs/sidecars.md): 每个版本上按命名空间存放的 JSON 元数据。内置的结构、自定义命名空间，以及把一个命名空间交给一个工具独占。
- [搜索](https://side.cliptap.ai/zh-CN/docs/search.md): 按文件名、元数据、转写和审阅评论找文件，或者直接描述画面内容。结果能直接指到视频里的那一秒。
- [变更与 Webhook](https://side.cliptap.ai/zh-CN/docs/changes.md): 每个空间都有一份按顺序的变更日志。可以直接读，可以通过 WebSocket 收到推送信号，也可以让它按顺序、带签名地 POST 到你的地址。
- [审阅评论与分享链接](https://side.cliptap.ai/zh-CN/docs/comments.md): 钉在视频某个时间点或画面某个区域的意见、回复和解决；给没有账号的人用的审阅链接；以及 AI agent 怎么参与。
- [分支沙盒](https://side.cliptap.ai/zh-CN/docs/forks.md): 一瞬间把一个空间（或其中一个文件夹）复制成沙盒，在里面改，看改了什么，只合并想留下的部分。
- [组织、团队与文件夹权限](https://side.cliptap.ai/zh-CN/docs/organizations.md): 把一家工作室的人、团队和空间放在一起：按团队给空间授权，限制谁能改某个文件夹，用公司的身份提供方登录，导出审计记录。
- [在 Claude 里用](https://side.cliptap.ai/zh-CN/docs/claude.md): 把 Side Space 接到 Claude，用一句话找视频里的台词、看中午以后改了什么、整理文件夹、给客户发链接。
- [用 MCP 接入 AI agent](https://side.cliptap.ai/zh-CN/docs/mcp.md): 通过 Model Context Protocol 把 Claude、Cursor 或你自己的 agent 接到 Side Space。在浏览器里授权，每个工具都遵守令牌的权限和空间范围。
- [AI 处理与流水线](https://side.cliptap.ai/zh-CN/docs/actions.md): 一次调用就能转写、打标签或转格式，结果按内容缓存；也可以让落进某个文件夹的每个文件自动处理，支持条件、串联和现成模板。
- [插件](https://side.cliptap.ai/zh-CN/docs/plugins.md): 给空间加上你自己的动作：用任何语言写的 HTTPS 服务，或者通过 runner 在你自己机器上跑的命令。带签名的任务、按范围读取输入、结果写成附加信息和新文件。
- [SDK](https://side.cliptap.ai/zh-CN/docs/sdks.md): TypeScript、Python、Go 和 Rust 客户端，通过同一套测试。用路径代替 id，流式上传和按范围下载，安全写入、局部修改、附加信息、搜索、变更、Webhook 和动作。
- [在 Linux 上挂载](https://side.cliptap.ai/zh-CN/docs/linux.md): 在没有桌面的渲染节点、服务器、CI 机器上，通过 FUSE 把所有空间挂成一个普通文件夹，用令牌和 systemd 服务开机自动挂载。
- [S3 兼容接口](https://side.cliptap.ai/zh-CN/docs/s3.md): 用 aws、rclone、Cyberduck、boto3 或任何 AWS SDK 读写 Side Space。一个空间就是一个存储桶，路径就是对象键，每次写入都是一个版本。