Export Instruments
Export instrument level data so that you can consume the data in your own internal applications
Export instruments and their data
POST
https://api.annolab.ai/v1/export/instruments
Export all information related to instruments that meet filter criteria. Can include annotation data, source files, and tags.
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Where you put your api key. Exporting a project requires a key with "Read" permissions.
|
Request Body
Name | Type | Description |
---|---|---|
projectOwner* | String | Group Name that owns the project (viewable in "All Projects" page) |
projectName* | String | Name of the project you wish to export from |
tagFilter | Object | Filter export to include/exclude instruments with tags of these types attached. Applies to instrument's source file tags as well. These filters act as an "OR" condition, so specifying two tags means any instrument with either will be exported.
|
sourceFilter | String | Filters export to only those instruments that have a source file name equal to sourceFilter |
includeFiles | Boolean | If true, splits each instrument into individual files for export |
This code shows how to request an instrument export, then download the export contents.
Example Export Format
Once an export is completed, you will see a zip file on your file system
Opening the zip file will reveal one .json (jsonlines file) and a folder named pdfs (if you specified includeFiles: true
in your export request)
Exported instrument pdfs will have a name of the form <Instrument Type>_<page start>-<page end>_<instrument id>.pdf
The instruments.json
file will contain json lines of Instrument Objects
Last updated