This interface allows applications to retrieve data from a dataset. The application requires an access token as follows:
In Dataset Management page, select the dropdown on the top-right of a dataset, then select “Generate API Token“. This token will be used with every bridge API to upload or access samples. This token does not expire and can be reused.
Generating Token
2. Generating Token
- Select dataset
- Select one annotation set from the dataset above
- Enter a device name
- Click “Generate“, a Java Web Token (Access Token) will be created for all API usage.
Get List of Samples
Endpoint: https://dveml.com/samples/export
Method: HTTP GET
Payload:
[{
'name': 'code',
'value': abc,
},
{
'name': 'sequence_uuid',
'value': abc,
}]
Return:
- JSON list of samples, where each key is the uuid of the sample
- If sample has an image, an S3 presigned URL is provided.
- If sample has file type annotations, an S3 presigned URL is provided for each file.
- Error message if an error occurred
Get List of Samples Without File URLs
Endpoint: https://dveml.com/samples/list
Method: HTTP GET
Payload:
{
'sequence_uuid': 'abc',
'code': 'abc',
},
Return:
- JSON list of samples, where each key is the uuid of the sample.
- No S3 Presigned Urls for images or file-type annotations.
- Error message if an error occurred.
Get Detailed Info for Samples
Endpoint: https://dveml.com/samples/get
Method: HTTP GET
Payload:
{
'samples_uuids': '[abcd-1234, abcde-123]',
'code': 'abc',
},
Return:
- JSON list of topics for the given samples UUID
- If sample has an image, an S3 presigned URL is provided.
- If sample has file type annotations, an S3 presigned URL is provided for each file.
- Error message if an error occurred
Comments
0 comments
Please sign in to leave a comment.