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

# Bitskout Zapier API

Jentic publishes the only available OpenAPI specification for Bitskout Zapier API, keeping it validated and agent-ready. The Bitskout Zapier API exposes Bitskout's AI-powered document processing workflows for automation platforms. It lets external tools verify a service token, enumerate the workflows configured in a Bitskout account, and trigger a workflow run on a supplied document or payload. The integration is intentionally narrow so Zapier-style automations and AI agents can list and execute Bitskout workflows without juggling the full Bitskout web UI.

## For AI agents

List configured Bitskout AI document workflows and trigger a run programmatically. Useful for agents that need to extract structured data from invoices, receipts, or forms via a pre-built Bitskout pipeline.

## Scope

Does not handle workflow creation, document storage, or AI model training - use for executing pre-configured Bitskout document workflows only.

## Capabilities

- Verify that a Bitskout service token is valid before running an automation
- Enumerate the AI document workflows configured under a Bitskout account
- Trigger an existing Bitskout workflow against a supplied document or payload
- Route document processing requests through a managed Bitskout AI pipeline
- Bridge Zapier-style triggers to Bitskout workflow execution from agent code

## Use cases

### Invoice Data Extraction Automation

Forward incoming supplier invoices to a Bitskout workflow that extracts header fields, line items, and totals using AI document parsing. The integration calls /run_workflow with the document payload and Bitskout returns the structured output once the pipeline completes. This avoids hand-rolling OCR and field mapping for finance and accounts payable automations.

Example prompt: Call POST /run_workflow with the workflow id for invoice extraction and the invoice document, then return the extracted vendor, total, and line items.

### Workflow Discovery Before Execution

Before automating a Bitskout pipeline, list the workflows available in the connected account so the integration picks the right one by name. The API exposes /workflows for enumeration, which agents call once at setup or whenever the workflow catalogue changes. This pattern keeps automations resilient when workflow ids rotate or new pipelines are added.

Example prompt: Call GET /workflows, filter the response for the workflow whose name matches 'Invoice Extraction', and store its id for subsequent run_workflow calls.

### Service Token Health Check

Run a lightweight token validation before kicking off long document processing jobs. The /ping endpoint confirms the supplied API key is accepted by Bitskout, which lets automations fail fast with a clear auth error instead of mid-pipeline. This is especially useful for scheduled jobs that may run hours after credentials were configured.

Example prompt: Call GET /ping with the configured Authorization header and abort the run if the response is not 200.

### Agent-Driven Document Workflow via Jentic

An AI agent processing inbound emails uses Jentic to find and call the Bitskout workflow that matches the document type. Jentic resolves the workflow execution operation from a natural language intent, supplies the schema for /run_workflow, and isolates the Bitskout API key so the agent never sees the raw secret. The result is a single-step path from 'extract this PDF' to a structured response.

Example prompt: Use Jentic search for 'run a Bitskout document workflow', load the schema, then execute /run_workflow with workflow_id and document fields supplied by the agent.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/ping` | Verify the service token is valid |
| GET | `/workflows` | List configured workflows |
| POST | `/run_workflow` | Run a workflow against a payload |

## Key resources

- **Workflows** — List the AI document workflows configured in the Bitskout account
- **Workflow Runs** — Trigger an existing workflow against a supplied document or payload
- **Service Token** — Validate that the Bitskout API key is accepted before running automations

## Why Jentic

- **Setup:** Wiring the Bitskout Zapier API by hand means setting the API key in the Authorization header, targeting the api.bitskout.com/zapier host, and handling workflow-run errors yourself. Through Jentic you install once, import Bitskout from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Bitskout carries the workflow selection in the request, not the URL path, and its key has no granular scopes, so limit the agent to the operations it needs, such as listing workflows with /workflows or running one with /run_workflow. You choose the operations it may call, so nothing beyond that set runs unless you add it.
- **Credential handling:** Your Bitskout API key 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 'run a Bitskout document workflow' or 'list Bitskout workflows', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Bland AI** — Bland handles AI voice automation while Bitskout handles AI document workflows.
- **BizToc** — BizToc supplies business news content that a Bitskout workflow could classify or summarise.
- **Blackfire.io** — Blackfire is a developer profiling API, not a competitor - listed for contrast where teams confuse 'workflow' tools.

## FAQ

### Why is there no official OpenAPI spec for Bitskout Zapier API?

Bitskout does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Bitskout Zapier 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 Bitskout Zapier API use?

The API uses an API key passed in the Authorization header (security scheme name ApiKeyAuth). Through Jentic the key is stored in the encrypted vault, and the agent receives a scoped token instead of the raw value, so the secret never enters the agent's prompt context.

### Can I trigger a Bitskout workflow with the Bitskout Zapier API?

Yes. Send a POST to /run_workflow with the workflow identifier and the payload to process. The endpoint is the entry point for executing any AI document workflow configured in your Bitskout account.

### How do I find the workflow id I need to call run_workflow?

Call GET /workflows once to enumerate the workflows configured in your account, then pick the id whose name matches the pipeline you want to execute. Cache the id and refresh the list when your workflow catalogue changes.

### What are the rate limits for the Bitskout Zapier API?

The OpenAPI spec does not declare explicit rate limits. In practice the endpoint is built for Zapier-style automations, so design retries and backoff around your Bitskout plan limits and watch for HTTP 429 responses.

### How do I run a Bitskout document workflow with this API through Jentic?

Install with pip install jentic, then use Jentic search with the query 'run a Bitskout document workflow'. Load the returned operation schema and execute with your workflow_id and document payload. Jentic resolves the call to POST /run_workflow without exposing your API key.

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

Yes. Because you run Jentic One yourself, your own rules decide which Bitskout operations the agent may call and which credentials it may use. Since Bitskout carries the workflow selection in the request body rather than in the URL and its key has no granular scopes, you scope access at the operation level: you might allow the agent only to list workflows with GET /workflows and run one with POST /run_workflow, or restrict it to verifying the token with GET /ping. Nothing beyond the operations you approve runs.