API docs by Redocly

TaskMonk (1.1)

Download OpenAPI specification:Download

APIs to integrate with TaskMonk service. Refer to http://docs.taskmonk.io/concepts.html for an overview.

Project

Quick project setup

Creates a project with minimal inputs and initializes its core fields in a single call.

Authorizations:
oauth_2_0
path Parameters
organizationId
required
integer <int32>

Identifier of the organization that will own the project

Request Body schema: application/json
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "project": {
    },
  • "fields": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Clone project

Clones an existing project. When cloneFields=true, copies configuration (task design, workflow & levels, advanced settings) from the source project. Runtime data is not copied.

Authorizations:
oauth_2_0
path Parameters
projectId
required
string

ID of the source project to clone from

query Parameters
cloneFields
boolean
Default: false

If true, copies configuration and workflow from the source project

Request Body schema: application/json
name
required
string

New project name.

processName
required
string

Process display name for the cloned project.

groupId
integer or null

Optional group association for the new project.

organization_id
required
string

Owning organization identifier.

client
required
string

Client identifier associated with the project.

created_by
required
string

User ID of the creator of the cloned project.

active
required
boolean

New project activation state after cloning.

execution
required
string
Enum: "SEQUENTIAL" "PARALLEL"

Execution strategy for the workflow.

projectType
required
string

Type/category of the project (e.g., "Annotation").

metaData
required
object

Additional settings for the cloned project.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "processName": "string",
  • "groupId": 0,
  • "organization_id": "string",
  • "client": "string",
  • "created_by": "string",
  • "active": true,
  • "execution": "SEQUENTIAL",
  • "projectType": "string",
  • "metaData": { }
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Batch

Create a batch

Authorizations:
oauth_2_0
path Parameters
project_id
required
string
Request Body schema: application/json
batch_name
required
string
priority
integer <int32>
comments
string

Responses

Request samples

Content type
application/json
{
  • "batch_name": "string",
  • "priority": 0,
  • "comments": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Get batches of a project

Authorizations:
oauth_2_0
path Parameters
project_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Edit batch

Authorizations:
oauth_2_0
path Parameters
project_id
required
string
batch_id
required
string
Request Body schema: application/json
batch_name
required
string
priority
integer <int32>
comments
string

Responses

Request samples

Content type
application/json
{
  • "batch_name": "string",
  • "priority": 0,
  • "comments": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Change batch state

Authorizations:
oauth_2_0
path Parameters
batch_id
required
string
Request Body schema: application/json
state
required
string
Enum: "ACTIVE" "PENDING" "SCHEDULED" "CANCELLED" "COMPLETED" "VALIDATE" "ARCHIVED" "PAUSED"

Responses

Request samples

Content type
application/json
{
  • "state": "ACTIVE"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Query batches

Authorizations:
oauth_2_0
path Parameters
project_id
required
string
query Parameters
start_batch
string
end_batch
string
page_size
integer <int32>
page_number
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "total": 0
}

Query projects and batches

Authorizations:
oauth_2_0
path Parameters
org_id
required
string
query Parameters
start_date
string <date>
end_date
string <date>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Status

Get status of a batch

Authorizations:
oauth_2_0
path Parameters
batch_id
required
string

Responses

Response samples

Content type
application/json
{
  • "batch_id": "string",
  • "batch_name": "string",
  • "created_date": "2019-08-24",
  • "completed": 0,
  • "pending": 0,
  • "total": 0,
  • "rejected": 0,
  • "in_progress": 0,
  • "qc_pending": 0,
  • "eta": "string",
  • "eta_type": "string",
  • "state": "string",
  • "percentage_completed": 0,
  • "job_id": "string"
}

Get job progress

Authorizations:
oauth_2_0
path Parameters
job_id
required
string

Responses

Response samples

Content type
application/json
{
  • "completed": 0,
  • "total": 0,
  • "error_msg": "string"
}

Task Upload

Import tasks from file

Authorizations:
oauth_2_0
path Parameters
project_id
required
string
batch_id
required
string
query Parameters
fileType
required
string
Request Body schema: multipart/form-data
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "jobId": "string",
  • "batchId": "string",
  • "excelJobId": "string"
}

Import tasks from dictionary

Authorizations:
oauth_2_0
path Parameters
batch_id
required
string
Request Body schema: application/json
external_id
string
batch_id
string
required
object

Key-value pairs of task data.

Responses

Request samples

Content type
application/json
{
  • "external_id": "string",
  • "batch_id": "string",
  • "data": {
    }
}

Import tasks from URL

Authorizations:
oauth_2_0
path Parameters
batch_id
required
string
query Parameters
file_url
required
string
file_type
required
string

Responses

Response samples

Content type
application/json
{
  • "jobId": "string",
  • "batchId": "string",
  • "excelJobId": "string"
}

Import tasks from cloud

Authorizations:
oauth_2_0
path Parameters
project_id
required
string
batch_id
required
string
Request Body schema: application/json
One of
folderName
required
string
extension
required
string

Responses

Request samples

Content type
application/json
Example
{
  • "folderName": "string",
  • "extension": "string"
}

Response samples

Content type
application/json
{
  • "jobId": "string",
  • "batchId": "string",
  • "excelJobId": "string"
}

Export Data

Get batch output file

Authorizations:
oauth_2_0
path Parameters
project_id
required
string
batch_id
required
string
query Parameters
output_format
string
Request Body schema: application/json
field_names
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "field_names": [
    ]
}

Response samples

Content type
application/json
{
  • "job_id": "string",
  • "file_url": "string"
}

Get batch output dictionary

Authorizations:
oauth_2_0
path Parameters
batch_id
required
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "total": 0
}

Get project output file

Authorizations:
oauth_2_0
path Parameters
project_id
required
string
query Parameters
output_format
string
Request Body schema: application/json
start_time
required
string <date-time>

All tasks submitted after this time will be exported. Sample format: "2024-10-05T09:36:00"

end_time
required
string <date-time>

All tasks submitted before this time will be exported. Must not be more than 30 days from start_time.

field_names
Array of strings

Optional list of fields to include in the output. If omitted or empty, all fields are returned.

Responses

Request samples

Content type
application/json
{
  • "start_time": "2019-08-24T14:15:22Z",
  • "end_time": "2019-08-24T14:15:22Z",
  • "field_names": [
    ]
}

Response samples

Content type
application/json
{
  • "job_id": "string",
  • "file_url": "string"
}

Taxonomy

Get taxonomy

Authorizations:
oauth_2_0
path Parameters
project_id
required
string
taxonomy_id
required
string
query Parameters
file_type
required
string

Responses

Response samples

Content type
application/json
{
  • "taxonomy": {
    },
  • "categories": [
    ]
}

Create new taxonomy

Authorizations:
oauth_2_0
path Parameters
project_id
required
string
Request Body schema: application/json
name
required
string

Name of the new taxonomy

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Import taxonomy

Authorizations:
oauth_2_0
path Parameters
project_id
required
string
taxonomy_id
required
string
query Parameters
file_type
string
Request Body schema: multipart/form-data
file
string <binary>

Responses