Create a job
Last updated
Last updated
A JOB
POST
https://api.playment.io/v1/projects/:project_id/jobs
This endpoint allows you to create a job
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
After creating the job, please store the job_id
received in the response. You'll use this job_id
to get the annotations later.
After opening a project, You can find the project_id
in the information tooltip or URL.
In the Batches section of a project, You can find the batch_id
in the batch information tooltip.
The payload data structure varies depending on the type of task
The attachments you pass in the job creation requests ultimately need to be made available to the annotators who make the annotations in GT Studio. Depending on the type of workforce and whether you agree to give TELUS International access to your data, there are a couple of methods through which you can provide access to these attachments:
For details on possible errors, please follow this link:
project_id
string
ID of the project in which you want to create the job
x-api-key
string
API key for authentication
batch_id
string
A batch is a way to organize multiple jobs under one batch_id
. You can create new batches from the dashboard or by using the batch creation API.
If batch_id
is left empty or the key is not present, the job is created in the Default batch
in your project.
work_flow_id
string
The ID of the workflow inside which you want to create the job
data
object
The data
object contains all the information and attachments required to label a job. The data
object is defined below
reference_id
string
Your unique identifier for the job. We suggest you use a UUID or incremental counter such that each job has a unique reference_id
Workforce Type
TELUS International can access?
Method
Managed by TELUS International
Yes
Not managed by TELUS International
Yes
Not managed by TELUS International
No