canonical: https://jentic.com/apis/filepass.com/filepass

# Filepass API

The Filepass API lets clients programmatically manage projects, clients, comments, file system objects, payments, and webhook hooks for users authenticated via OAuth 2.0 authorization code flow. It exposes ten endpoints for listing and creating projects under specific clients, retrieving comments attached to file system objects, and registering webhooks for change notifications. The API is designed for media production teams that need to integrate Filepass file collaboration into review, billing, and approval workflows.

## For AI agents

Manage Filepass projects, clients, comments, and webhooks via OAuth 2.0. Useful for agents automating media production review and approval flows.

## Scope

Does not handle raw file binary upload, image transformations, or CDN delivery - use for project, comment, and webhook orchestration on existing Filepass workspaces only.

## Capabilities

- List projects scoped to a specific client and create new projects under that client
- Retrieve threaded comments attached to any file system object for review summaries
- Register webhook hooks so an agent gets notified when projects or comments change
- Look up the authenticated user profile via the /me endpoint to confirm OAuth scope
- Surface client rosters so agents can match incoming files to the right account

## Use cases

### Automated Media Review Notifications

Production teams using Filepass can register webhooks against the /hooks endpoint so an agent is notified the moment a comment is added to a file system object. The agent can then summarise feedback and route it to the right reviewer. Setup takes one OAuth handshake and a single POST /hooks call.

Example prompt: Register a webhook on POST /hooks pointing at the agent endpoint, then on each event fetch GET `/file_system_objects/{id}/comments` and summarise.

### Client-Scoped Project Provisioning

Agencies that onboard new clients can have an agent call POST `/clients/{client_id}/projects` to spin up a templated project structure when a new deal closes in CRM. Filepass returns the project record so the agent can post the project URL back into the deal record.

Example prompt: Call POST `/clients/{client_id}/projects` with the templated project payload and return the project id to the originating CRM record.

### Cross-Project Comment Aggregation

Operations teams running weekly reviews can have an agent walk every project visible to the OAuth token, pull GET /comments, and produce a digest of unresolved feedback. This avoids manually opening each Filepass project and replaces a recurring 30 minute task with a sub-minute call.

Example prompt: Iterate GET /projects, then for each project call GET /comments and compose a digest of comments authored in the last 7 days.

### AI Agent Filepass Integration via Jentic

An agent connected to Jentic can search by intent (for example process media review feedback) and Jentic returns the matching Filepass operations along with their input schemas. The agent then executes the call without the OAuth token ever entering its context. End-to-end integration time drops from a multi-day OAuth implementation to under an hour.

Example prompt: Search Jentic for list filepass projects, load the operation schema, and execute it with the user's vaulted Filepass OAuth token.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/me` | Return the authenticated user profile |
| GET | `/clients` | List clients accessible to the current token |
| GET | `/clients/{client_id}/projects` | List projects under a specific client |
| POST | `/projects` | Create a new project |
| GET | `/comments` | List comments across the workspace |
| GET | `/file_system_objects/{file_system_object_id}/comments` | List comments on a specific file system object |
| POST | `/hooks` | Register a webhook to receive change notifications |

## Key resources

- **Projects** — Create and list projects, optionally scoped to a parent client
- **Clients** — Browse the clients owned by the authenticated user
- **Comments** — Read comments globally or attached to a specific file system object
- **Hooks** — Register webhooks to receive change notifications

## Why Jentic

- **Setup:** Wiring the Filepass API by hand means running its OAuth2 flow, refreshing bearer tokens, and threading client and file-system-object ids through the project, comment, and webhook routes yourself. Through Jentic you install once, import the Filepass API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Filepass puts the client id and file-system-object id in the URL path (`/clients/{client_id}/projects`, `/file_system_objects/{file_system_object_id}/comments`), so a rule can pin your agent to the clients you allow. You choose the operations it may call, so a write like creating a project or registering a webhook is not included unless you add it.
- **Credential handling:** Your Filepass OAuth client secret and refresh token are stored once, encrypted, by your own Jentic One instance and injected at execution time. The raw OAuth tokens never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list filepass projects' or 'read a file's comments', and Jentic returns the matching Filepass operation with its input schema, so the agent executes without browsing Swagger.

## Related APIs

- **Dropbox API** — General-purpose file storage and sharing API rather than media-review focused
- **Box API** — Enterprise file collaboration with metadata, comments, and tasks
- **Filestack API** — Pairs with Filepass for upload, transformation, and CDN delivery

## FAQ

### What authentication does the Filepass API use?

Filepass uses OAuth 2.0 authorization code flow with a single API scope, exchanging an authorization code at https://api.filepass.com/oauth/token for a bearer access token. Through Jentic, the OAuth tokens are stored in the encrypted vault and the agent only ever receives a scoped reference, never the raw secret.

### Can I list comments on a specific file with the Filepass API?

Yes. Call GET `/file_system_objects/{file_system_object_id}/comments` with the file system object id to retrieve every comment attached to that file. There is also a global GET /comments endpoint when you want comments across the workspace.

### What are the rate limits for the Filepass API?

The OpenAPI spec does not publish explicit per-minute rate limits. Filepass has historically applied per-token throttling, so agents should respect 429 responses with exponential backoff and refresh the OAuth token only when a 401 is returned.

### How do I register a webhook with Filepass through Jentic?

Search Jentic for register filepass webhook, load the POST /hooks operation, and execute it with your callback URL and event filter. Jentic injects the OAuth bearer token from the vault so the agent never handles the credential directly.

### Can I create a project under a specific client with the Filepass API?

Yes. Use POST /projects with the client id in the request body, or use the client-scoped GET `/clients/{client_id}/projects` collection to see existing projects for that client before creating a new one.

### Is the Filepass API free to use?

API access is included with a paid Filepass workspace and is gated by the same plan limits as the Filepass web app. There is no separate API-only tier published in the spec.

### Can I limit what my agent is allowed to do with the Filepass API?

Yes. Because you run Jentic One yourself, your own rules decide which Filepass operations and credentials the agent may use. Filepass puts the client id and file-system-object id in the URL path, so a rule can pin your agent to the clients you allow and to reads like GET `/clients/{client_id}/projects` or GET `/file_system_objects/{file_system_object_id}/comments.` Write operations such as POST /projects to create a project or POST /hooks to register a webhook are not included unless you add them.