# Wordsmith API

- [Wordsmith API](https://wordsmithai.mintlify.app/index.md): Welcome to the Wordsmith API documentation. Integrate legal AI capabilities into your applications.
- [Introduction](https://wordsmithai.mintlify.app/introduction.md): Learn about Wordsmith's legal AI capabilities and how the Public API can integrate with your applications.
- [Authentication](https://wordsmithai.mintlify.app/authentication.md): Authenticate Wordsmith API requests with an API key or an OAuth access token.
- [Quickstart](https://wordsmithai.mintlify.app/quickstart.md): Get up and running with the Wordsmith API in just a few minutes with this step-by-step guide.
- [Webhooks](https://wordsmithai.mintlify.app/webhooks.md): Learn how to receive real-time notifications from Wordsmith using webhooks with signature verification for security.
- [Rate Limits](https://wordsmithai.mintlify.app/rate-limits.md): The limits that apply to your API usage, and how to handle them
- [Errors](https://wordsmithai.mintlify.app/errors.md): Understanding error responses from the Wordsmith API
- [Connect an AI app](https://wordsmithai.mintlify.app/connect-ai-apps.md): Use Wordsmith from ChatGPT, Claude, Cursor and other AI apps that support MCP.
- [MCP server](https://wordsmithai.mintlify.app/mcp-server.md): The tools Wordsmith's MCP server gives ChatGPT, Claude, Cursor and other MCP apps.
- [OAuth](https://wordsmithai.mintlify.app/oauth.md): Let users connect an approved app to Wordsmith with OAuth 2.1, instead of sharing an API key.
- [Get User Information](https://wordsmithai.mintlify.app/api-reference/user/get-me.md): Retrieve information about the authenticated user and their organization
- [List Agents](https://wordsmithai.mintlify.app/api-reference/agents/list-agents.md): Get all agents (legal AI specialists) that you have read access to
- [Get Agent](https://wordsmithai.mintlify.app/api-reference/agents/get-agent.md): Read one agent's name, description, creator, owners and link.
- [Create Agent Question](https://wordsmithai.mintlify.app/api-reference/agents/create-question.md): Ask a question to the Wordsmith AI agent with optional file attachments
- [Get Question Status](https://wordsmithai.mintlify.app/api-reference/agents/get-question-status.md): Retrieve the status and results of a previously submitted question
- [List Operations](https://wordsmithai.mintlify.app/api-reference/operations/list-operations.md): List the operations you started, newest first.
- [Get Operation](https://wordsmithai.mintlify.app/api-reference/operations/get-operation.md): Read an operation's status and result. Optionally wait for it to finish.
- [Cancel Operation](https://wordsmithai.mintlify.app/api-reference/operations/cancel-operation.md): Ask a queued or running operation to stop.
- [Generate File Upload URL](https://wordsmithai.mintlify.app/api-reference/files/upload-url.md): Generate a presigned URL for uploading files to use with an agent or a task
- [Complete Upload](https://wordsmithai.mintlify.app/api-reference/files/complete-upload.md): Turn an uploaded file into a Wordsmith file with a file_id.
- [Import File](https://wordsmithai.mintlify.app/api-reference/files/import-file.md): Add a file to Wordsmith from a public URL.
- [Create File](https://wordsmithai.mintlify.app/api-reference/files/create-file.md): Save text as a plain text, Markdown or Word file.
- [Get File](https://wordsmithai.mintlify.app/api-reference/files/get-file.md): Read a file's name, type, size and creation time.
- [Get File Text](https://wordsmithai.mintlify.app/api-reference/files/get-file-text.md): Read a file's extracted plain text, one page at a time.
- [Get File Download](https://wordsmithai.mintlify.app/api-reference/files/get-file-download.md): Get a short-lived link that downloads a file's original bytes.
- [Compare Files](https://wordsmithai.mintlify.app/api-reference/documents/compare.md): Compare two versions of a document and get a redline of the differences.
- [Merge Files](https://wordsmithai.mintlify.app/api-reference/documents/merge.md): Join several documents into one PDF, in the order given.
- [Redline File](https://wordsmithai.mintlify.app/api-reference/documents/redline.md): Edit a document from plain-language instructions, as tracked changes.
- [Translate File](https://wordsmithai.mintlify.app/api-reference/documents/translate.md): Translate a document into another language and keep its layout.
- [Redact File](https://wordsmithai.mintlify.app/api-reference/documents/redact.md): Black out personal and sensitive information in a document and get a PDF back.
- [Convert File](https://wordsmithai.mintlify.app/api-reference/documents/convert.md): Convert a document between DOCX and PDF.
- [Accept Changes](https://wordsmithai.mintlify.app/api-reference/documents/accept-changes.md): Accept every tracked change in a DOCX and get a clean copy.
- [Create Draft](https://wordsmithai.mintlify.app/api-reference/drafts/create-draft.md): Draft a document from instructions and context, optionally starting from a blueprint.
- [Create Review](https://wordsmithai.mintlify.app/api-reference/reviews/create-review.md): Start a playbook, instructions or Redline Review of one or more files.
- [List Reviews](https://wordsmithai.mintlify.app/api-reference/reviews/list-reviews.md): List the reviews the caller can read, newest first.
- [Get Review](https://wordsmithai.mintlify.app/api-reference/reviews/get-review.md): Read a review's status, finding counts and redline file.
- [List Findings](https://wordsmithai.mintlify.app/api-reference/reviews/list-findings.md): Page through a review's findings, filtered by status, severity and recommendation.
- [Generate Redline](https://wordsmithai.mintlify.app/api-reference/reviews/generate-redline.md): Turn some of a review's proposed amendments into tracked changes, or apply decisions to a Redline Review.
- [List Playbooks](https://wordsmithai.mintlify.app/api-reference/playbooks/list-playbooks.md): Get all playbooks (document review workflows) that you have read access to
- [Get Playbook](https://wordsmithai.mintlify.app/api-reference/playbooks/get-playbook.md): Read a playbook and the checks a review runs against a document.
- [Create Playbook](https://wordsmithai.mintlify.app/api-reference/playbooks/create-playbook.md): Create a playbook with a name, a description and a list of checks.
- [Update Playbook](https://wordsmithai.mintlify.app/api-reference/playbooks/update-playbook.md): Rename a playbook or change its description.
- [Delete Playbook](https://wordsmithai.mintlify.app/api-reference/playbooks/delete-playbook.md): Delete a playbook so no new review can run it.
- [Add Check](https://wordsmithai.mintlify.app/api-reference/playbooks/add-check.md): Add a check to the end of a playbook.
- [Update Check](https://wordsmithai.mintlify.app/api-reference/playbooks/update-check.md): Change a check's name, instructions, severity or standard position.
- [Delete Check](https://wordsmithai.mintlify.app/api-reference/playbooks/delete-check.md): Remove a check from a playbook.
- [Generate Playbook](https://wordsmithai.mintlify.app/api-reference/playbooks/generate-playbook.md): Build a playbook from precedent contracts.
- [List Blueprints](https://wordsmithai.mintlify.app/api-reference/blueprints/list-blueprints.md): List the blueprints the caller can draft from.
- [Get Blueprint](https://wordsmithai.mintlify.app/api-reference/blueprints/get-blueprint.md): Read a blueprint and the placeholders you fill to draft a document from it.
- [List Templates](https://wordsmithai.mintlify.app/api-reference/templates/list-templates.md): Get all document templates that you have read access to
- [List Skills](https://wordsmithai.mintlify.app/api-reference/skills/list-skills.md): List the skills the caller can see.
- [Get Skill](https://wordsmithai.mintlify.app/api-reference/skills/get-skill.md): Read a skill's instructions, files and references.
- [Create Skill](https://wordsmithai.mintlify.app/api-reference/skills/create-skill.md): Create a skill, or import a SKILL.md folder.
- [Update Skill](https://wordsmithai.mintlify.app/api-reference/skills/update-skill.md): Change a skill's name, description, instructions or files.
- [Delete Skill](https://wordsmithai.mintlify.app/api-reference/skills/delete-skill.md): Delete a skill so the Wordsmith agent no longer uses it.
- [List Sessions](https://wordsmithai.mintlify.app/api-reference/sessions/list-sessions.md): List your conversations with agents, most recent activity first.
- [Get Session](https://wordsmithai.mintlify.app/api-reference/sessions/get-session.md): Read one conversation's title, agent and message count.
- [List Messages](https://wordsmithai.mintlify.app/api-reference/sessions/list-messages.md): Page through a conversation's messages, oldest first.
- [Search Research Sources](https://wordsmithai.mintlify.app/api-reference/research/search.md): Search case law and legislation across several public sources in one call.
- [Get Research Document](https://wordsmithai.mintlify.app/api-reference/research/get-document.md): Read the full text of a judgment or piece of legislation, one page of text at a time.
- [List Reports](https://wordsmithai.mintlify.app/api-reference/reports/list-reports.md): List the reports you can read, most recently updated first.
- [Create Report](https://wordsmithai.mintlify.app/api-reference/reports/create-report.md): Create a report over a repository or a set of files, optionally with columns, and optionally start it.
- [Get Report](https://wordsmithai.mintlify.app/api-reference/reports/get-report.md): Read a report and its columns.
- [Update Report](https://wordsmithai.mintlify.app/api-reference/reports/update-report.md): Rename a report or change its description.
- [Delete Report](https://wordsmithai.mintlify.app/api-reference/reports/delete-report.md): Delete a report with its columns, rows and cells.
- [Add Columns](https://wordsmithai.mintlify.app/api-reference/reports/add-columns.md): Add up to 20 extraction columns to a report.
- [Update Column](https://wordsmithai.mintlify.app/api-reference/reports/update-column.md): Change a column's name, question, answer type or options.
- [Delete Column](https://wordsmithai.mintlify.app/api-reference/reports/delete-column.md): Delete a column and its cells from a report.
- [List Rows](https://wordsmithai.mintlify.app/api-reference/reports/list-rows.md): Page through a report's rows and the document behind each one.
- [Add Rows](https://wordsmithai.mintlify.app/api-reference/reports/add-rows.md): Add up to 10 files to a report, one row per file.
- [Delete Row](https://wordsmithai.mintlify.app/api-reference/reports/delete-row.md): Delete a row and its cells from a report. The file stays.
- [Run Report](https://wordsmithai.mintlify.app/api-reference/reports/run-report.md): Compute the cells of a report, all of them or a chosen set of rows and columns.
- [List Cells](https://wordsmithai.mintlify.app/api-reference/reports/list-cells.md): Page through the cells of a report, filtered by row, column or status.
- [Export Report](https://wordsmithai.mintlify.app/api-reference/reports/export-report.md): Export a report to an Excel, CSV or JSON file.
- [List Repositories](https://wordsmithai.mintlify.app/api-reference/repositories/list-repositories.md): List the repositories you can read, sorted by name.
- [Create Repository](https://wordsmithai.mintlify.app/api-reference/repositories/create-repository.md): Create an empty repository to hold and search documents.
- [Get Repository](https://wordsmithai.mintlify.app/api-reference/repositories/get-repository.md): Read a repository, including its document count and indexing state.
- [Update Repository](https://wordsmithai.mintlify.app/api-reference/repositories/update-repository.md): Rename a repository or change its description.
- [Delete Repository](https://wordsmithai.mintlify.app/api-reference/repositories/delete-repository.md): Delete a repository, its documents and their files.
- [List Documents](https://wordsmithai.mintlify.app/api-reference/repositories/list-documents.md): List the documents in a repository, or in one folder of it.
- [Add Documents](https://wordsmithai.mintlify.app/api-reference/repositories/add-documents.md): Add uploaded files to a repository and start indexing them.
- [Get Document](https://wordsmithai.mintlify.app/api-reference/repositories/get-document.md): Read one document in a repository, including its indexing status.
- [Remove Document](https://wordsmithai.mintlify.app/api-reference/repositories/remove-document.md): Remove a document from a repository. Its file is deleted with it.
- [List Folders](https://wordsmithai.mintlify.app/api-reference/repositories/list-folders.md): List the folders in a repository, so you can find a folder_id to file or search documents by.
- [Create Folder](https://wordsmithai.mintlify.app/api-reference/repositories/create-folder.md): Create a folder in a repository, at the top level or inside another folder.
- [Search Repository](https://wordsmithai.mintlify.app/api-reference/repositories/search-repository.md): Search the indexed documents in one repository and get ranked passages back.
- [Search Knowledge](https://wordsmithai.mintlify.app/api-reference/search/search-knowledge.md): Search many repositories you can read in one call and get ranked passages back.
- [Get Sharing](https://wordsmithai.mintlify.app/api-reference/sharing/get-sharing.md): Read who a repository, report, playbook, blueprint or session is shared with.
- [Update Sharing](https://wordsmithai.mintlify.app/api-reference/sharing/update-sharing.md): Replace the visibility and the shared people and teams of a repository, report, playbook, blueprint or session.
- [List Tasks](https://wordsmithai.mintlify.app/api-reference/tasks/list-tasks.md): List and filter tasks you have access to.
- [Create Task](https://wordsmithai.mintlify.app/api-reference/tasks/create-task.md): Create a task, optionally assigned to a person, an agent or a team.
- [Get Task](https://wordsmithai.mintlify.app/api-reference/tasks/get-task.md): Fetch a single task by id.
- [Update Task](https://wordsmithai.mintlify.app/api-reference/tasks/update-task.md): Update any task field, including archiving and accepting drafts.
- [Delete Task](https://wordsmithai.mintlify.app/api-reference/tasks/delete-task.md): Delete a task, or reject a draft.
- [List Subtasks](https://wordsmithai.mintlify.app/api-reference/tasks/list-subtasks.md): List the subtasks of a task.
- [List Comments](https://wordsmithai.mintlify.app/api-reference/tasks/list-comments.md): List the internal comments on a task.
- [Add Comment](https://wordsmithai.mintlify.app/api-reference/tasks/add-comment.md): Add an internal comment to a task.
- [Reply to Comment](https://wordsmithai.mintlify.app/api-reference/tasks/reply-comment.md): Reply to a comment, creating a threaded discussion.
- [Update Comment](https://wordsmithai.mintlify.app/api-reference/tasks/update-comment.md): Edit the content of a comment you authored.
- [Delete Comment](https://wordsmithai.mintlify.app/api-reference/tasks/delete-comment.md): Delete a comment.
- [List Thread Messages](https://wordsmithai.mintlify.app/api-reference/tasks/list-thread.md): Read the conversation with whoever requested the task.
- [Reply to Requester](https://wordsmithai.mintlify.app/api-reference/tasks/add-thread-reply.md): Send a reply back to whoever requested the task.
- [Get Task Sharing](https://wordsmithai.mintlify.app/api-reference/tasks/get-sharing.md): Read who a task is shared with.
- [Update Task Sharing](https://wordsmithai.mintlify.app/api-reference/tasks/update-sharing.md): Replace a task's visibility and its shared people and teams.
- [Attach Files](https://wordsmithai.mintlify.app/api-reference/tasks/attach-files.md): Attach uploaded files to a task.
- [Remove File](https://wordsmithai.mintlify.app/api-reference/tasks/remove-file.md): Detach one file from a task.
- [Link Items](https://wordsmithai.mintlify.app/api-reference/tasks/add-links.md): Link chats, reviews, reports or other tasks to a task.
- [Update Link](https://wordsmithai.mintlify.app/api-reference/tasks/update-link.md): Change the role or context of one link on a task.
- [Unlink Item](https://wordsmithai.mintlify.app/api-reference/tasks/remove-link.md): Remove one link from a task.
- [Get Follow Status](https://wordsmithai.mintlify.app/api-reference/tasks/get-follow.md): Check whether you are following a task.
- [Follow Task](https://wordsmithai.mintlify.app/api-reference/tasks/follow-task.md): Follow a task to receive its notifications.
- [Unfollow Task](https://wordsmithai.mintlify.app/api-reference/tasks/unfollow-task.md): Stop following a task.
- [List Users](https://wordsmithai.mintlify.app/api-reference/directory/list-users.md): List the people and agents in your organization.
- [List Teams](https://wordsmithai.mintlify.app/api-reference/directory/list-teams.md): List the teams in your organization.
- [List Company Profiles](https://wordsmithai.mintlify.app/api-reference/organisation/list-company-profiles.md): List the company profiles agents use as context about your organisation.
- [Get Company Profile](https://wordsmithai.mintlify.app/api-reference/organisation/get-company-profile.md): Read one company profile: jurisdictions, industry, regulation and signatories.
- [Update Company Profile](https://wordsmithai.mintlify.app/api-reference/organisation/update-company-profile.md): Change fields on your organisation's company profile.
- [Get Member](https://wordsmithai.mintlify.app/api-reference/organisation/get-member.md): Get one person or agent in your organisation, with their roles and teams.
- [Update Member](https://wordsmithai.mintlify.app/api-reference/organisation/update-member.md): Change a member's roles, or suspend and reactivate them.
- [List Invites](https://wordsmithai.mintlify.app/api-reference/organisation/list-invites.md): List the invites sent to join your organisation.
- [Create Invite](https://wordsmithai.mintlify.app/api-reference/organisation/create-invite.md): Invite someone to join your organisation by email, with the roles they get on joining.
- [Resend Invite](https://wordsmithai.mintlify.app/api-reference/organisation/resend-invite.md): Email a pending invite again and extend how long it stays valid.
- [Revoke Invite](https://wordsmithai.mintlify.app/api-reference/organisation/revoke-invite.md): Cancel a pending invite so its join link stops working.
- [Get Team](https://wordsmithai.mintlify.app/api-reference/organisation/get-team.md): Get one team with its members and their team roles.
- [Create Team](https://wordsmithai.mintlify.app/api-reference/organisation/create-team.md): Create a team, at the top level or nested under another team.
- [Update Team](https://wordsmithai.mintlify.app/api-reference/organisation/update-team.md): Rename a team, move it in the team tree, or hide it.
- [Delete Team](https://wordsmithai.mintlify.app/api-reference/organisation/delete-team.md): Delete a team and withdraw the access it granted.
- [Add Team Member](https://wordsmithai.mintlify.app/api-reference/organisation/add-team-member.md): Add a member to a team as a team admin or member.
- [Update Team Member](https://wordsmithai.mintlify.app/api-reference/organisation/update-team-member.md): Change a team member's role in the team.
- [Remove Team Member](https://wordsmithai.mintlify.app/api-reference/organisation/remove-team-member.md): Take a member off a team and withdraw the access the team gave them.
- [List Roles](https://wordsmithai.mintlify.app/api-reference/organisation/list-roles.md): List the built-in and custom roles you can assign to members.
- [Get Usage Summary](https://wordsmithai.mintlify.app/api-reference/usage/get-usage-summary.md): Headline usage and value for the caller, or for their whole organisation: sessions, active users, hours saved and cost saved.
- [Get Usage Breakdown](https://wordsmithai.mintlify.app/api-reference/usage/get-usage-breakdown.md): Break your organisation's usage and value down by agent, skill, surface, kind of work, team, seniority, role, region or person.
- [Get Usage Over Time](https://wordsmithai.mintlify.app/api-reference/usage/get-usage-timeseries.md): One usage or value metric over time, for the caller or the organisation.
- [List Assistants](https://wordsmithai.mintlify.app/api-reference/assistants/list-assistants.md): Get all assistants (legal AI specialists) that you have read access to
- [Create Assistant Question](https://wordsmithai.mintlify.app/api-reference/assistants/create-question.md): Ask a question to the Wordsmith AI assistant with optional file attachments
- [Get Question Status](https://wordsmithai.mintlify.app/api-reference/assistants/get-question-status.md): Retrieve the status and results of a previously submitted question


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