Follow

Dedicated: API Requests and Operations

Important note: This article contains information regarding our Dedicated product. If you are looking for documentation regarding the cloud data annotation platform, please visit all other categories in our larger Success Center.

Request Conventions


Full API documentation for API requests unique to your Dedicated instance can be accessed at the following URL: app.{{your-custom-domain}}.com/api-documentation.

 

List of Operations


An operation is a request that invokes a server-side procedure.  All Jobs-resource operations are invoked at the /jobs or /jobs/{job_id} endpoint.

Upload

Method

Endpoint

Parameters


POST

/jobs/upload
or
​/jobs/{job_id}/upload

  • Upload rows to a job using this endpoint
  • The API currently only supports JSON
  • If uploading multiple rows, use Newline Delimited JSON (ndJSON)

 

Copy

Method

Endpoint

Parameters




GET




​/jobs/{job_id}/copy

  • all_units copies all units to new Job
    gold copies only Test Questions to new Job

 

Pause

Method

Endpoint

Notes




GET




/jobs/{job_id}/pause

  • You can pause a job at any time if you want to temporarily stop judgments from coming
  • Paused jobs may be resumed

 

Resume

Method

Endpoint

Notes



GET



/jobs/{job_id}/resume

  • You can resume a paused job at any time

 

Cancel

Method

Endpoint

Notes





GET





/jobs/{job_id}/cancel

  • You can cancel a job at any time if you want to permanently stop judgments from coming in and refund your account for any judgments not yet received
  • Canceled Jobs may not be resumed or ordered

 

Status

Method

Endpoint

Notes



GET



/jobs/{job_id}/ping

  • You can check the status/progress of your job at any time with this operation

Was this article helpful?
4 out of 5 found this helpful


Have more questions? Submit a request
Powered by Zendesk