canonical: https://jentic.com/apis/ziflow.com/ziflow # Ziflow API Welcome to the Ziflow API The Ziflow API is built to allow you to easily and quickly embed Ziflow’s proofing features in your own application or create an integration between Ziflow and any other application. This API is the same one we use to power Ziflow! The API is a RESTful interface, essentially providing programmatic access to the features and data in the system. If you’ve interacted with a . The API exposes 95 endpoints secured with apiKey, basic, bearer authentication. ## For AI agents Programmatically create new proof, get proofs. Covers 95 operations with apiKey, basic, bearer authentication. ## Scope Does not handle payments, communications, or crm - use for ai and machine learning only. ## Capabilities - Create New Proof - Get Proofs - Search Proofs - Update an Existing Proof - Delete Proof ## Use cases ### AI and Machine Learning Operations Use the Ziflow API to perform ai ml operations programmatically. The API provides 95 endpoints covering core functionality including create new proof, get proofs, search proofs. Example prompt: Call POST /proofs to create new proof ### Automated PROOFS Management Automate proofs operations by combining multiple Ziflow API endpoints. Agents can get proofs and then search proofs in a single workflow. Example prompt: Call GET /proofs to get proofs, then verify the result ### AI Agent Integration via Jentic AI agents discover and call Ziflow API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey, basic, bearer tokens manually. Example prompt: Search Jentic for 'create new proof', load the operation schema, and execute with Jentic-managed credentials ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/proofs` | Create New Proof | | GET | `/proofs` | Get Proofs | | POST | `/proofs/search` | Search Proofs | | POST | `/proofs/search/activity` | Search Proofs Activity | | GET | `/proofs/{id}` | Get Proof by ID | | PUT | `/proofs/{id}` | Update an Existing Proof | | DELETE | `/proofs/{id}` | Delete Proof | | POST | `/proofs/{id}/integration-properties` | Add Integration Properties | ## Key resources - **PROOFS** — Proofs are one of the fundamental building blocks of Ziflow. It is important to note the distincti - **STAGES** — Stages are a key component of the Ziflow proofing process. They define the sequence in which reviewe - **REVIEWERS** — Reviewers are users and/or non-users (guests) on a proof who review and approve assets. The metho - **COMMENTS** — Comments, replies and markups are made on proofs by reviewers to provide feedback on the content and - **COMMENT LABELS** — Labeling comments allow reviewers and proof managers to categorize and filter comments by type. ## Why Jentic - **Setup:** Wiring Ziflow by hand means picking one of its several auth styles, bearer, basic, or an apikey header or query parameter, and pointing requests at the api.ziflow.io host yourself. Through Jentic you install once, import Ziflow from the API Directory, store the credential once, and your agent calls it. - **Permission scoping:** Ziflow puts the proof id in the URL path (`/proofs/{id}`), so a rule can pin your agent to one proof: it can read and update that proof and nothing else. You choose the operations it may call, so destructive ones like proof deletion are not included unless you add them. - **Credential handling:** Your Ziflow credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'create a new proof' or 'search proof activity', and Jentic returns the matching Ziflow operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Openai** — Alternative ai ml API - **Anthropic** — Alternative ai ml API - **Cohere** — Complementary ai ml API - **Huggingface** — Complementary ai ml API ## FAQ ### What authentication does the Ziflow API use? The Ziflow API uses apiKey, basic, bearer authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context. ### Can I create new proof with the Ziflow API? Yes. Use the POST /proofs endpoint. The API returns structured JSON responses that agents can parse and act on directly. ### What are the rate limits for the Ziflow API? Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer. ### How do I create new proof through Jentic? Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create new proof'. Jentic returns the matching Ziflow API operation with its input schema. Load the schema and execute the call - credentials are injected automatically. ### How many endpoints does the Ziflow API have? The Ziflow API exposes 95 endpoints covering proofs, stages, reviewers operations. ### Can I limit what my agent is allowed to do with the Ziflow API? Yes. Because Jentic One is self-hosted, you set the rules, and Ziflow puts the proof id directly in the URL path (`/proofs/{id}`), so you can pin your agent to a single proof and let it read and update only that proof. You choose exactly which operations the agent may call, so destructive endpoints like DELETE `/proofs/{id}` stay off unless you explicitly add them. The stored credential is injected at execution time and never enters the agent's prompt or context, so the agent operates only within the operations you allow.