JavaScript API

Create a new PlaidClient instance

Authenticate and return a new client instance with token. This is the

Enter strict mode for a specific document, requiring document version

Exit strict mode and stop tracking document versions for writes.

Begin a batch of operations. Subsequent API calls will be queued.

Submit all queued batch operations as a single batch request, executed

Abort the current batch without executing any operations.

Check if currently in batch mode.

List a user's named API tokens. Never includes the signed token

Fetch a single page of a user's named API tokens.

Async-iterate a user's named API tokens page by page; yields each

Mint a named API token for a user. The returned `token` is the signed

Revoke a named API token (soft-revoke; idempotent).

Execute multiple API operations atomically. If any operation fails, all

Check the lock status of a document.

Acquire or refresh a document lock

Release a document lock

Get media file for a document

Upload a media file for a document. Uses Apache Tika for content validation.

Delete media file for a document

Replace all metadata for a document.

Remove all metadata from a document.

Patch (shallow-merge) metadata for a document. Keys present in the body are set or overwritten; keys not present are left untouched; a key whose value is null is deleted. Merging is top-level only (nested objects are replaced wholesale, not deep-merged), so a literal null cannot be stored as a value. An empty body changes no metadata.

Get audit log for a document. Transparently follows pagination cursors

Get a document. Set `includeBody` to true to include all data.

Delete a document and all data contained.

Update a document's name.

Create a new document in a project.

Open a Server-Sent Events stream for a project.

Send a message to project listeners

Discover the services seen on a project (synchronous GET). Currently

Forget a previously-seen (offline) service. Maintainer-only; 409 if

Register as a service and handle incoming work requests.

Request a service to perform work and await its result.

Set a user's access level to read and write for this project.

Remove a user's writer privileges for this project.

Set a user's access level to read-only for this project.

Remove a user's reader privileges for this project.

Set a configuration value for a project in an editor namespace.

Remove a configuration value for a project.

Assign a user as a maintainer for this project.

Remove a user's maintainer privileges for this project.

Get audit log for a project. Transparently follows pagination cursors

Link a vocabulary to a project.

Unlink a vocabulary from a project.

Get a project by ID. To fetch the project's documents, use

List all documents in a project. Transparently follows pagination

Fetch a single page of a project's documents.

Async-iterate a project's documents page by page; yields each page's

Delete a project and everything in it. This is irrecoverable.

Update a project's name.

List all projects accessible to user. Transparently follows pagination

Fetch a single page of projects.

Async-iterate projects page by page; yields each page's entries array.

Create a new project. Note: this also registers the user as a maintainer.

Shift a relation layer's display order.

Create a new relation layer.

Set a configuration value for a layer in an editor namespace.

Remove a configuration value for a layer.

Get a relation layer by ID.

Delete a relation layer.

Update a relation layer's name.

Replace all metadata for a relation.

Remove all metadata from a relation.

Patch (shallow-merge) metadata for a relation. Keys present in the body are set or overwritten; keys not present are left untouched; a key whose value is null is deleted. Merging is top-level only (nested objects are replaced wholesale, not deep-merged), so a literal null cannot be stored as a value. An empty body changes no metadata.

Update the target span of a relation.

Get a relation by ID.

Delete a relation.

Update a relation's value.

Update the source span of a relation.

Create a new relation. A relation is a directed edge between two spans

Create multiple relations in a single operation.

Delete multiple relations in a single operation. Provide an array of IDs.

Set a configuration value for a layer in an editor namespace.

Remove a configuration value for a layer.

Get a span layer by ID.

Delete a span layer.

Update a span layer's name.

Create a new span layer.

Shift a span layer's display order.

Replace tokens for a span.

Create a new span. A span holds a primary atomic value and optional

Get a span by ID.

Delete a span.

Update a span's value.

Create multiple spans in a single operation.

Delete multiple spans in a single operation. Provide an array of IDs.

Replace all metadata for a span.

Remove all metadata from a span.

Patch (shallow-merge) metadata for a span. Keys present in the body are set or overwritten; keys not present are left untouched; a key whose value is null is deleted. Merging is top-level only (nested objects are replaced wholesale, not deep-merged), so a literal null cannot be stored as a value. An empty body changes no metadata.

Set a configuration value for a layer in an editor namespace.

Remove a configuration value for a layer.

Get a text layer by ID.

Delete a text layer.

Update a text layer's name.

Shift a text layer's display order within the project.

Create a new text layer for a project.

Replace all metadata for a text.

Remove all metadata from a text.

Patch (shallow-merge) metadata for a text. Keys present in the body are set or overwritten; keys not present are left untouched; a key whose value is null is deleted. Merging is top-level only (nested objects are replaced wholesale, not deep-merged), so a literal null cannot be stored as a value. An empty body changes no metadata.

Create a new text in a document's text layer. A text is a container for

Get a text.

Delete a text and all dependent data.

Update a text's body. A diff is computed and token indices are updated

Shift a token layer's display order.

Create a new token layer.

Set a configuration value for a layer in an editor namespace.

Remove a configuration value for a layer.

Get a token layer by ID.

Delete a token layer.

Update a token layer's name.

Create a new token in a token layer. Tokens define text substrings

Get a token.

Delete a token and remove it from any spans. If this causes a span to

Update a token.

Create multiple tokens in a single operation.

Delete multiple tokens in a single operation. Provide an array of IDs.

Split a token at a Unicode code-point offset. The original token becomes the

Merge two tokens. The left token (smaller begin) survives with the combined

Shift a token's boundary. On partitioning layers the adjacent token is

Replace all metadata for a token.

Remove all metadata from a token.

Patch (shallow-merge) metadata for a token. Keys present in the body are set or overwritten; keys not present are left untouched; a key whose value is null is deleted. Merging is top-level only (nested objects are replaced wholesale, not deep-merged), so a literal null cannot be stored as a value. An empty body changes no metadata.

List (or search) users. Transparently follows pagination cursors and

Fetch a single page of users (optionally filtered by `q`).

Async-iterate users page by page; yields each page's entries array.

Create a new user

Get audit log for a user's actions. Transparently follows pagination

Get a user by ID

Deactivate a user. Users are never hard-deleted: deactivation

Reactivate a deactivated user, restoring their ability to log in.

Modify a user. Admins may change the username, password, and admin

Replace all metadata for a vocab item.

Remove all metadata from a vocab item.

Patch (shallow-merge) metadata for a vocab item. Keys present in the body are set or overwritten; keys not present are left untouched; a key whose value is null is deleted. Merging is top-level only (nested objects are replaced wholesale, not deep-merged), so a literal null cannot be stored as a value. An empty body changes no metadata.

Create a new vocab item

Create multiple vocab items in a single operation. Entries may target

Delete multiple vocab items in a single operation. Each item's

Get a vocab item by ID

Delete a vocab item

Update a vocab item's form

Get a vocab layer by ID

Delete a vocab layer.

Update a vocab layer's name.

Set a configuration value for a layer in an editor namespace.

Remove a configuration value for a layer.

List all vocab layers accessible to user. Transparently follows

Fetch a single page of vocab layers.

Async-iterate vocab layers page by page; yields each page's entries array.

Create a new vocab layer. Note: this also registers the user as a maintainer.

Assign a user as a maintainer for this vocab layer.

Remove a user's maintainer privileges for this vocab layer.

Create a new vocab link between tokens and a vocab item.

Create multiple vocab links in a single operation. Entries may

Delete multiple vocab links in a single operation. Provide an array of IDs.

Replace all metadata for a vocab link. The entire metadata map is replaced - existing metadata keys not included in the request will be removed.

Remove all metadata from a vocab link.

Patch (shallow-merge) metadata for a vocab link. Keys present in the body are set or overwritten; keys not present are left untouched; a key whose value is null is deleted. Merging is top-level only (nested objects are replaced wholesale, not deep-merged), so a literal null cannot be stored as a value. An empty body changes no metadata.

Get a vocab link by ID

Delete a vocab link