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

# Convoflo API

Jentic publishes the only available OpenAPI specification for Convoflo API, keeping it validated and agent-ready. Convoflo is a client messaging and secure file-sharing platform built around an email-like interface, primarily used by professional services firms exchanging documents with clients. The 109 endpoints cover file requests, secure space folders, document and version management, file request templates, account profile, and organisation-level operations. Authentication is HTTP bearer.

## For AI agents

Create file requests, manage secure document folders, track file versions, and approve client document submissions on Convoflo. Agents authenticate with a bearer token.

## Scope

Does not provide e-signature, document OCR, or generic cloud storage - use for client-facing file requests, secure document spaces, and document workflows only.

## Capabilities

- Create and manage file requests with POST `/api/1/folders/{userFolder}/file-requests` and the `/api/1/file-requests` endpoints
- Approve or reject individual request items via `/file-requests/{fileRequestId}/items/{fileRequestItem}/approve` or /reject
- Maintain reusable file request templates under `/api/1/file-request-templates`
- Manage documents - favourite, follow, update metadata, list versions, and delete - via `/api/1/documents/{userFile}`
- Inspect document activity via GET `/api/1/documents/{userFile}/timeline`
- Pull and update user account and profile information via `/api/1/account`
- List file requests at the organisation level for cross-team reporting

## Use cases

### Client Document Request Workflow

Send templated requests for documents (KYC packs, tax returns, signed agreements) and track submissions through to approval. Create a request via POST `/api/1/folders/{userFolder}/file-requests`, attach items, and use the approve and reject endpoints as the client uploads files. Suited to legal, accounting, and financial services firms onboarding clients with predictable document checklists.

Example prompt: Create a file request in folder 42 with three required items (ID, proof of address, signed engagement) and email the client the link

### Document Lifecycle and Audit Trail

Track every interaction with a sensitive document - opens, downloads, version uploads, favourites - using `/api/1/documents/{userFile}/timeline` plus the version listing endpoint. The audit trail is essential for regulated industries that must prove who accessed which document and when. Useful for compliance and ops teams reviewing access logs as part of audits.

Example prompt: Pull the timeline for the document attached to engagement 9876 and produce a CSV of all access events in the last 30 days

### Reusable File Request Templates

Codify recurring document checklists (annual review, new hire onboarding, loan application) as Convoflo file request templates so reps can launch a new client request in seconds. Templates are managed under `/api/1/file-request-templates` and instantiated against any secure space folder. Reduces handover errors and keeps document collection consistent across the firm.

Example prompt: Create a file request template named 'Annual Tax Pack' with required items for prior year return, W-2s, and 1099s

### Agent-Driven Client Document Collection via Jentic

An AI agent runs the full client document loop through Jentic - instantiate a template, send the request, monitor submissions, and approve or reject items. Through Jentic the bearer token sits in the vault so the agent can run document collection automations at scale without holding the secret. The agent searches for the file-request intent, loads the schema, and chains the calls.

Example prompt: Search Jentic for 'create a Convoflo file request', load the schema, instantiate the 'Annual Tax Pack' template for client folder 42, and notify Slack when all items are approved

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/1/folders/{userFolder}/file-requests` | Create a file request in a secure space |
| GET | `/api/1/file-requests` | List the user's file requests |
| POST | `/api/1/file-requests/{fileRequestId}/items/{fileRequestItem}/approve` | Approve a submitted file request item |
| POST | `/api/1/file-requests/{fileRequestId}/items/{fileRequestItem}/reject` | Reject a submitted file request item |
| GET | `/api/1/documents/{userFile}/timeline` | List activity events for a document |
| POST | `/api/1/file-request-templates` | Create a reusable file request template |

## Key resources

- **FileRequests** — Create, fulfil, approve, and reject client file requests
- **FileRequestTemplates** — Manage reusable templates for recurring document checklists
- **Documents** — Inspect, version, follow, favourite, and delete uploaded documents
- **Folders** — Secure space folders that scope file requests to a client
- **Account** — Read and update the authenticated user's account and profile

## Why Jentic

- **Setup:** Wiring Convoflo by hand means holding its bearer token and coding the file-request lifecycle yourself, from creating a request to approving or rejecting each submitted item. Through Jentic you install once, import the Convoflo API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Convoflo puts the folder and file-request ids in the URL path (`/api/1/folders/{userFolder}/file-requests`, `/api/1/file-requests/{fileRequestId}/items/{fileRequestItem}/approve`), so a rule can pin your agent to one folder or file request: it can act on that and nothing else. You choose the operations it may call, so item rejection is not included unless you add it.
- **Credential handling:** Your Convoflo token is stored once, encrypted, by your own Jentic One instance and injected into the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a Convoflo file request' or 'approve a submitted document', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Box API** — Enterprise content management with file collaboration, broader scope than Convoflo's client-portal model.
- **Dropbox API** — Cloud file storage and sharing with team folders, similar storage scope but no client-portal abstraction.
- **Dropbox Sign API** — E-signature platform that pairs with Convoflo when collected documents need countersignatures.

## FAQ

### Why is there no official OpenAPI spec for Convoflo API?

Convoflo does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Convoflo API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Convoflo API use?

The API uses HTTP bearer authentication. Send the token in the Authorization: Bearer header on every call to `/api/1`/* endpoints. Through Jentic the token is stored encrypted in the vault and injected at execution time so it never appears in the agent's prompt context.

### How do I create a file request from a client with the Convoflo API?

POST `/api/1/folders/{userFolder}/file-requests` creates the request inside a secure space, then POST `/api/1/file-requests/{fileRequestId}/items` attaches the items the client must supply. POST `/api/1/file-requests/{fileRequestId}` finalises the request once all items are configured.

### Can I approve or reject specific items on a file request?

Yes. POST `/api/1/file-requests/{fileRequestId}/items/{fileRequestItem}/approve` marks an individual item as accepted, while .../reject marks it rejected and prompts the client to resubmit. Use this to enforce per-item gating during document review.

### How do I see who has accessed a Convoflo document?

GET `/api/1/documents/{userFile}/timeline` returns the activity timeline including views, downloads, comments, and version updates for a specific document. Pair with the file versions endpoint for a complete audit trail.

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

Rate limits are not declared in the OpenAPI spec. Treat the file request and document endpoints as soft-limited per bearer token and back off on HTTP 429 responses. Contact Convoflo support for documented limits applicable to your plan.

### How do I create a Convoflo file request through Jentic?

Run jentic search for 'create a Convoflo file request', load the POST `/api/1/folders/{userFolder}/file-requests` operation, and execute it with the secure space folder ID and the items to collect. Jentic injects the bearer token from the vault and returns the new request ID as a structured response.

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

Yes. Because you run Jentic One yourself, your own rules decide which Convoflo operations and credentials the agent may use. Since Convoflo puts folder and file-request IDs in the URL path, such as `/api/1/folders/{userFolder}/file-requests` and `/api/1/file-requests/{fileRequestId}/items/{fileRequestItem}/approve`, you can pin the agent to a single folder or file request so it acts on that and nothing else. You also choose the exact operations it may call, so an action like item rejection is available only if you add it.