Data Labeling API

Stay organized with collections Save and categorize content based on your preferences.

Public API for Google Cloud AI Data Labeling Service.

Service: datalabeling.googleapis.com

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

  • https://datalabeling.googleapis.com/$discovery/rest?version=v1beta1&key=your-api-key

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://datalabeling.googleapis.com

REST Resource: v1beta1.projects.annotationSpecSets

Methods
create POST /v1beta1/{parent=projects/*}/annotationSpecSets
Creates an annotation spec set by providing a set of labels.
delete DELETE /v1beta1/{name=projects/*/annotationSpecSets/*}
Deletes an annotation spec set by resource name.
get GET /v1beta1/{name=projects/*/annotationSpecSets/*}
Gets an annotation spec set by resource name.
list GET /v1beta1/{parent=projects/*}/annotationSpecSets
Lists annotation spec sets for a project.

REST Resource: v1beta1.projects.datasets

Methods
create POST /v1beta1/{parent=projects/*}/datasets
Creates dataset.
delete DELETE /v1beta1/{name=projects/*/datasets/*}
Deletes a dataset by resource name.
exportData POST /v1beta1/{name=projects/*/datasets/*}:exportData
Exports data and annotations from dataset.
get GET /v1beta1/{name=projects/*/datasets/*}
Gets dataset by resource name.
importData POST /v1beta1/{name=projects/*/datasets/*}:importData
Imports data into dataset based on source locations defined in request.
list GET /v1beta1/{parent=projects/*}/datasets
Lists datasets under a project.

REST Resource: v1beta1.projects.datasets.annotatedDatasets

Methods
delete DELETE /v1beta1/{name=projects/*/datasets/*/annotatedDatasets/*}
Deletes an annotated dataset by resource name.
get GET /v1beta1/{name=projects/*/datasets/*/annotatedDatasets/*}
Gets an annotated dataset by resource name.
list GET /v1beta1/{parent=projects/*/datasets/*}/annotatedDatasets
Lists annotated datasets for a dataset.

REST Resource: v1beta1.projects.datasets.annotatedDatasets.dataItems

Methods
get GET /v1beta1/{name=projects/*/datasets/*/annotatedDatasets/*/dataItems/*}
Gets a data item in a dataset by resource name.
list GET /v1beta1/{parent=projects/*/datasets/*/annotatedDatasets/*}/dataItems
Lists data items in a dataset.

REST Resource: v1beta1.projects.datasets.annotatedDatasets.examples

Methods
get GET /v1beta1/{name=projects/*/datasets/*/annotatedDatasets/*/examples/*}
Gets an example by resource name, including both data and annotation.
list GET /v1beta1/{parent=projects/*/datasets/*/annotatedDatasets/*}/examples
Lists examples in an annotated dataset.

REST Resource: v1beta1.projects.datasets.annotatedDatasets.feedbackThreads

Methods
delete DELETE /v1beta1/{name=projects/*/datasets/*/annotatedDatasets/*/feedbackThreads/*}
Delete a FeedbackThread.
get GET /v1beta1/{name=projects/*/datasets/*/annotatedDatasets/*/feedbackThreads/*}
Get a FeedbackThread object.
list GET /v1beta1/{parent=projects/*/datasets/*/annotatedDatasets/*}/feedbackThreads
List FeedbackThreads with pagination.

REST Resource: v1beta1.projects.datasets.annotatedDatasets.feedbackThreads.feedbackMessages

Methods
create POST /v1beta1/{parent=projects/*/datasets/*/annotatedDatasets/*/feedbackThreads/*}/feedbackMessages
Create a FeedbackMessage object.
delete DELETE /v1beta1/{name=projects/*/datasets/*/annotatedDatasets/*/feedbackThreads/*/feedbackMessages/*}
Delete a FeedbackMessage.
get GET /v1beta1/{name=projects/*/datasets/*/annotatedDatasets/*/feedbackThreads/*/feedbackMessages/*}
Get a FeedbackMessage object.
list GET /v1beta1/{parent=projects/*/datasets/*/annotatedDatasets/*/feedbackThreads/*}/feedbackMessages
List FeedbackMessages with pagination.

REST Resource: v1beta1.projects.datasets.dataItems

Methods
get GET /v1beta1/{name=projects/*/datasets/*/dataItems/*}
Gets a data item in a dataset by resource name.
list GET /v1beta1/{parent=projects/*/datasets/*}/dataItems
Lists data items in a dataset.

REST Resource: v1beta1.projects.datasets.evaluations

Methods
get GET /v1beta1/{name=projects/*/datasets/*/evaluations/*}
Gets an evaluation by resource name (to search, use projects.evaluations.search).

REST Resource: v1beta1.projects.datasets.evaluations.exampleComparisons

Methods
search POST /v1beta1/{parent=projects/*/datasets/*/evaluations/*}/exampleComparisons:search
Searches example comparisons from an evaluation.

REST Resource: v1beta1.projects.datasets.image

Methods
label POST /v1beta1/{parent=projects/*/datasets/*}/image:label
Starts a labeling task for image.

REST Resource: v1beta1.projects.datasets.text

Methods
label POST /v1beta1/{parent=projects/*/datasets/*}/text:label
Starts a labeling task for text.

REST Resource: v1beta1.projects.datasets.video

Methods
label POST /v1beta1/{parent=projects/*/datasets/*}/video:label
Starts a labeling task for video.

REST Resource: v1beta1.projects.evaluationJobs

Methods
create POST /v1beta1/{parent=projects/*}/evaluationJobs
Creates an evaluation job.
delete DELETE /v1beta1/{name=projects/*/evaluationJobs/*}
Stops and deletes an evaluation job.
get GET /v1beta1/{name=projects/*/evaluationJobs/*}
Gets an evaluation job by resource name.
list GET /v1beta1/{parent=projects/*}/evaluationJobs
Lists all evaluation jobs within a project with possible filters.
patch PATCH /v1beta1/{evaluationJob.name=projects/*/evaluationJobs/*}
Updates an evaluation job.
pause POST /v1beta1/{name=projects/*/evaluationJobs/*}:pause
Pauses an evaluation job.
resume POST /v1beta1/{name=projects/*/evaluationJobs/*}:resume
Resumes a paused evaluation job.

REST Resource: v1beta1.projects.evaluations

Methods
search GET /v1beta1/{parent=projects/*}/evaluations:search
Searches evaluations within a project.

REST Resource: v1beta1.projects.instructions

Methods
create POST /v1beta1/{parent=projects/*}/instructions
Creates an instruction for how data should be labeled.
delete DELETE /v1beta1/{name=projects/*/instructions/*}
Deletes an instruction object by resource name.
get GET /v1beta1/{name=projects/*/instructions/*}
Gets an instruction by resource name.
list GET /v1beta1/{parent=projects/*}/instructions
Lists instructions for a project.

REST Resource: v1beta1.projects.operations

Methods
cancel GET /v1beta1/{name=projects/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1beta1/{name=projects/*/operations/*}
Deletes a long-running operation.
get GET /v1beta1/{name=projects/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1beta1/{name=projects/*}/operations
Lists operations that match the specified filter in the request.