Export Project

Two types: export a single file in a specific project or export all files in a project.
Methods
There are four different methods to obtain the export result, i.e. download, email, webhook, and external object storage. These methods are fully explained here.
The method will be the same and applicable for both types of export. Below is the additional explanation for each method. Don't forget to fill all the required attributes, then follow these hints.
1.Download
- For the method attribute, fill it with FILE_STORAGE.
2.Email
- For the method attribute, fill it with EMAIL.
3.Webhook
- For the method attribute, fill it with CUSTOM_WEBHOOK.
- You also need to fill url and secret attribute.
- The detailed explanation can be seen here.
4.External Object Storage
- For the method attribute, fill with EXTERNAL_OBJECT_STORAGE.
- You also need to fill externalObjectStorageParameter.
Asynchronous Process
All the processes above are done asynchronously. To check the export job, you need to request getExportDeliveryStatus query.
Specific for FILE_STORAGE method, the fileUrl response could return 404. If this happens, it means the export result hasn't been uploaded yet. Please wait or polling the query above to know when exactly the fileUrl is ready and can be downloaded.
The Export API
Use the below API docs reference and follow this step-by-step section to make the API request.
Export a File
Query: exportTextProjectDocument​
Input: ExportTextProjectDocumentInput​
Response: ExportRequestResult​
Export All Files
Specifically for this, there is a Python script example that you can refer to or use.
Query: exportTextProject​
Input: ExportTextProjectInput​
Response: ExportRequestResult​

Run ML-Assisted Labeling

Custom Webhook

Last modified 2d ago