JavaScript API Documentation

misc

`constructor`

Create a new PlaidClient instance

Parameters

baseUrl (string) - The base URL for the API
token (string) - The authentication token

`login`

static

Authenticate and return a new client instance with token

Parameters

baseUrl (string) - The base URL for the API
userId (string) - User ID for authentication
password (string) - Password for authentication

`enterStrictMode`

Enter strict mode for a specific document.

Parameters

documentId (string) - The ID of the document to track versions for

`exitStrictMode`

Exit strict mode and stop tracking document versions for writes.

`beginBatch`

Begin a batch of operations. All subsequent API calls will be queued instead of executed.

`submitBatch`

Submit all queued batch operations as a single batch request.

`abortBatch`

Abort the current batch without executing any operations.

`isBatchMode`

Check if currently in batch mode.

documentVersions

`create`

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

Parameters

vocabItem (string) - Required. Vocabitem
tokens (Array) - Required. Tokens
metadata (any, optional) - Optional. Metadata

`setMetadata`

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

Parameters

id (string) - Id identifier
body (any) - Required. Body

`deleteMetadata`

Remove all metadata from a vocab link.

Parameters

id (string) - Id identifier

`get`

Get a vocab link by ID

Parameters

id (string) - Id identifier
asOf (string, optional) - Optional asOf

`delete`

Delete a vocab link

Parameters

id (string) - Id identifier

documents

`checkLock`

Get information about a document lock

Parameters

documentId (string) - Document-id identifier
asOf (string, optional) - Optional asOf

`acquireLock`

Acquire or refresh a document lock

Parameters

documentId (string) - Document-id identifier

`releaseLock`

Release a document lock

Parameters

documentId (string) - Document-id identifier

`getMedia`

Get media file for a document

Parameters

documentId (string) - Document-id identifier
asOf (string, optional) - Optional asOf

`uploadMedia`

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

Parameters

documentId (string) - Document-id identifier
file (string) - Required. File

`deleteMedia`

Delete media file for a document

Parameters

documentId (string) - Document-id identifier

`setMetadata`

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

Parameters

documentId (string) - Document-id identifier
body (any) - Required. Body

`deleteMetadata`

Remove all metadata from a document.

Parameters

documentId (string) - Document-id identifier

`audit`

Get audit log for a document

Parameters

documentId (string) - Document-id identifier
startTime (string, optional) - Optional startTime
endTime (string, optional) - Optional endTime
asOf (string, optional) - Optional asOf

`get`

Get a document. Set includeBody to true in order to include all data contained in the document.

Parameters

documentId (string) - Document-id identifier
includeBody (boolean, optional) - Optional includeBody
asOf (string, optional) - Optional asOf

`delete`

Delete a document and all data contained.

Parameters

documentId (string) - Document-id identifier

`update`

Update a document. Supported keys:

Parameters

documentId (string) - Document-id identifier
name (string) - Required. Name

`create`

Create a new document in a project. Requires projectId and name.

Parameters

projectId (string) - Required. Projectid
name (string) - Required. Name
metadata (any, optional) - Optional. Metadata

messages

`listen`

Listen for project events including service coordination messages

Parameters

projectId (string) - The UUID of the project to listen to
onEvent (function) - Callback function that receives (eventType, data). If it returns true, listening will stop.

`sendMessage`

Send a message to project listeners

Parameters

projectId (string) - The UUID of the project to send to
data (any) - The message data to send

`discoverServices`

Discover available services in a project

Parameters

projectId (string) - The UUID of the project to query
timeout (number) - Timeout in milliseconds (default: 3000)

`serve`

Parameters

projectId (string) - The UUID of the project to serve
serviceInfo (Object) - Service information {serviceId, serviceName, description}
onServiceRequest (function) - Callback to handle service requests
extras (Object, optional) - Optional additional service metadata

`requestService`

Request a service to perform work

Parameters

projectId (string) - The UUID of the project
serviceId (string) - The ID of the service to request
data (any) - The request data
timeout (number) - Timeout in milliseconds (default: 10000)

projects

`addWriter`

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

Parameters

id (string) - Id identifier
userId (string) - User-id identifier

`removeWriter`

Remove a user's writer privileges for this project.

Parameters

id (string) - Id identifier
userId (string) - User-id identifier

`addReader`

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

Parameters

id (string) - Id identifier
userId (string) - User-id identifier

`removeReader`

Remove a user's reader privileges for this project.

Parameters

id (string) - Id identifier
userId (string) - User-id identifier

`setConfig`

Set a configuration value for a layer in a editor namespace. Intended for storing metadata about how the layer is intended to be used, e.g. for morpheme tokenization or sentence boundary marking.

Parameters

id (string) - Id identifier
namespace (string) - Namespace identifier
configKey (string) - Config-key identifier
configValue (any) - Configuration value to set

`deleteConfig`

Remove a configuration value for a layer.

Parameters

id (string) - Id identifier
namespace (string) - Namespace identifier
configKey (string) - Config-key identifier

`addMaintainer`

Assign a user as a maintainer for this project.

Parameters

id (string) - Id identifier
userId (string) - User-id identifier

`removeMaintainer`

Remove a user's maintainer privileges for this project.

Parameters

id (string) - Id identifier
userId (string) - User-id identifier

`audit`

Get audit log for a project

Parameters

projectId (string) - Project-id identifier
startTime (string, optional) - Optional startTime
endTime (string, optional) - Optional endTime
asOf (string, optional) - Optional asOf

`linkVocab`

Link a vocabulary to a project.

Parameters

id (string) - Id identifier
vocabId (string) - Vocab-id identifier

`unlinkVocab`

Unlink a vocabulary to a project.

Parameters

id (string) - Id identifier
vocabId (string) - Vocab-id identifier

`get`

Get a project by ID. If includeDocuments is true, also include document IDs and names.

Parameters

id (string) - Id identifier
includeDocuments (boolean, optional) - Optional includeDocuments
asOf (string, optional) - Optional asOf

`delete`

Delete a project.

Parameters

id (string) - Id identifier

`update`

Update a project's name.

Parameters

id (string) - Id identifier
name (string) - Required. Name

`list`

List all projects accessible to user

Parameters

asOf (string, optional) - Optional asOf

`create`

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

Parameters

name (string) - Required. Name

relationLayers

`shift`

Shift a relation layer's order.

Parameters

relationLayerId (string) - Relation-layer-id identifier
direction (string) - Required. Direction

`create`

Create a new relation layer.

Parameters

spanLayerId (string) - Required. Spanlayerid
name (string) - Required. Name

`setConfig`

Set a configuration value for a layer in a editor namespace. Intended for storing metadata about how the layer is intended to be used, e.g. for morpheme tokenization or sentence boundary marking.

Parameters

relationLayerId (string) - Relation-layer-id identifier
namespace (string) - Namespace identifier
configKey (string) - Config-key identifier
configValue (any) - Configuration value to set

`deleteConfig`

Remove a configuration value for a layer.

Parameters

relationLayerId (string) - Relation-layer-id identifier
namespace (string) - Namespace identifier
configKey (string) - Config-key identifier

`get`

Get a relation layer by ID.

Parameters

relationLayerId (string) - Relation-layer-id identifier
asOf (string, optional) - Optional asOf

`delete`

Delete a relation layer.

Parameters

relationLayerId (string) - Relation-layer-id identifier

`update`

Update a relation layer's name.

Parameters

relationLayerId (string) - Relation-layer-id identifier
name (string) - Required. Name

relations

`setMetadata`

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

Parameters

relationId (string) - Relation-id identifier
body (any) - Required. Body

`deleteMetadata`

Remove all metadata from a relation.

Parameters

relationId (string) - Relation-id identifier

`setTarget`

Update the target span of a relation.

Parameters

relationId (string) - Relation-id identifier
spanId (string) - Required. Spanid

`get`

Get a relation by ID.

Parameters

relationId (string) - Relation-id identifier
asOf (string, optional) - Optional asOf

`delete`

Delete a relation.

Parameters

relationId (string) - Relation-id identifier

`update`

Update a relation's value.

Parameters

relationId (string) - Relation-id identifier
value (any) - Required. Value

`setSource`

Update the source span of a relation.

Parameters

relationId (string) - Relation-id identifier
spanId (string) - Required. Spanid

`create`

Create a new relation. A relation is a directed edge between two spans with a value, useful for expressing phenomena such as syntactic or semantic relations. A relation must at all times have both a valid source and target span. These spans must also belong to a single span layer which is linked to the relation's relation layer.

Parameters

layerId (string) - Required. Layerid
sourceId (string) - Required. Sourceid
targetId (string) - Required. Targetid
value (any) - Required. Value
metadata (any, optional) - Optional. Metadata

`bulkCreate`

Create multiple relations in a single operation. Provide an array of objects whose keysare:

Parameters

body (Array) - Required. Body

`bulkDelete`

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

Parameters

body (Array) - Required. Body

spanLayers

`setConfig`

Set a configuration value for a layer in a editor namespace. Intended for storing metadata about how the layer is intended to be used, e.g. for morpheme tokenization or sentence boundary marking.

Parameters

spanLayerId (string) - Span-layer-id identifier
namespace (string) - Namespace identifier
configKey (string) - Config-key identifier
configValue (any) - Configuration value to set

`deleteConfig`

Remove a configuration value for a layer.

Parameters

spanLayerId (string) - Span-layer-id identifier
namespace (string) - Namespace identifier
configKey (string) - Config-key identifier

`get`

Get a span layer by ID.

Parameters

spanLayerId (string) - Span-layer-id identifier
asOf (string, optional) - Optional asOf

`delete`

Delete a span layer.

Parameters

spanLayerId (string) - Span-layer-id identifier

`update`

Update a span layer's name.

Parameters

spanLayerId (string) - Span-layer-id identifier
name (string) - Required. Name

`create`

Create a new span layer.

Parameters

tokenLayerId (string) - Required. Tokenlayerid
name (string) - Required. Name

`shift`

Shift a span layer's order.

Parameters

spanLayerId (string) - Span-layer-id identifier
direction (string) - Required. Direction

spans

`setTokens`

Replace tokens for a span.

Parameters

spanId (string) - Span-id identifier
tokens (Array) - Required. Tokens

`create`

Create a new span. A span holds a primary atomic value and optional metadata, and must at all times be associated with one or more tokens.

Parameters

spanLayerId (string) - Required. Spanlayerid
tokens (Array) - Required. Tokens
value (any) - Required. Value
metadata (any, optional) - Optional. Metadata

`get`

Get a span by ID.

Parameters

spanId (string) - Span-id identifier
asOf (string, optional) - Optional asOf

`delete`

Delete a span.

Parameters

spanId (string) - Span-id identifier

`update`

Update a span's value.

Parameters

spanId (string) - Span-id identifier
value (any) - Required. Value

`bulkCreate`

Create multiple spans in a single operation. Provide an array of objects whose keysare:

Parameters

body (Array) - Required. Body

`bulkDelete`

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

Parameters

body (Array) - Required. Body

`setMetadata`

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

Parameters

spanId (string) - Span-id identifier
body (any) - Required. Body

`deleteMetadata`

Remove all metadata from a span.

Parameters

spanId (string) - Span-id identifier

textLayers

`setConfig`

Set a configuration value for a layer in a editor namespace. Intended for storing metadata about how the layer is intended to be used, e.g. for morpheme tokenization or sentence boundary marking.

Parameters

textLayerId (string) - Text-layer-id identifier
namespace (string) - Namespace identifier
configKey (string) - Config-key identifier
configValue (any) - Configuration value to set

`deleteConfig`

Remove a configuration value for a layer.

Parameters

textLayerId (string) - Text-layer-id identifier
namespace (string) - Namespace identifier
configKey (string) - Config-key identifier

`get`

Get a text layer by ID.

Parameters

textLayerId (string) - Text-layer-id identifier
asOf (string, optional) - Optional asOf

`delete`

Delete a text layer.

Parameters

textLayerId (string) - Text-layer-id identifier

`update`

Update a text layer's name.

Parameters

textLayerId (string) - Text-layer-id identifier
name (string) - Required. Name

`shift`

Shift a text layer's order within the project.

Parameters

textLayerId (string) - Text-layer-id identifier
direction (string) - Required. Direction

`create`

Create a new text layer for a project.

Parameters

projectId (string) - Required. Projectid
name (string) - Required. Name

texts

`setMetadata`

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

Parameters

textId (string) - Text-id identifier
body (any) - Required. Body

`deleteMetadata`

Remove all metadata from a text.

Parameters

textId (string) - Text-id identifier

`create`

Create a new text in a document's text layer. A text is simply a container for one long string in body for a given layer.

Parameters

textLayerId (string) - Required. Textlayerid
documentId (string) - Required. Documentid
body (string) - Required. Body
metadata (any, optional) - Optional. Metadata

`get`

Get a text.

Parameters

textId (string) - Text-id identifier
asOf (string, optional) - Optional asOf

`delete`

Delete a text and all dependent data.

Parameters

textId (string) - Text-id identifier

`update`

Update a text's body. A diff is computed between the new and old bodies, and a best effort is made to minimize Levenshtein distance between the two. Token indices are updated so that tokens remain intact. Tokens which fall within a range of deleted text are either shrunk appropriately if there is partial overlap or else deleted if there is whole overlap.

Parameters

textId (string) - Text-id identifier
body (any) - Required. Body

tokenLayers

`shift`

Shift a token layer's order.

Parameters

tokenLayerId (string) - Token-layer-id identifier
direction (string) - Required. Direction

`create`

Create a new token layer.

Parameters

textLayerId (string) - Required. Textlayerid
name (string) - Required. Name

`setConfig`

Set a configuration value for a layer in a editor namespace. Intended for storing metadata about how the layer is intended to be used, e.g. for morpheme tokenization or sentence boundary marking.

Parameters

tokenLayerId (string) - Token-layer-id identifier
namespace (string) - Namespace identifier
configKey (string) - Config-key identifier
configValue (any) - Configuration value to set

`deleteConfig`

Remove a configuration value for a layer.

Parameters

tokenLayerId (string) - Token-layer-id identifier
namespace (string) - Namespace identifier
configKey (string) - Config-key identifier

`get`

Get a token layer by ID.

Parameters

tokenLayerId (string) - Token-layer-id identifier
asOf (string, optional) - Optional asOf

`delete`

Delete a token layer.

Parameters

tokenLayerId (string) - Token-layer-id identifier

`update`

Update a token layer's name.

Parameters

tokenLayerId (string) - Token-layer-id identifier
name (string) - Required. Name

tokens

`create`

Create a new token in a token layer. Tokens define text substrings usingbegin and end offsets in the text. Tokens may be zero-width, and they may overlap with each other. For tokens which share the same begin, precedence may be used to indicate a preferred linear ordering, with tokens with lower precedence occurring earlier.

Parameters

tokenLayerId (string) - Required. Tokenlayerid
text (string) - Required. Text
begin (number) - Required. Begin
end (number) - Required. End
precedence (number, optional) - Optional. Precedence
metadata (any, optional) - Optional. Metadata

`get`

Get a token.

Parameters

tokenId (string) - Token-id identifier
asOf (string, optional) - Optional asOf

`delete`

Delete a token and remove it from any spans. If this causes the span to have no remaining associated tokens, the span will also be deleted.

Parameters

tokenId (string) - Token-id identifier

`update`

Update a token. Supported keys:

Parameters

tokenId (string) - Token-id identifier
begin (number, optional) - Optional. Begin
end (number, optional) - Optional. End
precedence (number, optional) - Optional. Precedence

`bulkCreate`

Create multiple tokens in a single operation. Provide an array of objects whose keysare:

Parameters

body (Array) - Required. Body

`bulkDelete`

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

Parameters

body (Array) - Required. Body

`setMetadata`

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

Parameters

tokenId (string) - Token-id identifier
body (any) - Required. Body

`deleteMetadata`

Remove all metadata from a token.

Parameters

tokenId (string) - Token-id identifier

users

`list`

List all users

Parameters

asOf (string, optional) - Optional asOf

`create`

Create a new user

Parameters

username (string) - Required. Username
password (string) - Required. Password
isAdmin (boolean) - Required. Isadmin

`audit`

Get audit log for a user's actions

Parameters

userId (string) - User-id identifier
startTime (string, optional) - Optional startTime
endTime (string, optional) - Optional endTime
asOf (string, optional) - Optional asOf

`get`

Get a user by ID

Parameters

id (string) - Id identifier
asOf (string, optional) - Optional asOf

`delete`

Delete a user

Parameters

id (string) - Id identifier

`update`

Modify a user. Admins may change the username, password, and admin status of any user. All other users may only modify their own username or password.

Parameters

id (string) - Id identifier
password (string, optional) - Optional. Password
username (string, optional) - Optional. Username
isAdmin (boolean, optional) - Optional. Isadmin

vocabItems

`setMetadata`

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

Parameters

id (string) - Id identifier
body (any) - Required. Body

`deleteMetadata`

Remove all metadata from a vocab item.

Parameters

id (string) - Id identifier

`create`

Create a new vocab item

Parameters

vocabLayerId (string) - Required. Vocablayerid
form (string) - Required. Form
metadata (any, optional) - Optional. Metadata

`get`

Get a vocab item by ID

Parameters

id (string) - Id identifier
asOf (string, optional) - Optional asOf

`delete`

Delete a vocab item

Parameters

id (string) - Id identifier

`update`

Update a vocab item's form

Parameters

id (string) - Id identifier
form (string) - Required. Form

vocabLayers

`get`

Get a vocab layer by ID

Parameters

id (string) - Id identifier
includeItems (boolean, optional) - Optional includeItems
asOf (string, optional) - Optional asOf

`delete`

Delete a vocab layer.

Parameters

id (string) - Id identifier

`update`

Update a vocab layer's name.

Parameters

id (string) - Id identifier
name (string) - Required. Name

`setConfig`

Set a configuration value for a layer in a editor namespace. Intended for storing metadata about how the layer is intended to be used, e.g. for morpheme tokenization or sentence boundary marking.

Parameters

id (string) - Id identifier
namespace (string) - Namespace identifier
configKey (string) - Config-key identifier
configValue (any) - Configuration value to set

`deleteConfig`

Remove a configuration value for a layer.

Parameters

id (string) - Id identifier
namespace (string) - Namespace identifier
configKey (string) - Config-key identifier

`list`

List all vocab layers accessible to user

Parameters

asOf (string, optional) - Optional asOf

`create`

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

Parameters

name (string) - Required. Name

`addMaintainer`

Assign a user as a maintainer for this vocab layer.

Parameters

id (string) - Id identifier
userId (string) - User-id identifier

`removeMaintainer`

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

Parameters

id (string) - Id identifier
userId (string) - User-id identifier