begin_batchBegin a batch of operations. All subsequent API calls will be queued instead of executed.
submit_batchSubmit all queued batch operations as a single batch request (synchronous).
abort_batchAbort the current batch without executing any operations.
is_batch_modeCheck if currently in batch mode.
enter_strict_modeEnter strict mode for a specific document.
exit_strict_modeExit strict mode and stop tracking document versions for writes.
set_agent_nameSet the user agent name for audit logging.
loginAuthenticate and return a new client instance with token
submitExecute multiple API operations one after the other. If any operation fails (status >= 300), all changes are rolled back. Atomicity is guaranteed. On success, returns an array of each response associated with each submitted request in the batch. On failure, returns a single response map with the first failing response in the batch.
check_lockGet information about a document lock
acquire_lockAcquire or refresh a document lock
release_lockRelease a document lock
get_mediaGet media file for a document
upload_mediaUpload a media file for a document. Uses Apache Tika for content validation.
delete_mediaDelete media file for a document
set_metadataReplace all metadata for a document. The entire metadata map is replaced - existing metadata keys not included in the request will be removed.
delete_metadataRemove all metadata from a document.
auditGet audit log for a document
getGet a document. Set include_body to true in order to include all data contained in the document.
deleteDelete a document and all data contained.
updateUpdate a document. Supported keys:
createCreate a new document in a project. Requires project_id and name.
send_messageSend a message to all clients that are listening to a project. Useful for e.g. telling an NLP service to perform some work.
heartbeatINTERNAL, do not use directly.
listenListen to audit log events and messages for a project via Server-Sent Events (with enhanced connection management)
send_heartbeat_confirmationSend heartbeat confirmation to server (thread-safe)
get_connection_statsGet real-time connection statistics (similar to JavaScript getStats())
discover_servicesDiscover available services in a project
serveRegister as a service and handle incoming requests
progressSend progress update
completeSend completion response with result data
errorSend error response
request_serviceRequest a service to perform work
add_writerSet a user's access level to read and write for this project.
remove_writerRemove a user's writer privileges for this project.
add_readerSet a user's access level to read-only for this project.
remove_readerRemove a user's reader privileges for this project.
set_configSet 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.
delete_configRemove a configuration value for a layer.
add_maintainerAssign a user as a maintainer for this project.
remove_maintainerRemove a user's maintainer privileges for this project.
auditGet audit log for a project
link_vocabLink a vocabulary to a project.
unlink_vocabUnlink a vocabulary to a project.
getGet a project by ID. If include_documents is true, also include document IDs and names.
deleteDelete a project.
updateUpdate a project's name.
listList all projects accessible to user
createCreate a new project. Note: this also registers the user as a maintainer.
shiftShift a relation layer's order.
createCreate a new relation layer.
set_configSet 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.
delete_configRemove a configuration value for a layer.
getGet a relation layer by ID.
deleteDelete a relation layer.
updateUpdate a relation layer's name.
set_metadataReplace all metadata for a relation. The entire metadata map is replaced - existing metadata keys not included in the request will be removed.
delete_metadataRemove all metadata from a relation.
set_targetUpdate the target span of a relation.
getGet a relation by ID.
deleteDelete a relation.
updateUpdate a relation's value.
set_sourceUpdate the source span of a relation.
createCreate 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.
bulk_createCreate multiple relations in a single operation. Provide an array of objects whose keysare:
bulk_deleteDelete multiple relations in a single operation. Provide an array of IDs.
set_configSet 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.
delete_configRemove a configuration value for a layer.
getGet a span layer by ID.
deleteDelete a span layer.
updateUpdate a span layer's name.
createCreate a new span layer.
shiftShift a span layer's order.
set_tokensReplace tokens for a span.
createCreate 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.
getGet a span by ID.
deleteDelete a span.
updateUpdate a span's value.
bulk_createCreate multiple spans in a single operation. Provide an array of objects whose keysare:
bulk_deleteDelete multiple spans in a single operation. Provide an array of IDs.
set_metadataReplace all metadata for a span. The entire metadata map is replaced - existing metadata keys not included in the request will be removed.
delete_metadataRemove all metadata from a span.
set_configSet 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.
delete_configRemove a configuration value for a layer.
getGet a text layer by ID.
deleteDelete a text layer.
updateUpdate a text layer's name.
shiftShift a text layer's order within the project.
createCreate a new text layer for a project.
set_metadataReplace all metadata for a text. The entire metadata map is replaced - existing metadata keys not included in the request will be removed.
delete_metadataRemove all metadata from a text.
createCreate 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.
getGet a text.
deleteDelete a text and all dependent data.
updateUpdate 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.
shiftShift a token layer's order.
createCreate a new token layer.
set_configSet 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.
delete_configRemove a configuration value for a layer.
getGet a token layer by ID.
deleteDelete a token layer.
updateUpdate a token layer's name.
createCreate 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.
getGet a token.
deleteDelete 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.
updateUpdate a token. Supported keys:
bulk_createCreate multiple tokens in a single operation. Provide an array of objects whose keysare:
bulk_deleteDelete multiple tokens in a single operation. Provide an array of IDs.
set_metadataReplace all metadata for a token. The entire metadata map is replaced - existing metadata keys not included in the request will be removed.
delete_metadataRemove all metadata from a token.
listList all users
createCreate a new user
auditGet audit log for a user's actions
getGet a user by ID
deleteDelete a user
updateModify 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.
set_metadataReplace all metadata for a vocab item. The entire metadata map is replaced - existing metadata keys not included in the request will be removed.
delete_metadataRemove all metadata from a vocab item.
createCreate a new vocab item
getGet a vocab item by ID
deleteDelete a vocab item
updateUpdate a vocab item's form
getGet a vocab layer by ID
deleteDelete a vocab layer.
updateUpdate a vocab layer's name.
set_configSet 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.
delete_configRemove a configuration value for a layer.
listList all vocab layers accessible to user
createCreate a new vocab layer. Note: this also registers the user as a maintainer.
add_maintainerAssign a user as a maintainer for this vocab layer.
remove_maintainerRemove a user's maintainer privileges for this vocab layer.
createCreate a new vocab link (link between tokens and vocab item).
set_metadataReplace all metadata for a vocab link. The entire metadata map is replaced - existing metadata keys not included in the request will be removed.
delete_metadataRemove all metadata from a vocab link.
getGet a vocab link by ID
deleteDelete a vocab link