canonical: https://jentic.com/apis/airslate.io/airslate

# airSlate WorkFlow API

Jentic publishes the only available OpenAPI specification for airSlate WorkFlow API, keeping it validated and agent-ready. airSlate is a workflow automation platform that lets organisations build document-driven processes called Flows (or Slates), parametrise them with templates, attach documents, and assign users. The 15 endpoints cover OAuth 2.0 token issuance, organisation lookup, full CRUD on Flows, document attachment, template browsing, and user management. Best suited for HR, legal, finance, and procurement teams that need approvals and document workflows wired into other systems.

## For AI agents

Create and run airSlate Flows, attach documents, and manage organisation users from a single REST API.

## Scope

Does not handle accounting, project task tracking, or real-time chat - use for document-driven Flow creation, templates, and approvals only.

## Capabilities

- Issue an OAuth 2.0 access token via POST /oauth/token
- List and inspect organisations the authenticated client can access
- Create, update, and delete Flows scoped to an organisation
- Attach documents to a Flow and list all documents in a Flow
- Browse available templates that can seed new Flows
- Manage users assigned to an organisation

## Use cases

### Document Workflow Provisioning

Create a Flow inside an organisation, seed it from a template, and attach the documents that must be signed or filled. POST /organizations/{organization_id}/flows accepts a Flow definition and POST /organizations/{organization_id}/flows/{flow_id}/documents adds documents one by one. Suitable for HR onboarding, vendor contracts, and legal NDAs.

Example prompt: Create a Flow named 'New Hire Onboarding' under organization 'org-123' and attach the offer letter document

### Template-Based Flow Creation

Browse available templates and seed new Flows from them so workflow definitions stay consistent across departments. The Templates resource exposes the catalogue of reusable workflow blueprints; create a Flow with the template_id reference to bootstrap a Flow with predefined steps and document slots.

Example prompt: List templates available in the organisation and create a new Flow seeded from the chosen template

### Programmatic Organisation Audit

Inventory all Flows, documents, and users across an organisation by paging through the /organizations/{organization_id}/flows and users endpoints. Useful for compliance audits, monthly process reviews, and migration tooling that needs to enumerate active workflows before changes.

Example prompt: List all Flows under organization 'org-acme' and return a summary of count, names, and updated_at timestamps

### Agent Document Workflow via Jentic

An agent kicks off a document workflow by searching Jentic for the create-flow operation, loading the schema, and executing under an OAuth 2.0 bearer token managed by Jentic. The token-issuance step (POST /oauth/token) is also available through Jentic for refresh handling.

Example prompt: Search Jentic for 'create an airSlate flow', load the operation, and execute it under organization_id 'org-acme' with name 'Vendor NDA'

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /oauth/token | Issue an OAuth 2.0 access token |
| GET | /organizations | List organisations |
| GET | /organizations/{organization_id}/flows | List Flows in an organisation |
| POST | /organizations/{organization_id}/flows | Create a Flow |
| PATCH | /organizations/{organization_id}/flows/{flow_id} | Update a Flow |
| DELETE | /organizations/{organization_id}/flows/{flow_id} | Delete a Flow |
| POST | /organizations/{organization_id}/flows/{flow_id}/documents | Attach a document to a Flow |

## Key resources

- **Authentication** — OAuth 2.0 token issuance endpoint
- **Organizations** — Org-level lookup that scopes Flows, Templates, and Users
- **Flows** — Create, update, list, and delete document-driven workflows
- **Templates** — Reusable workflow blueprints to seed new Flows
- **Documents** — Documents attached to a Flow
- **Users** — Users assigned to an organisation

## Why Jentic

- **Setup:** Wiring airSlate by hand means exchanging OAuth client credentials at /oauth/token for a bearer, refreshing it on expiry, and threading organization and flow ids through nested paths. Through Jentic you install once, import airSlate from the API Directory, store the client credentials once, and your agent calls it while Jentic handles the token exchange.
- **Permission scoping:** airSlate puts the organization and flow ids in the URL path (/organizations/{organization_id}/flows/{flow_id}), so a rule can pin your agent to one organization or flow. You choose the operations it may call, so deleting a flow is only included if you add it.
- **Credential handling:** Your airSlate client credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a document workflow', and Jentic returns the matching airSlate operation with its organization_id, flow_id, and body schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **PandaDoc** — Document signing and proposal workflows with a richer template designer
- **Dropbox Sign** — Lightweight e-signature API without airSlate's broader workflow primitives
- **Smartsheet** — Sheet-based work management that complements airSlate document workflows

## FAQ

### Why is there no official OpenAPI spec for airSlate WorkFlow API?

airSlate does not publish a single canonical OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call airSlate WorkFlow 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 airSlate WorkFlow API use?

OAuth 2.0 bearer tokens. Issue a token via POST /oauth/token with client credentials, then pass it as Authorization: Bearer <token>. Through Jentic the client credentials are stored encrypted and tokens are refreshed automatically.

### Can I create a Flow from a template?

Yes. List templates via the Templates resource, then create a Flow under an organisation referencing the chosen template_id. The Flow is seeded with the template's predefined steps and document slots so subsequent attach-document calls fill the workflow.

### What are the rate limits for the airSlate WorkFlow API?

airSlate applies plan-based limits enforced via HTTP 429 responses. Documented thresholds vary by tier; the docs at docs.airslate.io are authoritative. Treat 429 as a backoff-and-retry signal.

### How do I create a Flow through Jentic?

Install with pip install jentic, search for 'create an airSlate flow', load the POST /organizations/{organization_id}/flows operation, and execute with organization_id and the Flow name. Jentic handles the bearer token at execution time.

### Can I attach a document to an existing Flow?

Yes. POST /organizations/{organization_id}/flows/{flow_id}/documents attaches a document to the named Flow. List the resulting documents with the matching GET endpoint.

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

Yes. Because you run Jentic One yourself, your own rules decide which airSlate operations your agent may call and which credentials it may use. Since airSlate carries the organization and flow ids in the URL path, such as /organizations/{organization_id}/flows/{flow_id}, a rule can pin your agent to a single organization or flow. You also choose the operations it can reach, so a destructive call like deleting a Flow is available only if you explicitly add it.