> ## Documentation Index
> Fetch the complete documentation index at: https://wordsmithai.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Zapier

> Hand legal work to Wordsmith from a Zap, and start a Zap when Wordsmith work changes.

The Wordsmith app for Zapier connects Wordsmith to thousands of other apps. A Zap can ask an agent, review a contract against a playbook, draft from a blueprint, redline or translate a document, and create or update a task. It can also start when a task is created or completed, or when a review finishes.

## Connect

1. In Wordsmith, open **Settings → API keys** and create an API key for the user the Zaps should act as. The key acts with that user's access, so a Zap can do only what that user can do. Use a key with **Full access**, or one whose permissions cover what your Zaps do.
2. In Zapier, add a Wordsmith step. When asked for an account, paste the API key.
3. Choose your **Region**: Europe or United States. If you're not sure, ask your Wordsmith admin. Accounts connected before the Region field existed use Europe.

To have tasks start an agent, open each agent in Wordsmith and add **API** as an intake on its configuration page. The **Agent** list in **Create a Task** shows only agents with that intake.

## Actions

| Group | Actions |
| - | - |
| Agents | **Ask Wordsmith** asks an agent and waits for the answer. |
| Files | **Upload a File**, **Import a File From a Link**, **Create a Document From Text** |
| Documents | **Redline a Document**, **Compare Two Documents**, **Convert a Document**, **Translate a Document**, **Redact a Document**, **Accept All Tracked Changes**, **Merge Documents Into One PDF** |
| Reviews and drafts | **Review a Document**, **Create a Redline From a Review**, **Draft a Document** |
| Tasks | **Create a Task**, **Update a Task**, **Attach Files to a Task**, **Add a Comment to a Task**, **Reply to the Person Who Sent a Task** |
| Reports and repositories | **Create a Report**, **Add Documents to a Report**, **Run a Report**, **Export a Report**, **Add Documents to a Repository** |
| Search | **Search Your Documents**, **Search Legal Sources** |

Searches find a task, review, answer, file, agent, user, conversation, report, repository or job. **Find or Create a Task** creates the task when there is none.

**Draft a Document** shows one field per placeholder of the blueprint you choose. Fill the ones you know, and Wordsmith fills the rest. **Instructions**, **Context** and source files guide how Wordsmith fills the empty placeholders.

## Work that takes a while

Questions, reviews, drafts and document actions can take a few minutes. The step waits while Wordsmith works, and the Zap carries on when the work finishes. A step that fails in Wordsmith fails in Zapier too, with Wordsmith's reason, so you can handle it with Zapier's error paths.

When you test a step in the Zap editor, Wordsmith waits up to 20 seconds. If the work isn't finished by then, the test shows its status instead of the result. A live Zap always waits for the result.

> [!WARNING]
>
> If you replay a Zap run, or Zapier retries a step, the work starts again: a second review, draft or task. Check before replaying a run that already reached Wordsmith.

## Files

A file field takes a file from an earlier step, such as a Gmail attachment, up to 1 GB. Zapier copies it into your private Wordsmith space first. Fields named **Wordsmith file IDs** take files that are already in Wordsmith, such as the **File ID** from an earlier Wordsmith step.

Files that Wordsmith makes, such as a redline or a draft, come out as files later steps can attach to an email or save to a drive. Each one also has a **link** for people, which opens the file in Wordsmith after sign-in.

## Triggers

| Trigger | Starts when |
| - | - |
| **New Task** | A task you're involved in is created. |
| **Task Status Changed** | A task reaches the status you choose, such as Completed. Each task starts the Zap once per status, so a task completed a second time does not start it again. |
| **Review Completed** | A review finishes, wherever it was started: the web app, Word or the API. |

These triggers check Wordsmith every few minutes. Wordsmith lists tasks by priority, so **New Task** reads your 300 highest-priority tasks and can miss a new low-priority one when you have more.

## Example: review email attachments

1. **Gmail → New Attachment**, with a search for the contracts you receive.
2. **Wordsmith → Review a Document**: **Review type** *Against a playbook*, **Files** the attachment, and your **Playbook**.
3. **Slack → Send Channel Message**, with **Issues (text)** and **Review link**.

## Example: email the requester when a task is done

1. **Wordsmith → Task Status Changed**, with **Status** *Completed*.
2. **Wordsmith → Get a Task's Files**, with the trigger's **Task ID**.
3. **Gmail → Send Email**, to the task creator, attaching **Latest output file**.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.