Crowdee
API Reference

Interactive API Reference

Explore and test all Crowdee API endpoints interactively.

GET
/v2/auth/start

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Redirect to API docs after authentication

curl -X GET "https://example.com/v2/auth/start"
Empty
GET
/v2/auth/logout

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Log out of the current session

application/json
  1. response
message*string
curl -X GET "https://example.com/v2/auth/logout"
{  "message": "string"}
GET
/v2/comments

Authorization

openIdConnect
OpenID Connect<token>

Response Body

The list of comments

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/comments"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "text": "string",    "image": "string",    "time": "string",    "edited": true,    "authorId": "string",    "projectId": "string",    "fileId": "string",    "workflowId": "string",    "parentCommentId": "string",    "authorName": "string"  }]
GET
/v2/comments/:commentId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

commentId*string
Formatcuid2

Response Body

Metadata of the comment

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
text*string
image*string|null
time*string|null
edited*boolean
authorId*string
Lengthlength <= 24
projectId*string
Lengthlength <= 24
fileId*|
Lengthlength <= 24
workflowId*|
Lengthlength <= 24
parentCommentId*|
Lengthlength <= 24
authorName*string
curl -X GET "https://example.com/v2/comments/:commentId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "text": "string",  "image": "string",  "time": "string",  "edited": true,  "authorId": "string",  "projectId": "string",  "fileId": "string",  "workflowId": "string",  "parentCommentId": "string",  "authorName": "string"}
PUT
/v2/comments/:commentId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

commentId*string
Formatcuid2

Request Body

The updated comment data

application/json
  1. body
text?string
Length1 <= length
image?string|null
time?string|null
edited?boolean
parentCommentId?|
Length24 <= length <= 24

Response Body

The updated comment

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
text*string
image*string|null
time*string|null
edited*boolean
authorId*string
Lengthlength <= 24
projectId*string
Lengthlength <= 24
fileId*|
Lengthlength <= 24
workflowId*|
Lengthlength <= 24
parentCommentId*|
Lengthlength <= 24
authorName*string
curl -X PUT "https://example.com/v2/comments/:commentId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "text": "string",  "image": "string",  "time": "string",  "edited": true,  "authorId": "string",  "projectId": "string",  "fileId": "string",  "workflowId": "string",  "parentCommentId": "string",  "authorName": "string"}
DELETE
/v2/comments/:commentId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

commentId*string
Formatcuid2

Response Body

Metadata of the deleted comment

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
text*string
image*string|null
time*string|null
edited*boolean
authorId*string
Lengthlength <= 24
projectId*string
Lengthlength <= 24
fileId*|
Lengthlength <= 24
workflowId*|
Lengthlength <= 24
parentCommentId*|
Lengthlength <= 24
authorName*string
curl -X DELETE "https://example.com/v2/comments/:commentId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "text": "string",  "image": "string",  "time": "string",  "edited": true,  "authorId": "string",  "projectId": "string",  "fileId": "string",  "workflowId": "string",  "parentCommentId": "string",  "authorName": "string"}
GET
/v2/files

Authorization

openIdConnect
OpenID Connect<token>

Response Body

The list of files

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/files"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "type": "string",    "size": -2147483648,    "path": "string",    "etag": "string",    "organizationId": "string",    "uploaderId": "string",    "lastModified": "2019-08-24T14:15:22Z",    "projectId": "string",    "privacyLevel": "private",    "tags": [      "string"    ],    "metadata": "string",    "additionalInfo": "string",    "origin": "user_upload",    "originWorkflowId": "string",    "sourceFileId": "string",    "enrichmentStatus": "pending",    "placeholder": "string",    "contentHash": "string",    "folderId": "string"  }]
GET
/v2/files/:fileId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

fileId*string
Formatcuid2

Response Body

Metadata of a file

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
type*string
size*integer
Range-2147483648 <= value <= 2147483647
path*string
etag*string
organizationId*string
Lengthlength <= 24
uploaderId*string
Lengthlength <= 24
lastModified*|
Formatdate-time
projectId*|
Lengthlength <= 24
privacyLevel*string
Value in"private""sensitive""internal""public"
tags*array<string>|null
metadata*string|number|boolean|null||array<unknown>
additionalInfo*string|number|boolean|null||array<unknown>
origin*string
Value in"user_upload""workflow_generated"
originWorkflowId*|
Lengthlength <= 24
sourceFileId*|
Lengthlength <= 24
enrichmentStatus*|
Value in"pending""running""completed""failed"null
placeholder*string|null
contentHash*string|null
folderId*|
Lengthlength <= 24
curl -X GET "https://example.com/v2/files/:fileId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "type": "string",  "size": -2147483648,  "path": "string",  "etag": "string",  "organizationId": "string",  "uploaderId": "string",  "lastModified": "2019-08-24T14:15:22Z",  "projectId": "string",  "privacyLevel": "private",  "tags": [    "string"  ],  "metadata": "string",  "additionalInfo": "string",  "origin": "user_upload",  "originWorkflowId": "string",  "sourceFileId": "string",  "enrichmentStatus": "pending",  "placeholder": "string",  "contentHash": "string",  "folderId": "string"}
PUT
/v2/files/:fileId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

fileId*string
Formatcuid2

Request Body

The fields to update on the file

application/json
  1. body
metadata?unknown
tags?array<string>
privacyLevel?string
Value in"private""sensitive""internal""public"
additionalInfo?unknown
folderId?|
Length24 <= length <= 24

Response Body

Updated file metadata

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
type*string
size*integer
Range-2147483648 <= value <= 2147483647
path*string
etag*string
organizationId*string
Lengthlength <= 24
uploaderId*string
Lengthlength <= 24
lastModified*|
Formatdate-time
projectId*|
Lengthlength <= 24
privacyLevel*string
Value in"private""sensitive""internal""public"
tags*array<string>|null
metadata*string|number|boolean|null||array<unknown>
additionalInfo*string|number|boolean|null||array<unknown>
origin*string
Value in"user_upload""workflow_generated"
originWorkflowId*|
Lengthlength <= 24
sourceFileId*|
Lengthlength <= 24
enrichmentStatus*|
Value in"pending""running""completed""failed"null
placeholder*string|null
contentHash*string|null
folderId*|
Lengthlength <= 24
curl -X PUT "https://example.com/v2/files/:fileId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "type": "string",  "size": -2147483648,  "path": "string",  "etag": "string",  "organizationId": "string",  "uploaderId": "string",  "lastModified": "2019-08-24T14:15:22Z",  "projectId": "string",  "privacyLevel": "private",  "tags": [    "string"  ],  "metadata": "string",  "additionalInfo": "string",  "origin": "user_upload",  "originWorkflowId": "string",  "sourceFileId": "string",  "enrichmentStatus": "pending",  "placeholder": "string",  "contentHash": "string",  "folderId": "string"}
DELETE
/v2/files/:fileId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

fileId*string
Formatcuid2

Response Body

Metadata of a file

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
type*string
size*integer
Range-2147483648 <= value <= 2147483647
path*string
etag*string
organizationId*string
Lengthlength <= 24
uploaderId*string
Lengthlength <= 24
lastModified*|
Formatdate-time
projectId*|
Lengthlength <= 24
privacyLevel*string
Value in"private""sensitive""internal""public"
tags*array<string>|null
metadata*string|number|boolean|null||array<unknown>
additionalInfo*string|number|boolean|null||array<unknown>
origin*string
Value in"user_upload""workflow_generated"
originWorkflowId*|
Lengthlength <= 24
sourceFileId*|
Lengthlength <= 24
enrichmentStatus*|
Value in"pending""running""completed""failed"null
placeholder*string|null
contentHash*string|null
folderId*|
Lengthlength <= 24
curl -X DELETE "https://example.com/v2/files/:fileId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "type": "string",  "size": -2147483648,  "path": "string",  "etag": "string",  "organizationId": "string",  "uploaderId": "string",  "lastModified": "2019-08-24T14:15:22Z",  "projectId": "string",  "privacyLevel": "private",  "tags": [    "string"  ],  "metadata": "string",  "additionalInfo": "string",  "origin": "user_upload",  "originWorkflowId": "string",  "sourceFileId": "string",  "enrichmentStatus": "pending",  "placeholder": "string",  "contentHash": "string",  "folderId": "string"}
GET
/v2/files/:fileId/download

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

fileId*string
Formatcuid2

Response Body

Content of a file

image/png
  1. response
curl -X GET "https://example.com/v2/files/:fileId/download"
{}
GET
/v2/files/:fileId/comments

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

fileId*string
Formatcuid2

Response Body

The list of comments

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/files/:fileId/comments"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "text": "string",    "image": "string",    "time": "string",    "edited": true,    "authorId": "string",    "projectId": "string",    "fileId": "string",    "workflowId": "string",    "parentCommentId": "string",    "authorName": "string"  }]
POST
/v2/files/:fileId/comments

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

fileId*string
Formatcuid2

Request Body

The comment metadata

application/json
  1. body
text*string
Length1 <= length
image?string|null
time?string|null
edited?boolean
parentCommentId?|
Length24 <= length <= 24

Response Body

The created comment

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
text*string
image*string|null
time*string|null
edited*boolean
authorId*string
Lengthlength <= 24
projectId*string
Lengthlength <= 24
fileId*|
Lengthlength <= 24
workflowId*|
Lengthlength <= 24
parentCommentId*|
Lengthlength <= 24
authorName*string
curl -X POST "https://example.com/v2/files/:fileId/comments" \  -H "Content-Type: application/json" \  -d '{    "text": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "text": "string",  "image": "string",  "time": "string",  "edited": true,  "authorId": "string",  "projectId": "string",  "fileId": "string",  "workflowId": "string",  "parentCommentId": "string",  "authorName": "string"}
GET
/v2/files/:fileId/workflows

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

fileId*string
Formatcuid2

Response Body

Workflows linked to the file

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/files/:fileId/workflows"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "pipelineId": "621ef2b0-ba1d-48e5-89dc-b778e6ed42fd",    "pipelineName": "string",    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",    "status": "in_progress",    "statusMessage": "string",    "n8nExecutionId": -2147483648,    "n8nWorkflowId": "string",    "n8nWorkflowName": "string",    "n8nWorkflowNameLong": "string",    "result": "string",    "aiInterpretation": "string",    "projectId": "string"  }]
GET
/v2/files/:fileId/presigned-url

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

fileId*string
Formatcuid2

Response Body

Presigned URL for the file

application/json
  1. response
url*string
Formaturi
curl -X GET "https://example.com/v2/files/:fileId/presigned-url"
{  "url": "http://example.com"}
PUT
/v2/folders/:folderId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

folderId*string
Formatcuid2

Request Body

The fields to update on the folder

application/json
  1. body
name?string
Length1 <= length <= 100
parentId?|
Length24 <= length <= 24

Response Body

Updated folder

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
organizationId*string
Lengthlength <= 24
projectId*string
Lengthlength <= 24
parentId*|
Lengthlength <= 24
createdById*string
Lengthlength <= 24
curl -X PUT "https://example.com/v2/folders/:folderId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "organizationId": "string",  "projectId": "string",  "parentId": "string",  "createdById": "string"}
DELETE
/v2/folders/:folderId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

folderId*string
Formatcuid2

Response Body

The deleted folder

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
organizationId*string
Lengthlength <= 24
projectId*string
Lengthlength <= 24
parentId*|
Lengthlength <= 24
createdById*string
Lengthlength <= 24
curl -X DELETE "https://example.com/v2/folders/:folderId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "organizationId": "string",  "projectId": "string",  "parentId": "string",  "createdById": "string"}
GET
/v2/invitations/:invitationId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

invitationId*string
Formatcuid2

Response Body

Invitation details

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
inviteeEmail*string
organizationId*string
Lengthlength <= 24
role*string
Value in"viewer""user""admin""superadmin"
status*string
Value in"pending""accepted""declined""expired"
expirationDate*string
Formatdate-time
organizationName*string
curl -X GET "https://example.com/v2/invitations/:invitationId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "inviteeEmail": "string",  "organizationId": "string",  "role": "viewer",  "status": "pending",  "expirationDate": "2019-08-24T14:15:22Z",  "organizationName": "string"}
DELETE
/v2/invitations/:invitationId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

invitationId*string
Formatcuid2

Response Body

The deleted invitation

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
inviteeEmail*string
organizationId*string
Lengthlength <= 24
role*string
Value in"viewer""user""admin""superadmin"
status*string
Value in"pending""accepted""declined""expired"
expirationDate*string
Formatdate-time
curl -X DELETE "https://example.com/v2/invitations/:invitationId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "inviteeEmail": "string",  "organizationId": "string",  "role": "viewer",  "status": "pending",  "expirationDate": "2019-08-24T14:15:22Z"}
POST
/v2/invitations/:invitationId/accept

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

invitationId*string
Formatcuid2

Response Body

The created membership after accepting the invitation

application/json
  1. response
id*|
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
userId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
role*string
Value in"viewer""user""admin""superadmin"
isDefault*boolean
curl -X POST "https://example.com/v2/invitations/:invitationId/accept"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "userId": "string",  "organizationId": "string",  "role": "viewer",  "isDefault": true}
GET
/v2/organizations

Authorization

openIdConnect
OpenID Connect<token>

Response Body

The list of organizations

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/organizations"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "description": "string",    "balance_cents": -2147483648,    "blocked_balance_cents": -2147483648,    "modules": [      "crowdsourcing"    ],    "logo": "string",    "logoPlaceholder": "string"  }]
POST
/v2/organizations

Authorization

openIdConnect
OpenID Connect<token>

Request Body

The organization to create

application/json
  1. body
name*string
Length3 <= length <= 50
description*string
Length1 <= length <= 50

Response Body

The created organization

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string
balance_cents*integer
Range-2147483648 <= value <= 2147483647
blocked_balance_cents*integer
Range-2147483648 <= value <= 2147483647
modules*array<>
logo*string|null
logoPlaceholder*string|null
curl -X POST "https://example.com/v2/organizations" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "description": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "balance_cents": -2147483648,  "blocked_balance_cents": -2147483648,  "modules": [    "crowdsourcing"  ],  "logo": "string",  "logoPlaceholder": "string"}
GET
/v2/organizations/:organizationId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Formatcuid2

Response Body

Metadata of an organization

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string
balance_cents*integer
Range-2147483648 <= value <= 2147483647
blocked_balance_cents*integer
Range-2147483648 <= value <= 2147483647
modules*array<>
logo*string|null
logoPlaceholder*string|null
curl -X GET "https://example.com/v2/organizations/:organizationId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "balance_cents": -2147483648,  "blocked_balance_cents": -2147483648,  "modules": [    "crowdsourcing"  ],  "logo": "string",  "logoPlaceholder": "string"}
PUT
/v2/organizations/:organizationId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Formatcuid2

Request Body

The organization fields to update

application/json
  1. body
name?string
Length3 <= length <= 50
description?string
Length1 <= length <= 50
modules?array<>

Response Body

The updated organization

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string
balance_cents*integer
Range-2147483648 <= value <= 2147483647
blocked_balance_cents*integer
Range-2147483648 <= value <= 2147483647
modules*array<>
logo*string|null
logoPlaceholder*string|null
curl -X PUT "https://example.com/v2/organizations/:organizationId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "balance_cents": -2147483648,  "blocked_balance_cents": -2147483648,  "modules": [    "crowdsourcing"  ],  "logo": "string",  "logoPlaceholder": "string"}
POST
/v2/organizations/:organizationId/invite

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Formatcuid2

Request Body

The invite to create

application/json
  1. body
inviteeEmail*string
Formatemail
role*string
Value in"viewer""user""admin""superadmin"

Response Body

Invitation

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
inviteeEmail*string
organizationId*string
Lengthlength <= 24
role*string
Value in"viewer""user""admin""superadmin"
status*string
Value in"pending""accepted""declined""expired"
expirationDate*string
Formatdate-time
curl -X POST "https://example.com/v2/organizations/:organizationId/invite" \  -H "Content-Type: application/json" \  -d '{    "inviteeEmail": "user@example.com",    "role": "viewer"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "inviteeEmail": "string",  "organizationId": "string",  "role": "viewer",  "status": "pending",  "expirationDate": "2019-08-24T14:15:22Z"}
PATCH
/v2/organizations/:organizationId/logo

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Formatcuid2

Request Body

multipart/form-data
  1. body
logo*file
Formatbinary

Response Body

Updated organization with logo

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string
balance_cents*integer
Range-2147483648 <= value <= 2147483647
blocked_balance_cents*integer
Range-2147483648 <= value <= 2147483647
modules*array<>
logo*string|null
logoPlaceholder*string|null
curl -X PATCH "https://example.com/v2/organizations/:organizationId/logo" \  -F logo="string"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "balance_cents": -2147483648,  "blocked_balance_cents": -2147483648,  "modules": [    "crowdsourcing"  ],  "logo": "string",  "logoPlaceholder": "string"}
PATCH
/v2/organizations/:organizationId/members/:userId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Length24 <= length <= 24
userId*string
Length24 <= length <= 24

Request Body

New role for the member

application/json
  1. body
role*string
Value in"viewer""user""admin"

Response Body

Updated membership

application/json
  1. response
id*|
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
userId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
role*string
Value in"viewer""user""admin""superadmin"
isDefault*boolean
curl -X PATCH "https://example.com/v2/organizations/:organizationId/members/:userId" \  -H "Content-Type: application/json" \  -d '{    "role": "viewer"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "userId": "string",  "organizationId": "string",  "role": "viewer",  "isDefault": true}
GET
/v2/organizations/:organizationId/billing

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Formatcuid2

Response Body

The billing info

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
organizationId*string
Lengthlength <= 24
companyName*string|null
companyEmail*string|null
companyContactSalutation*|
Lengthlength <= 25
companyContactFirstName*string|null
companyContactLastName*string|null
companyTaxNumber*string|null
companyVatRegistrationId*string|null
personSalutation*|
Lengthlength <= 25
personFirstName*string|null
personLastName*string|null
email*string
phoneNumber*string
billingSupplement*string|null
billingStreet*string
billingZip*string
billingCity*string
billingCountryCode*string
shippingSupplement*string|null
shippingStreet*string
shippingZip*string
shippingCity*string
shippingCountryCode*string
type*string
Value in"company""person"
version*integer
Range-2147483648 <= value <= 2147483647
isComplete*boolean
curl -X GET "https://example.com/v2/organizations/:organizationId/billing"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "string",  "companyName": "string",  "companyEmail": "string",  "companyContactSalutation": "string",  "companyContactFirstName": "string",  "companyContactLastName": "string",  "companyTaxNumber": "string",  "companyVatRegistrationId": "string",  "personSalutation": "string",  "personFirstName": "string",  "personLastName": "string",  "email": "string",  "phoneNumber": "string",  "billingSupplement": "string",  "billingStreet": "string",  "billingZip": "string",  "billingCity": "string",  "billingCountryCode": "string",  "shippingSupplement": "string",  "shippingStreet": "string",  "shippingZip": "string",  "shippingCity": "string",  "shippingCountryCode": "string",  "type": "company",  "version": -2147483648,  "isComplete": true}
POST
/v2/organizations/:organizationId/billing

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Formatcuid2

Request Body

The billing info to create for this organization

application/json
  1. body
companyName?string|null
companyEmail?string|null
companyContactSalutation?|
Lengthlength <= 25
companyContactFirstName?string|null
companyContactLastName?string|null
companyTaxNumber?string|null
companyVatRegistrationId?string|null
personSalutation*string
Lengthlength <= 25
personFirstName*string
Length1 <= length
personLastName*string
Length1 <= length
email*string
phoneNumber*string
billingSupplement?string|null
billingStreet*string
billingZip*string
billingCity*string
billingCountryCode*string
shippingSupplement?string|null
shippingStreet*string
shippingZip*string
shippingCity*string
shippingCountryCode*string
type*"person"
Value in"person"

Response Body

The created billing info

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
organizationId*string
Lengthlength <= 24
companyName*string|null
companyEmail*string|null
companyContactSalutation*|
Lengthlength <= 25
companyContactFirstName*string|null
companyContactLastName*string|null
companyTaxNumber*string|null
companyVatRegistrationId*string|null
personSalutation*|
Lengthlength <= 25
personFirstName*string|null
personLastName*string|null
email*string
phoneNumber*string
billingSupplement*string|null
billingStreet*string
billingZip*string
billingCity*string
billingCountryCode*string
shippingSupplement*string|null
shippingStreet*string
shippingZip*string
shippingCity*string
shippingCountryCode*string
type*string
Value in"company""person"
version*integer
Range-2147483648 <= value <= 2147483647
isComplete*boolean
curl -X POST "https://example.com/v2/organizations/:organizationId/billing" \  -H "Content-Type: application/json" \  -d '{    "personSalutation": "string",    "personFirstName": "string",    "personLastName": "string",    "email": "string",    "phoneNumber": "string",    "billingStreet": "string",    "billingZip": "string",    "billingCity": "string",    "billingCountryCode": "string",    "shippingStreet": "string",    "shippingZip": "string",    "shippingCity": "string",    "shippingCountryCode": "string",    "type": "person"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "string",  "companyName": "string",  "companyEmail": "string",  "companyContactSalutation": "string",  "companyContactFirstName": "string",  "companyContactLastName": "string",  "companyTaxNumber": "string",  "companyVatRegistrationId": "string",  "personSalutation": "string",  "personFirstName": "string",  "personLastName": "string",  "email": "string",  "phoneNumber": "string",  "billingSupplement": "string",  "billingStreet": "string",  "billingZip": "string",  "billingCity": "string",  "billingCountryCode": "string",  "shippingSupplement": "string",  "shippingStreet": "string",  "shippingZip": "string",  "shippingCity": "string",  "shippingCountryCode": "string",  "type": "company",  "version": -2147483648,  "isComplete": true}
PUT
/v2/organizations/:organizationId/billing

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Formatcuid2

Request Body

The billing info fields to update for this organization

application/json
  1. body
companyName?string|null
companyEmail?string|null
companyContactSalutation?|
Lengthlength <= 25
companyContactFirstName?string|null
companyContactLastName?string|null
companyTaxNumber?string|null
companyVatRegistrationId?string|null
personSalutation?string
Lengthlength <= 25
personFirstName?string
Length1 <= length
personLastName?string
Length1 <= length
email?string
phoneNumber?string
billingSupplement?string|null
billingStreet?string
billingZip?string
billingCity?string
billingCountryCode?string
shippingSupplement?string|null
shippingStreet?string
shippingZip?string
shippingCity?string
shippingCountryCode?string
type*"person"
Value in"person"

Response Body

The updated billing info

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
organizationId*string
Lengthlength <= 24
companyName*string|null
companyEmail*string|null
companyContactSalutation*|
Lengthlength <= 25
companyContactFirstName*string|null
companyContactLastName*string|null
companyTaxNumber*string|null
companyVatRegistrationId*string|null
personSalutation*|
Lengthlength <= 25
personFirstName*string|null
personLastName*string|null
email*string
phoneNumber*string
billingSupplement*string|null
billingStreet*string
billingZip*string
billingCity*string
billingCountryCode*string
shippingSupplement*string|null
shippingStreet*string
shippingZip*string
shippingCity*string
shippingCountryCode*string
type*string
Value in"company""person"
version*integer
Range-2147483648 <= value <= 2147483647
isComplete*boolean
curl -X PUT "https://example.com/v2/organizations/:organizationId/billing" \  -H "Content-Type: application/json" \  -d '{    "type": "person"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "string",  "companyName": "string",  "companyEmail": "string",  "companyContactSalutation": "string",  "companyContactFirstName": "string",  "companyContactLastName": "string",  "companyTaxNumber": "string",  "companyVatRegistrationId": "string",  "personSalutation": "string",  "personFirstName": "string",  "personLastName": "string",  "email": "string",  "phoneNumber": "string",  "billingSupplement": "string",  "billingStreet": "string",  "billingZip": "string",  "billingCity": "string",  "billingCountryCode": "string",  "shippingSupplement": "string",  "shippingStreet": "string",  "shippingZip": "string",  "shippingCity": "string",  "shippingCountryCode": "string",  "type": "company",  "version": -2147483648,  "isComplete": true}
GET
/v2/organizations/:organizationId/users

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Formatcuid2

Response Body

the users of the organization

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/organizations/:organizationId/users"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "sub": "string",    "name": "string",    "email": "string",    "avatar": "string",    "avatarPlaceholder": "string",    "organizationId": "string",    "role": "viewer",    "isSuperadmin": true,    "createdVia": "signup",    "locale": "string",    "timezone": "string"  }]
GET
/v2/organizations/:organizationId/invitations

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Formatcuid2

Response Body

the users of the organization

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/organizations/:organizationId/invitations"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "inviteeEmail": "string",    "organizationId": "string",    "role": "viewer",    "status": "pending",    "expirationDate": "2019-08-24T14:15:22Z"  }]
POST
/v2/paypal/:id/create-order

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

id*string
Length24 <= length <= 24

Response Body

Created PayPal order

application/json
  1. response
orderId*string
Length5 <= length
curl -X POST "https://example.com/v2/paypal/:id/create-order"
{  "orderId": "string"}
POST
/v2/paypal/:id/capture

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

id*string
Length24 <= length <= 24

Response Body

Captured and confirmed

application/json
  1. response
ok*boolean
curl -X POST "https://example.com/v2/paypal/:id/capture"
{  "ok": true}
GET
/v2/projects

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

type?string
Value in"standard""research"
status?string
Value in"active""archived"

Response Body

The list of projects

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/projects"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "description": "string",    "organizationId": "string",    "type": "standard",    "status": "active"  }]
POST
/v2/projects

Authorization

openIdConnect
OpenID Connect<token>

Request Body

The project metadata

application/json
  1. body
name*string
Length3 <= length <= 50
description*string
Length1 <= length <= 50
type?string
Value in"standard""research"
status?string
Value in"active""archived"

Response Body

The created project

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string
organizationId*string
Lengthlength <= 24
type*string
Value in"standard""research"
status*string
Value in"active""archived"
curl -X POST "https://example.com/v2/projects" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "description": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "organizationId": "string",  "type": "standard",  "status": "active"}
GET
/v2/projects/progress

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Per-project progress for every project in the active organization

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/projects/progress"
[  {    "projectId": "string",    "completed": 0,    "total": 0  }]
GET
/v2/projects/stats

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Org-wide file and crowd-answer totals for the projects list page

application/json
  1. response
totalProjects*number
activeProjects*number
totalFiles*number
totalCrowdAnswers*number
curl -X GET "https://example.com/v2/projects/stats"
{  "totalProjects": 0,  "activeProjects": 0,  "totalFiles": 0,  "totalCrowdAnswers": 0}
GET
/v2/projects/:projectId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

Metadata of the project

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string
organizationId*string
Lengthlength <= 24
type*string
Value in"standard""research"
status*string
Value in"active""archived"
curl -X GET "https://example.com/v2/projects/:projectId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "organizationId": "string",  "type": "standard",  "status": "active"}
PUT
/v2/projects/:projectId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Request Body

The updated project data

application/json
  1. body
name?string
Length3 <= length <= 50
description?string
Length1 <= length <= 50
type?string
Value in"standard""research"
status?string
Value in"active""archived"

Response Body

The updated project

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string
organizationId*string
Lengthlength <= 24
type*string
Value in"standard""research"
status*string
Value in"active""archived"
curl -X PUT "https://example.com/v2/projects/:projectId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "organizationId": "string",  "type": "standard",  "status": "active"}
DELETE
/v2/projects/:projectId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

Metadata of the deleted project

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string
organizationId*string
Lengthlength <= 24
type*string
Value in"standard""research"
status*string
Value in"active""archived"
curl -X DELETE "https://example.com/v2/projects/:projectId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "organizationId": "string",  "type": "standard",  "status": "active"}
PATCH
/v2/projects/:projectId/archive

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

The archived project

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string
organizationId*string
Lengthlength <= 24
type*string
Value in"standard""research"
status*string
Value in"active""archived"
curl -X PATCH "https://example.com/v2/projects/:projectId/archive"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "organizationId": "string",  "type": "standard",  "status": "active"}
PATCH
/v2/projects/:projectId/restore

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

The restored project

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string
organizationId*string
Lengthlength <= 24
type*string
Value in"standard""research"
status*string
Value in"active""archived"
curl -X PATCH "https://example.com/v2/projects/:projectId/restore"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "organizationId": "string",  "type": "standard",  "status": "active"}
GET
/v2/projects/:projectId/workflows

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Query Parameters

pipelineId?string
Formatuuid

Response Body

The list of workflows

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/projects/:projectId/workflows"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "pipelineId": "621ef2b0-ba1d-48e5-89dc-b778e6ed42fd",    "pipelineName": "string",    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",    "status": "in_progress",    "statusMessage": "string",    "n8nExecutionId": -2147483648,    "n8nWorkflowId": "string",    "n8nWorkflowName": "string",    "n8nWorkflowNameLong": "string",    "result": "string",    "aiInterpretation": "string",    "projectId": "string"  }]
POST
/v2/projects/:projectId/workflows

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Request Body

The workflow metadata

application/json
  1. body
pipelineId*string
Formatuuid
pipelineName*string
uuid*string
Formatuuid
n8nExecutionId*integer
Range1 <= value <= 2147483647
n8nWorkflowId*string
Length5 <= length <= 100
n8nWorkflowName*string
Length5 <= length <= 100
n8nWorkflowNameLong*string
Length5 <= length <= 100
fileIds*array<>

Response Body

The created workflow

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
pipelineId*string
Formatuuid
pipelineName*string
uuid*string
Formatuuid
status*string
Value in"in_progress""finished""no_result""error"
statusMessage*string|null
n8nExecutionId*integer
Range-2147483648 <= value <= 2147483647
n8nWorkflowId*string
n8nWorkflowName*string
n8nWorkflowNameLong*string
result*string|null
aiInterpretation*string|null
projectId*string
Lengthlength <= 24
curl -X POST "https://example.com/v2/projects/:projectId/workflows" \  -H "Content-Type: application/json" \  -d '{    "pipelineId": "621ef2b0-ba1d-48e5-89dc-b778e6ed42fd",    "pipelineName": "string",    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",    "n8nExecutionId": 1,    "n8nWorkflowId": "string",    "n8nWorkflowName": "string",    "n8nWorkflowNameLong": "string",    "fileIds": [      "stringstringstringstring"    ]  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "pipelineId": "621ef2b0-ba1d-48e5-89dc-b778e6ed42fd",  "pipelineName": "string",  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",  "status": "in_progress",  "statusMessage": "string",  "n8nExecutionId": -2147483648,  "n8nWorkflowId": "string",  "n8nWorkflowName": "string",  "n8nWorkflowNameLong": "string",  "result": "string",  "aiInterpretation": "string",  "projectId": "string"}
GET
/v2/projects/:projectId/files

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

List of files belonging to the project

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/projects/:projectId/files"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "type": "string",    "size": -2147483648,    "path": "string",    "etag": "string",    "organizationId": "string",    "uploaderId": "string",    "lastModified": "2019-08-24T14:15:22Z",    "projectId": "string",    "privacyLevel": "private",    "tags": [      "string"    ],    "metadata": "string",    "additionalInfo": "string",    "origin": "user_upload",    "originWorkflowId": "string",    "sourceFileId": "string",    "enrichmentStatus": "pending",    "placeholder": "string",    "contentHash": "string",    "folderId": "string"  }]
POST
/v2/projects/:projectId/files

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Request Body

multipart/form-data
  1. body
file[]*|
folderId?string
Length24 <= length <= 24

Response Body

Upload one or multiple files

application/json
  1. response
[index: integer]?
curl -X POST "https://example.com/v2/projects/:projectId/files" \  -F file[]="string"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "type": "string",    "size": -2147483648,    "path": "string",    "etag": "string",    "organizationId": "string",    "uploaderId": "string",    "lastModified": "2019-08-24T14:15:22Z",    "projectId": "string",    "privacyLevel": "private",    "tags": [      "string"    ],    "metadata": "string",    "additionalInfo": "string",    "origin": "user_upload",    "originWorkflowId": "string",    "sourceFileId": "string",    "enrichmentStatus": "pending",    "placeholder": "string",    "contentHash": "string",    "folderId": "string"  }]
GET
/v2/projects/:projectId/comments

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

The list of comments

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/projects/:projectId/comments"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "text": "string",    "image": "string",    "time": "string",    "edited": true,    "authorId": "string",    "projectId": "string",    "fileId": "string",    "workflowId": "string",    "parentCommentId": "string",    "authorName": "string"  }]
GET
/v2/projects/:projectId/folders

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

List of folders belonging to the project

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/projects/:projectId/folders"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "organizationId": "string",    "projectId": "string",    "parentId": "string",    "createdById": "string"  }]
POST
/v2/projects/:projectId/folders

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Request Body

The folder to create

application/json
  1. body
name*string
Length1 <= length <= 100
parentId?|
Length24 <= length <= 24

Response Body

The created folder

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
organizationId*string
Lengthlength <= 24
projectId*string
Lengthlength <= 24
parentId*|
Lengthlength <= 24
createdById*string
Lengthlength <= 24
curl -X POST "https://example.com/v2/projects/:projectId/folders" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "organizationId": "string",  "projectId": "string",  "parentId": "string",  "createdById": "string"}
GET
/v2/projects/:projectId/jobs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

The list of jobs

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/projects/:projectId/jobs"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "title": "string",    "description": "string",    "status": "assignable",    "category": "survey",    "language": "en",    "surveyTemplateVersionId": "string",    "inputDataSetId": "string",    "maxAssignments": -32768,    "maxRepetitionsPerVariant": -2147483648,    "maxWorkTimeMinutes": -2147483648,    "rewardCredits": -9007199254740991,    "creditsBlocked": -9007199254740991,    "platformFeeBlocked": -9007199254740991,    "validFrom": "2019-08-24T14:15:22Z",    "validUntil": "2019-08-24T14:15:22Z",    "qualificationRequirements": "string",    "requiredPanelIds": [      "string"    ],    "verificationCode": "string",    "autoAcceptHours": -2147483648,    "forceUniqueTasks": true,    "isDryRun": true,    "dryRunAllowedEmails": [      "string"    ],    "dryRunMagicToken": "string",    "projectId": "string",    "createdById": "string",    "watcherUserIds": [      "string"    ],    "reviewerUserIds": [      "string"    ],    "noTasksReviewerNotifiedAt": "2019-08-24T14:15:22Z"  }]
POST
/v2/projects/:projectId/jobs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Request Body

The job metadata

application/json
  1. body
name*string
Length3 <= length <= 100
title*string
Length3 <= length <= 200
description*string
Length3 <= length <= 5000
category*string
Value in"survey""qualification_test""gathering"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
surveyTemplateVersionId*string
Lengthlength <= 24
inputDataSetId?|
Lengthlength <= 24
maxAssignments?integer
Range1 <= value <= 10000
maxRepetitionsPerVariant?integer
Range1 <= value <= 10000
maxWorkTimeMinutes?|
Range1 <= value <= 1440
rewardCredits?integer
Range0 <= value <= 100000
validFrom?|
Formatdate-time
validUntil?|
Formatdate-time
qualificationRequirements?|null
requiredPanelIds?array<>
Itemsitems <= 20
verificationCode?string|null
forceUniqueTasks?boolean
isDryRun?boolean
dryRunAllowedEmails?array<string>
dryRunMagicToken?string|null
watcherUserIds?array<>
Itemsitems <= 50
reviewerUserIds?array<>
Itemsitems <= 50
noTasksReviewerNotifiedAt?|
Formatdate-time

Response Body

The created job

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
title*string
description*string
status*string
Value in"assignable""not_assignable""no_tasks""finished""archived""paused"
category*string
Value in"survey""qualification_test""gathering"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
surveyTemplateVersionId*string
Lengthlength <= 24
inputDataSetId*|
Lengthlength <= 24
maxAssignments*integer
Range-32768 <= value <= 32767
maxRepetitionsPerVariant*integer
Range-2147483648 <= value <= 2147483647
maxWorkTimeMinutes*|
Range-2147483648 <= value <= 2147483647
rewardCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
creditsBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
platformFeeBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
validFrom*|
Formatdate-time
validUntil*|
Formatdate-time
qualificationRequirements*string|number|boolean|null||array<unknown>
requiredPanelIds*array<>
verificationCode*string|null
autoAcceptHours*|
Range-2147483648 <= value <= 2147483647
forceUniqueTasks*boolean
isDryRun*boolean
dryRunAllowedEmails*array<string>
dryRunMagicToken*string|null
projectId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
watcherUserIds*array<>
reviewerUserIds*array<>
noTasksReviewerNotifiedAt*|
Formatdate-time
curl -X POST "https://example.com/v2/projects/:projectId/jobs" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "title": "string",    "description": "string",    "category": "survey",    "language": "en",    "surveyTemplateVersionId": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "title": "string",  "description": "string",  "status": "assignable",  "category": "survey",  "language": "en",  "surveyTemplateVersionId": "string",  "inputDataSetId": "string",  "maxAssignments": -32768,  "maxRepetitionsPerVariant": -2147483648,  "maxWorkTimeMinutes": -2147483648,  "rewardCredits": -9007199254740991,  "creditsBlocked": -9007199254740991,  "platformFeeBlocked": -9007199254740991,  "validFrom": "2019-08-24T14:15:22Z",  "validUntil": "2019-08-24T14:15:22Z",  "qualificationRequirements": "string",  "requiredPanelIds": [    "string"  ],  "verificationCode": "string",  "autoAcceptHours": -2147483648,  "forceUniqueTasks": true,  "isDryRun": true,  "dryRunAllowedEmails": [    "string"  ],  "dryRunMagicToken": "string",  "projectId": "string",  "createdById": "string",  "watcherUserIds": [    "string"  ],  "reviewerUserIds": [    "string"  ],  "noTasksReviewerNotifiedAt": "2019-08-24T14:15:22Z"}
GET
/v2/projects/:projectId/dossier

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

The dossier of workflows grouped by pipelineId

application/json
  1. response
[index: integer]?array<any>
curl -X GET "https://example.com/v2/projects/:projectId/dossier"
[  [    "string",    [      {        "id": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "pipelineId": "621ef2b0-ba1d-48e5-89dc-b778e6ed42fd",        "pipelineName": "string",        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",        "status": "in_progress",        "statusMessage": "string",        "n8nExecutionId": -2147483648,        "n8nWorkflowId": "string",        "n8nWorkflowName": "string",        "n8nWorkflowNameLong": "string",        "result": "string",        "aiInterpretation": "string",        "projectId": "string"      }    ]  ]]
GET
/v2/projects/:projectId/survey-templates

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

Survey templates for this project

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/projects/:projectId/survey-templates"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "description": "string",    "scope": "project",    "language": "en",    "projectId": "string",    "organizationId": "string",    "latestVersion": {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "templateId": "string",      "versionNumber": -2147483648,      "surveyJs": "string",      "authorId": "string"    }  }]
POST
/v2/projects/:projectId/survey-templates

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Request Body

New survey template with initial content

application/json
  1. body
name*string
description?string|null
scope?string
Value in"project""organization""public"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
surveyJs*

Response Body

Created survey template

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string|null
scope*string
Value in"project""organization""public"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
latestVersion*|null
curl -X POST "https://example.com/v2/projects/:projectId/survey-templates" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "language": "en",    "surveyJs": {      "property1": null,      "property2": null    }  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "scope": "project",  "language": "en",  "projectId": "string",  "organizationId": "string",  "latestVersion": {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "templateId": "string",    "versionNumber": -2147483648,    "surveyJs": "string",    "authorId": "string"  }}
GET
/v2/projects/:projectId/verification-contexts

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

Verification contexts for this project

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/projects/:projectId/verification-contexts"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "description": "string",    "projectId": "string",    "organizationId": "string",    "contextData": "string",    "isDefault": true  }]
POST
/v2/projects/:projectId/verification-contexts

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Request Body

New verification context

application/json
  1. body
name*string
description?string|null
contextData*
isDefault?boolean

Response Body

Created verification context

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string|null
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
contextData*string|number|boolean|null||array<unknown>
isDefault*boolean
curl -X POST "https://example.com/v2/projects/:projectId/verification-contexts" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "contextData": {      "property1": null,      "property2": null    }  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "projectId": "string",  "organizationId": "string",  "contextData": "string",  "isDefault": true}
GET
/v2/projects/:projectId/input-data

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

Input data sets for this project

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/projects/:projectId/input-data"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "description": "string",    "scope": "project",    "language": "en",    "projectId": "string",    "organizationId": "string",    "uploaderId": "string"  }]
POST
/v2/projects/:projectId/input-data

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Request Body

New input data set with lists and optional groups

application/json
  1. body
name*string
description?string|null
scope?string
Value in"project""organization"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
lists*array<>
Items1 <= items
groups?array<>

Response Body

Created input data set

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string|null
scope*string
Value in"project""organization"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
uploaderId*|
Lengthlength <= 24
lists*array<>
groups*array<>
curl -X POST "https://example.com/v2/projects/:projectId/input-data" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "language": "en",    "lists": [      {        "name": "string",        "values": [          "string"        ]      }    ]  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "scope": "project",  "language": "en",  "projectId": "string",  "organizationId": "string",  "uploaderId": "string",  "lists": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "name": "string",      "values": "string",      "dataSetId": "string"    }  ],  "groups": [    {      "id": "string",      "name": "string",      "lists": [        {          "id": "string",          "name": "string",          "values": "string"        }      ]    }  ]}
POST
/v2/projects/:projectId/input-data/from-csv

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Request Body

multipart/form-data
  1. body
file*file
Formatbinary
description?string
scope?string
Value in"project""organization"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"

Response Body

Created input data set from CSV

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string|null
scope*string
Value in"project""organization"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
uploaderId*|
Lengthlength <= 24
lists*array<>
groups*array<>
curl -X POST "https://example.com/v2/projects/:projectId/input-data/from-csv" \  -F file="string" \  -F language="en"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "scope": "project",  "language": "en",  "projectId": "string",  "organizationId": "string",  "uploaderId": "string",  "lists": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "name": "string",      "values": "string",      "dataSetId": "string"    }  ],  "groups": [    {      "id": "string",      "name": "string",      "lists": [        {          "id": "string",          "name": "string",          "values": "string"        }      ]    }  ]}
GET
/v2/projects/:projectId/pipeline-runs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

Pipeline runs for this project

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/projects/:projectId/pipeline-runs"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "pipelineSlug": "string",    "fileId": "string",    "projectId": "string",    "organizationId": "string",    "status": "pending",    "jobId": "string",    "result": "string",    "error": "string"  }]
POST
/v2/projects/:projectId/run-pipeline

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Request Body

Pipeline run request

application/json
  1. body
pipelineSlug*string
Length1 <= length <= 100
fileIds*array<>
Items1 <= items <= 50
contextId?string
Length24 <= length <= 24

Response Body

Created pipeline runs

application/json
  1. response
runs*array<>
curl -X POST "https://example.com/v2/projects/:projectId/run-pipeline" \  -H "Content-Type: application/json" \  -d '{    "pipelineSlug": "string",    "fileIds": [      "stringstringstringstring"    ]  }'
{  "runs": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "pipelineSlug": "string",      "fileId": "string",      "projectId": "string",      "organizationId": "string",      "status": "pending",      "jobId": "string",      "result": "string",      "error": "string"    }  ]}
POST
/v2/projects/:projectId/files/:fileId/enrichment/retry

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Length24 <= length <= 24
fileId*string
Length24 <= length <= 24

Response Body

Enrichment re-queued

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
pipelineSlug*string
fileId*string
Lengthlength <= 24
projectId*|
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
status*string
Value in"pending""running""completed""failed"
jobId*string|null
result*string|number|boolean|null||array<unknown>
error*string|null
curl -X POST "https://example.com/v2/projects/:projectId/files/:fileId/enrichment/retry"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "pipelineSlug": "string",  "fileId": "string",  "projectId": "string",  "organizationId": "string",  "status": "pending",  "jobId": "string",  "result": "string",  "error": "string"}
GET
/v2/projects/:projectId/verification-runs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Query Parameters

status?string
Value in"pending""running""awaiting_crowd""completed""failed"

Response Body

List of verification runs for the project

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/projects/:projectId/verification-runs"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "pipelineSlug": "string",    "projectId": "string",    "organizationId": "string",    "contextId": "string",    "contextDataSnapshot": "string",    "status": "pending",    "jobId": "string",    "verdict": "authentic",    "confidence": "string",    "scorecard": "string",    "explanation": "string",    "report": "string",    "error": "string",    "files": [      {        "id": "string",        "name": "string",        "type": "string",        "role": "string"      }    ],    "stages": [      {        "id": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "verificationPipelineRunId": "string",        "stageSlug": "string",        "stageName": "string",        "stageType": "ai",        "stageOrder": -2147483648,        "status": "pending",        "verdict": "authentic",        "confidence": "string",        "stageReport": "string",        "artifacts": "string",        "crowdJobId": "string",        "jobId": "string",        "minResponses": -2147483648,        "consensusThreshold": "string",        "startedAt": "2019-08-24T14:15:22Z",        "completedAt": "2019-08-24T14:15:22Z",        "error": "string"      }    ]  }]
POST
/v2/projects/:projectId/verification-runs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Request Body

Verification run request

application/json
  1. body
pipelineSlug*string
Length1 <= length <= 100
fileIds*array<>
Itemsitems <= 50
contextId?string
Length24 <= length <= 24
contextData?

Response Body

Created verification pipeline run

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
pipelineSlug*string
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
contextId*|
Lengthlength <= 24
contextDataSnapshot*string|number|boolean|null||array<unknown>
status*string
Value in"pending""running""awaiting_crowd""completed""failed"
jobId*string|null
verdict*|
Value in"authentic""manipulated""synthetic""inconclusive""unverified"null
confidence*string|null
scorecard*string|number|boolean|null||array<unknown>
explanation*string|null
report*string|null
error*string|null
files*array<>
stages?array<>
curl -X POST "https://example.com/v2/projects/:projectId/verification-runs" \  -H "Content-Type: application/json" \  -d '{    "pipelineSlug": "string",    "fileIds": [      "stringstringstringstring"    ]  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "pipelineSlug": "string",  "projectId": "string",  "organizationId": "string",  "contextId": "string",  "contextDataSnapshot": "string",  "status": "pending",  "jobId": "string",  "verdict": "authentic",  "confidence": "string",  "scorecard": "string",  "explanation": "string",  "report": "string",  "error": "string",  "files": [    {      "id": "string",      "name": "string",      "type": "string",      "role": "string"    }  ],  "stages": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "verificationPipelineRunId": "string",      "stageSlug": "string",      "stageName": "string",      "stageType": "ai",      "stageOrder": -2147483648,      "status": "pending",      "verdict": "authentic",      "confidence": "string",      "stageReport": "string",      "artifacts": "string",      "crowdJobId": "string",      "jobId": "string",      "minResponses": -2147483648,      "consensusThreshold": "string",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "error": "string"    }  ]}
GET
/v2/projects/:projectId/verification-runs/:runId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Length24 <= length <= 24
runId*string
Length24 <= length <= 24

Response Body

Verification run with stage details

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
pipelineSlug*string
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
contextId*|
Lengthlength <= 24
contextDataSnapshot*string|number|boolean|null||array<unknown>
status*string
Value in"pending""running""awaiting_crowd""completed""failed"
jobId*string|null
verdict*|
Value in"authentic""manipulated""synthetic""inconclusive""unverified"null
confidence*string|null
scorecard*string|number|boolean|null||array<unknown>
explanation*string|null
report*string|null
error*string|null
files*array<>
stages?array<>
curl -X GET "https://example.com/v2/projects/:projectId/verification-runs/:runId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "pipelineSlug": "string",  "projectId": "string",  "organizationId": "string",  "contextId": "string",  "contextDataSnapshot": "string",  "status": "pending",  "jobId": "string",  "verdict": "authentic",  "confidence": "string",  "scorecard": "string",  "explanation": "string",  "report": "string",  "error": "string",  "files": [    {      "id": "string",      "name": "string",      "type": "string",      "role": "string"    }  ],  "stages": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "verificationPipelineRunId": "string",      "stageSlug": "string",      "stageName": "string",      "stageType": "ai",      "stageOrder": -2147483648,      "status": "pending",      "verdict": "authentic",      "confidence": "string",      "stageReport": "string",      "artifacts": "string",      "crowdJobId": "string",      "jobId": "string",      "minResponses": -2147483648,      "consensusThreshold": "string",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "error": "string"    }  ]}
POST
/v2/projects/:projectId/verification-runs/:runId/restart

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Length24 <= length <= 24
runId*string
Length24 <= length <= 24

Response Body

Restarted verification run

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
pipelineSlug*string
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
contextId*|
Lengthlength <= 24
contextDataSnapshot*string|number|boolean|null||array<unknown>
status*string
Value in"pending""running""awaiting_crowd""completed""failed"
jobId*string|null
verdict*|
Value in"authentic""manipulated""synthetic""inconclusive""unverified"null
confidence*string|null
scorecard*string|number|boolean|null||array<unknown>
explanation*string|null
report*string|null
error*string|null
files*array<>
stages?array<>
curl -X POST "https://example.com/v2/projects/:projectId/verification-runs/:runId/restart"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "pipelineSlug": "string",  "projectId": "string",  "organizationId": "string",  "contextId": "string",  "contextDataSnapshot": "string",  "status": "pending",  "jobId": "string",  "verdict": "authentic",  "confidence": "string",  "scorecard": "string",  "explanation": "string",  "report": "string",  "error": "string",  "files": [    {      "id": "string",      "name": "string",      "type": "string",      "role": "string"    }  ],  "stages": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "verificationPipelineRunId": "string",      "stageSlug": "string",      "stageName": "string",      "stageType": "ai",      "stageOrder": -2147483648,      "status": "pending",      "verdict": "authentic",      "confidence": "string",      "stageReport": "string",      "artifacts": "string",      "crowdJobId": "string",      "jobId": "string",      "minResponses": -2147483648,      "consensusThreshold": "string",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "error": "string"    }  ]}
GET
/v2/transactions

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

status?string
Value in"pending""succeeded""failed""canceled"
type?string
Value in"charge""refund"
limit?integer
Range1 <= value <= 200
Default50
offset?|
Range0 <= value
Default0

Response Body

List of transactions

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/transactions"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "organizationId": "string",    "userId": "string",    "type": "charge",    "status": "pending",    "currency": "str",    "amountCents": -2147483648,    "taxCents": -2147483648,    "idempotencyKey": "string",    "provider": "mock_paypal",    "providerTransactionId": "string",    "reference": "string",    "description": "string",    "metadata": "string"  }]
GET
/v2/transactions/balance

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Organization balance

application/json
  1. response
balanceCents*integer
curl -X GET "https://example.com/v2/transactions/balance"
{  "balanceCents": 0}
GET
/v2/transactions/:transactionId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

transactionId*string
Length24 <= length <= 24

Response Body

A transaction

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
organizationId*string
Lengthlength <= 24
userId*string
Lengthlength <= 24
type*string
Value in"charge""refund"
status*string
Value in"pending""succeeded""failed""canceled"
currency*string
Lengthlength <= 3
amountCents*integer
Range-2147483648 <= value <= 2147483647
taxCents*integer
Range-2147483648 <= value <= 2147483647
idempotencyKey*|
Lengthlength <= 64
provider*|
Value in"mock_paypal""paypal"null
providerTransactionId*string|null
reference*string|null
description*string|null
metadata*string|number|boolean|null||array<unknown>
curl -X GET "https://example.com/v2/transactions/:transactionId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "string",  "userId": "string",  "type": "charge",  "status": "pending",  "currency": "str",  "amountCents": -2147483648,  "taxCents": -2147483648,  "idempotencyKey": "string",  "provider": "mock_paypal",  "providerTransactionId": "string",  "reference": "string",  "description": "string",  "metadata": "string"}
POST
/v2/transactions/charge

Authorization

openIdConnect
OpenID Connect<token>

Request Body

Charge request

application/json
  1. body
amountCents*integer
Range100 <= value <= 500000
currency?"EUR"
Default"EUR"
Value in"EUR"
description?string
Lengthlength <= 200
idempotencyKey?string
Length8 <= length <= 64

Response Body

Charge started

application/json
  1. response
transactionId*string
Length24 <= length <= 24
redirectUrl*string
Length1 <= length
curl -X POST "https://example.com/v2/transactions/charge" \  -H "Content-Type: application/json" \  -d '{    "amountCents": 100  }'
{  "transactionId": "stringstringstringstring",  "redirectUrl": "string"}
POST
/v2/transactions/:transactionId/confirm

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

transactionId*string
Length24 <= length <= 24

Response Body

Charge confirmed (or already confirmed)

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
organizationId*string
Lengthlength <= 24
userId*string
Lengthlength <= 24
type*string
Value in"charge""refund"
status*string
Value in"pending""succeeded""failed""canceled"
currency*string
Lengthlength <= 3
amountCents*integer
Range-2147483648 <= value <= 2147483647
taxCents*integer
Range-2147483648 <= value <= 2147483647
idempotencyKey*|
Lengthlength <= 64
provider*|
Value in"mock_paypal""paypal"null
providerTransactionId*string|null
reference*string|null
description*string|null
metadata*string|number|boolean|null||array<unknown>
curl -X POST "https://example.com/v2/transactions/:transactionId/confirm"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "string",  "userId": "string",  "type": "charge",  "status": "pending",  "currency": "str",  "amountCents": -2147483648,  "taxCents": -2147483648,  "idempotencyKey": "string",  "provider": "mock_paypal",  "providerTransactionId": "string",  "reference": "string",  "description": "string",  "metadata": "string"}
POST
/v2/transactions/:transactionId/cancel

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

transactionId*string
Length24 <= length <= 24

Response Body

Charge canceled (or already canceled)

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
organizationId*string
Lengthlength <= 24
userId*string
Lengthlength <= 24
type*string
Value in"charge""refund"
status*string
Value in"pending""succeeded""failed""canceled"
currency*string
Lengthlength <= 3
amountCents*integer
Range-2147483648 <= value <= 2147483647
taxCents*integer
Range-2147483648 <= value <= 2147483647
idempotencyKey*|
Lengthlength <= 64
provider*|
Value in"mock_paypal""paypal"null
providerTransactionId*string|null
reference*string|null
description*string|null
metadata*string|number|boolean|null||array<unknown>
curl -X POST "https://example.com/v2/transactions/:transactionId/cancel"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "string",  "userId": "string",  "type": "charge",  "status": "pending",  "currency": "str",  "amountCents": -2147483648,  "taxCents": -2147483648,  "idempotencyKey": "string",  "provider": "mock_paypal",  "providerTransactionId": "string",  "reference": "string",  "description": "string",  "metadata": "string"}
POST
/v2/transactions/:transactionId/fail

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

transactionId*string
Length24 <= length <= 24

Response Body

Charge failed (or already failed)

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
organizationId*string
Lengthlength <= 24
userId*string
Lengthlength <= 24
type*string
Value in"charge""refund"
status*string
Value in"pending""succeeded""failed""canceled"
currency*string
Lengthlength <= 3
amountCents*integer
Range-2147483648 <= value <= 2147483647
taxCents*integer
Range-2147483648 <= value <= 2147483647
idempotencyKey*|
Lengthlength <= 64
provider*|
Value in"mock_paypal""paypal"null
providerTransactionId*string|null
reference*string|null
description*string|null
metadata*string|number|boolean|null||array<unknown>
curl -X POST "https://example.com/v2/transactions/:transactionId/fail"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "string",  "userId": "string",  "type": "charge",  "status": "pending",  "currency": "str",  "amountCents": -2147483648,  "taxCents": -2147483648,  "idempotencyKey": "string",  "provider": "mock_paypal",  "providerTransactionId": "string",  "reference": "string",  "description": "string",  "metadata": "string"}
GET
/v2/credit-ledger

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

type?string
Value in"paypal_charge""paypal_refund""job_funded""job_refunded""job_reward_adjusted_debit""job_reward_adjusted_credit""job_extended""ai_evaluation_funded""verification_run_charged""lt_run_charged""manual_credit_grant""monitoring_run_charged""finetune_run_charged""worker_bonus"
limit?integer
Range1 <= value <= 200
Default50
offset?|
Range0 <= value
Default0

Response Body

The organization's credit ledger, newest first

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/credit-ledger"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "organizationId": "string",    "type": "paypal_charge",    "amountCents": -2147483648,    "balanceAfterCents": -2147483648,    "referenceType": "string",    "referenceId": "string",    "description": "string",    "lexwareInvoiceId": "2ff6df09-518a-406f-a8c8-de8ff842ebb5"  }]
GET
/v2/credit-ledger/:entryId/receipt

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

entryId*string
Length24 <= length <= 24

Response Body

Redirect to the hosted invoice

curl -X GET "https://example.com/v2/credit-ledger/:entryId/receipt"
Empty
GET
/v2/admin-external-providers

Authorization

openIdConnect
OpenID Connect<token>

Response Body

External provider catalog with live aggregates

application/json
  1. response
items*array<>
curl -X GET "https://example.com/v2/admin-external-providers"
{  "items": [    {      "slug": "string",      "name": "string",      "description": "string",      "status": "active",      "capabilities": {        "create": true,        "cancel": true,        "pause": true,        "resume": true,        "syncStatus": true,        "syncCost": true,        "manageTeams": true,        "nativeMultiSubmission": true,        "reviewSubmissions": true,        "liveBalance": true      },      "panelSpecFields": [        "string"      ],      "panelSpecFieldOptions": {        "property1": [          {            "value": "string",            "labelEn": "string",            "labelDe": "string"          }        ],        "property2": [          {            "value": "string",            "labelEn": "string",            "labelDe": "string"          }        ]      },      "balanceCents": 0,      "currency": "string",      "activeExternalJobCount": 0,      "liveBalanceCents": 0,      "liveAvailableBalanceCents": 0,      "liveBalanceCurrency": "string",      "liveBalanceSyncedAt": "2019-08-24T14:15:22Z"    }  ]}
GET
/v2/admin-external-providers/:slug

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

slug*string

Response Body

External provider detail

application/json
  1. response
slug*string
name*string
description*string
status*string
Value in"active""maintenance""deprecated"
capabilities*
panelSpecFields*array<string>
panelSpecFieldOptions?
balanceCents*number
currency*string
activeExternalJobCount*number
liveBalanceCents*number|null
liveAvailableBalanceCents*number|null
liveBalanceCurrency*string|null
liveBalanceSyncedAt*|
Formatdate-time
curl -X GET "https://example.com/v2/admin-external-providers/:slug"
{  "slug": "string",  "name": "string",  "description": "string",  "status": "active",  "capabilities": {    "create": true,    "cancel": true,    "pause": true,    "resume": true,    "syncStatus": true,    "syncCost": true,    "manageTeams": true,    "nativeMultiSubmission": true,    "reviewSubmissions": true,    "liveBalance": true  },  "panelSpecFields": [    "string"  ],  "panelSpecFieldOptions": {    "property1": [      {        "value": "string",        "labelEn": "string",        "labelDe": "string"      }    ],    "property2": [      {        "value": "string",        "labelEn": "string",        "labelDe": "string"      }    ]  },  "balanceCents": 0,  "currency": "string",  "activeExternalJobCount": 0,  "liveBalanceCents": 0,  "liveAvailableBalanceCents": 0,  "liveBalanceCurrency": "string",  "liveBalanceSyncedAt": "2019-08-24T14:15:22Z"}
GET
/v2/admin-external-providers/:slug/eligible-crowd-jobs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

slug*string

Query Parameters

organizationId*string
Length24 <= length <= 24

Response Body

Eligible crowd jobs for this organization

application/json
  1. response
items*array<>
curl -X GET "https://example.com/v2/admin-external-providers/:slug/eligible-crowd-jobs?organizationId=stringstringstringstring"
{  "items": [    {      "id": "string",      "title": "string",      "description": "string",      "category": "string",      "rewardCredits": 0,      "projectId": "string",      "projectName": "string"    }  ]}
GET
/v2/admin-external-providers/:slug/external-jobs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

slug*string

Query Parameters

crowdJobId?string
Length24 <= length <= 24
status?string
Value in"draft""pending_creation""active""completing""completed""canceled""error"

Response Body

External jobs for this provider

application/json
  1. response
items*array<>
curl -X GET "https://example.com/v2/admin-external-providers/:slug/external-jobs"
{  "items": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "providerSlug": "string",      "crowdJobId": "string",      "kind": "entry",      "parentExternalJobId": "string",      "targetGuestWorkerId": "string",      "targetExternalWorkerId": "string",      "status": "draft",      "externalStatusRaw": "string",      "externalReferenceId": "string",      "title": "string",      "description": "string",      "language": "en",      "panelSpecification": "string",      "correlationToken": "string",      "derivedVerificationCode": "string",      "publicJobUrl": "string",      "plannedStartAt": "2019-08-24T14:15:22Z",      "plannedEndAt": "2019-08-24T14:15:22Z",      "startedAt": "2019-08-24T14:15:22Z",      "completedAt": "2019-08-24T14:15:22Z",      "canceledAt": "2019-08-24T14:15:22Z",      "costCurrency": "str",      "estimatedCostCents": -9007199254740991,      "actualCostCents": -9007199254740991,      "lastSyncedAt": "2019-08-24T14:15:22Z",      "lastErrorMessage": "string",      "metadata": "string",      "createdByUserId": "string",      "sourceCrowdAnswerId": "string"    }  ]}
POST
/v2/admin-external-providers/:slug/external-jobs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

slug*string

Request Body

New entry external job

application/json
  1. body
crowdJobId*string
Length24 <= length <= 24
title*string
Length1 <= length <= 500
description*string
Length1 <= length
language?string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
panelSpecification*
plannedStartAt?|
Formatdate-time
plannedEndAt?|
Formatdate-time

Response Body

Created external job (queued for creation on the provider)

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
providerSlug*string
crowdJobId*string
Lengthlength <= 24
kind*string
Value in"entry""individual_followup"
parentExternalJobId*|
Lengthlength <= 24
targetGuestWorkerId*|
Lengthlength <= 24
targetExternalWorkerId*string|null
status*string
Value in"draft""pending_creation""active""completing""completed""canceled""error"
externalStatusRaw*string|null
externalReferenceId*string|null
title*string
description*string
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
panelSpecification*string|number|boolean|null||array<unknown>
correlationToken*string
derivedVerificationCode*string|null
publicJobUrl*string|null
plannedStartAt*|
Formatdate-time
plannedEndAt*|
Formatdate-time
startedAt*|
Formatdate-time
completedAt*|
Formatdate-time
canceledAt*|
Formatdate-time
costCurrency*string
Lengthlength <= 3
estimatedCostCents*integer
Range-9007199254740991 <= value <= 9007199254740991
actualCostCents*|
Range-9007199254740991 <= value <= 9007199254740991
lastSyncedAt*|
Formatdate-time
lastErrorMessage*string|null
metadata*string|number|boolean|null||array<unknown>
createdByUserId*|
Lengthlength <= 24
sourceCrowdAnswerId*|
Lengthlength <= 24
curl -X POST "https://example.com/v2/admin-external-providers/:slug/external-jobs" \  -H "Content-Type: application/json" \  -d '{    "crowdJobId": "stringstringstringstring",    "title": "string",    "description": "string",    "panelSpecification": {      "participants": 1    }  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "providerSlug": "string",  "crowdJobId": "string",  "kind": "entry",  "parentExternalJobId": "string",  "targetGuestWorkerId": "string",  "targetExternalWorkerId": "string",  "status": "draft",  "externalStatusRaw": "string",  "externalReferenceId": "string",  "title": "string",  "description": "string",  "language": "en",  "panelSpecification": "string",  "correlationToken": "string",  "derivedVerificationCode": "string",  "publicJobUrl": "string",  "plannedStartAt": "2019-08-24T14:15:22Z",  "plannedEndAt": "2019-08-24T14:15:22Z",  "startedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "canceledAt": "2019-08-24T14:15:22Z",  "costCurrency": "str",  "estimatedCostCents": -9007199254740991,  "actualCostCents": -9007199254740991,  "lastSyncedAt": "2019-08-24T14:15:22Z",  "lastErrorMessage": "string",  "metadata": "string",  "createdByUserId": "string",  "sourceCrowdAnswerId": "string"}
GET
/v2/admin-external-providers/:slug/external-jobs/:externalJobId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

slug*string
externalJobId*string
Length24 <= length <= 24

Response Body

External job detail

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
providerSlug*string
crowdJobId*string
Lengthlength <= 24
kind*string
Value in"entry""individual_followup"
parentExternalJobId*|
Lengthlength <= 24
targetGuestWorkerId*|
Lengthlength <= 24
targetExternalWorkerId*string|null
status*string
Value in"draft""pending_creation""active""completing""completed""canceled""error"
externalStatusRaw*string|null
externalReferenceId*string|null
title*string
description*string
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
panelSpecification*string|number|boolean|null||array<unknown>
correlationToken*string
derivedVerificationCode*string|null
publicJobUrl*string|null
plannedStartAt*|
Formatdate-time
plannedEndAt*|
Formatdate-time
startedAt*|
Formatdate-time
completedAt*|
Formatdate-time
canceledAt*|
Formatdate-time
costCurrency*string
Lengthlength <= 3
estimatedCostCents*integer
Range-9007199254740991 <= value <= 9007199254740991
actualCostCents*|
Range-9007199254740991 <= value <= 9007199254740991
lastSyncedAt*|
Formatdate-time
lastErrorMessage*string|null
metadata*string|number|boolean|null||array<unknown>
createdByUserId*|
Lengthlength <= 24
sourceCrowdAnswerId*|
Lengthlength <= 24
curl -X GET "https://example.com/v2/admin-external-providers/:slug/external-jobs/:externalJobId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "providerSlug": "string",  "crowdJobId": "string",  "kind": "entry",  "parentExternalJobId": "string",  "targetGuestWorkerId": "string",  "targetExternalWorkerId": "string",  "status": "draft",  "externalStatusRaw": "string",  "externalReferenceId": "string",  "title": "string",  "description": "string",  "language": "en",  "panelSpecification": "string",  "correlationToken": "string",  "derivedVerificationCode": "string",  "publicJobUrl": "string",  "plannedStartAt": "2019-08-24T14:15:22Z",  "plannedEndAt": "2019-08-24T14:15:22Z",  "startedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "canceledAt": "2019-08-24T14:15:22Z",  "costCurrency": "str",  "estimatedCostCents": -9007199254740991,  "actualCostCents": -9007199254740991,  "lastSyncedAt": "2019-08-24T14:15:22Z",  "lastErrorMessage": "string",  "metadata": "string",  "createdByUserId": "string",  "sourceCrowdAnswerId": "string"}
POST
/v2/admin-external-providers/:slug/external-jobs/:externalJobId/cancel

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

slug*string
externalJobId*string
Length24 <= length <= 24

Response Body

External job queued for cancellation

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
providerSlug*string
crowdJobId*string
Lengthlength <= 24
kind*string
Value in"entry""individual_followup"
parentExternalJobId*|
Lengthlength <= 24
targetGuestWorkerId*|
Lengthlength <= 24
targetExternalWorkerId*string|null
status*string
Value in"draft""pending_creation""active""completing""completed""canceled""error"
externalStatusRaw*string|null
externalReferenceId*string|null
title*string
description*string
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
panelSpecification*string|number|boolean|null||array<unknown>
correlationToken*string
derivedVerificationCode*string|null
publicJobUrl*string|null
plannedStartAt*|
Formatdate-time
plannedEndAt*|
Formatdate-time
startedAt*|
Formatdate-time
completedAt*|
Formatdate-time
canceledAt*|
Formatdate-time
costCurrency*string
Lengthlength <= 3
estimatedCostCents*integer
Range-9007199254740991 <= value <= 9007199254740991
actualCostCents*|
Range-9007199254740991 <= value <= 9007199254740991
lastSyncedAt*|
Formatdate-time
lastErrorMessage*string|null
metadata*string|number|boolean|null||array<unknown>
createdByUserId*|
Lengthlength <= 24
sourceCrowdAnswerId*|
Lengthlength <= 24
curl -X POST "https://example.com/v2/admin-external-providers/:slug/external-jobs/:externalJobId/cancel"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "providerSlug": "string",  "crowdJobId": "string",  "kind": "entry",  "parentExternalJobId": "string",  "targetGuestWorkerId": "string",  "targetExternalWorkerId": "string",  "status": "draft",  "externalStatusRaw": "string",  "externalReferenceId": "string",  "title": "string",  "description": "string",  "language": "en",  "panelSpecification": "string",  "correlationToken": "string",  "derivedVerificationCode": "string",  "publicJobUrl": "string",  "plannedStartAt": "2019-08-24T14:15:22Z",  "plannedEndAt": "2019-08-24T14:15:22Z",  "startedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "canceledAt": "2019-08-24T14:15:22Z",  "costCurrency": "str",  "estimatedCostCents": -9007199254740991,  "actualCostCents": -9007199254740991,  "lastSyncedAt": "2019-08-24T14:15:22Z",  "lastErrorMessage": "string",  "metadata": "string",  "createdByUserId": "string",  "sourceCrowdAnswerId": "string"}
POST
/v2/admin-external-providers/:slug/external-jobs/:externalJobId/sync

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

slug*string
externalJobId*string
Length24 <= length <= 24

Response Body

External job after a manual status sync

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
providerSlug*string
crowdJobId*string
Lengthlength <= 24
kind*string
Value in"entry""individual_followup"
parentExternalJobId*|
Lengthlength <= 24
targetGuestWorkerId*|
Lengthlength <= 24
targetExternalWorkerId*string|null
status*string
Value in"draft""pending_creation""active""completing""completed""canceled""error"
externalStatusRaw*string|null
externalReferenceId*string|null
title*string
description*string
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
panelSpecification*string|number|boolean|null||array<unknown>
correlationToken*string
derivedVerificationCode*string|null
publicJobUrl*string|null
plannedStartAt*|
Formatdate-time
plannedEndAt*|
Formatdate-time
startedAt*|
Formatdate-time
completedAt*|
Formatdate-time
canceledAt*|
Formatdate-time
costCurrency*string
Lengthlength <= 3
estimatedCostCents*integer
Range-9007199254740991 <= value <= 9007199254740991
actualCostCents*|
Range-9007199254740991 <= value <= 9007199254740991
lastSyncedAt*|
Formatdate-time
lastErrorMessage*string|null
metadata*string|number|boolean|null||array<unknown>
createdByUserId*|
Lengthlength <= 24
sourceCrowdAnswerId*|
Lengthlength <= 24
curl -X POST "https://example.com/v2/admin-external-providers/:slug/external-jobs/:externalJobId/sync"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "providerSlug": "string",  "crowdJobId": "string",  "kind": "entry",  "parentExternalJobId": "string",  "targetGuestWorkerId": "string",  "targetExternalWorkerId": "string",  "status": "draft",  "externalStatusRaw": "string",  "externalReferenceId": "string",  "title": "string",  "description": "string",  "language": "en",  "panelSpecification": "string",  "correlationToken": "string",  "derivedVerificationCode": "string",  "publicJobUrl": "string",  "plannedStartAt": "2019-08-24T14:15:22Z",  "plannedEndAt": "2019-08-24T14:15:22Z",  "startedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "canceledAt": "2019-08-24T14:15:22Z",  "costCurrency": "str",  "estimatedCostCents": -9007199254740991,  "actualCostCents": -9007199254740991,  "lastSyncedAt": "2019-08-24T14:15:22Z",  "lastErrorMessage": "string",  "metadata": "string",  "createdByUserId": "string",  "sourceCrowdAnswerId": "string"}
GET
/v2/admin-external-providers/:slug/external-jobs/:externalJobId/events

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

slug*string
externalJobId*string
Length24 <= length <= 24

Response Body

External job audit/event log

application/json
  1. response
items*array<>
curl -X GET "https://example.com/v2/admin-external-providers/:slug/external-jobs/:externalJobId/events"
{  "items": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "externalJobId": "string",      "type": "created",      "payload": "string",      "actorUserId": "string"    }  ]}
GET
/v2/admin-external-providers/:slug/external-jobs/:externalJobId/workers

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

slug*string
externalJobId*string
Length24 <= length <= 24

Response Body

External workers who submitted through this external job

application/json
  1. response
items*array<>
curl -X GET "https://example.com/v2/admin-external-providers/:slug/external-jobs/:externalJobId/workers"
{  "items": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "providerSlug": "string",      "externalWorkerId": "string",      "externalDisplayName": "string",      "guestWorkerId": "string",      "personalWhitelistTeamId": "string",      "status": "active",      "firstSeenAt": "2019-08-24T14:15:22Z",      "lastSeenAt": "2019-08-24T14:15:22Z",      "metadata": "string"    }  ]}
GET
/v2/admin-external-providers/:slug/ledger

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

slug*string

Response Body

Provider balance and ledger entries

application/json
  1. response
balanceCents*number
currency*string
items*array<>
curl -X GET "https://example.com/v2/admin-external-providers/:slug/ledger"
{  "balanceCents": 0,  "currency": "string",  "items": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "providerSlug": "string",      "externalJobId": "string",      "type": "starting_balance",      "amountCents": -9007199254740991,      "balanceAfterCents": -9007199254740991,      "currency": "str",      "breakdown": "string",      "note": "string",      "createdByUserId": "string"    }  ]}
POST
/v2/admin-external-providers/:slug/ledger/starting-balance

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

slug*string

Request Body

Starting balance entry

application/json
  1. body
amountCents*integer
currency?string
Length3 <= length <= 3
Default"EUR"
note*string
Length1 <= length

Response Body

Recorded starting balance

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
providerSlug*string
externalJobId*|
Lengthlength <= 24
type*string
Value in"starting_balance""balance_correction""external_job_charge""external_job_refund"
amountCents*integer
Range-9007199254740991 <= value <= 9007199254740991
balanceAfterCents*integer
Range-9007199254740991 <= value <= 9007199254740991
currency*string
Lengthlength <= 3
breakdown*string|number|boolean|null||array<unknown>
note*string|null
createdByUserId*|
Lengthlength <= 24
curl -X POST "https://example.com/v2/admin-external-providers/:slug/ledger/starting-balance" \  -H "Content-Type: application/json" \  -d '{    "amountCents": 0,    "note": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "providerSlug": "string",  "externalJobId": "string",  "type": "starting_balance",  "amountCents": -9007199254740991,  "balanceAfterCents": -9007199254740991,  "currency": "str",  "breakdown": "string",  "note": "string",  "createdByUserId": "string"}
POST
/v2/admin-external-providers/:slug/ledger/correction

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

slug*string

Request Body

Balance correction entry

application/json
  1. body
amountCents*integer
currency?string
Length3 <= length <= 3
Default"EUR"
note*string
Length1 <= length

Response Body

Recorded correction

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
providerSlug*string
externalJobId*|
Lengthlength <= 24
type*string
Value in"starting_balance""balance_correction""external_job_charge""external_job_refund"
amountCents*integer
Range-9007199254740991 <= value <= 9007199254740991
balanceAfterCents*integer
Range-9007199254740991 <= value <= 9007199254740991
currency*string
Lengthlength <= 3
breakdown*string|number|boolean|null||array<unknown>
note*string|null
createdByUserId*|
Lengthlength <= 24
curl -X POST "https://example.com/v2/admin-external-providers/:slug/ledger/correction" \  -H "Content-Type: application/json" \  -d '{    "amountCents": 0,    "note": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "providerSlug": "string",  "externalJobId": "string",  "type": "starting_balance",  "amountCents": -9007199254740991,  "balanceAfterCents": -9007199254740991,  "currency": "str",  "breakdown": "string",  "note": "string",  "createdByUserId": "string"}
GET
/v2/users

Authorization

openIdConnect
OpenID Connect<token>

Response Body

The list of users

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/users"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "sub": "string",    "name": "string",    "email": "string",    "avatar": "string",    "avatarPlaceholder": "string",    "organizationId": "string",    "role": "viewer",    "isSuperadmin": true,    "createdVia": "signup",    "locale": "string",    "timezone": "string"  }]
POST
/v2/users

Authorization

openIdConnect
OpenID Connect<token>

Request Body

The user to create

application/json
  1. body
sub*string
Length10 <= length <= 100
name*string
Length3 <= length <= 50
email*string
Formatemail
avatar?string|null
avatarPlaceholder?string|null
organizationId?|
Lengthlength <= 24
isSuperadmin?boolean
createdVia?|
Value in"signup""invitation""worker_signup""oidc_auto_provision"null
locale?string|null
timezone?string|null

Response Body

The created user

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
sub*string
name*string
email*string
avatar*string|null
avatarPlaceholder*string|null
organizationId*|
Lengthlength <= 24
role*|
Value in"viewer""user""admin""superadmin"null
isSuperadmin*boolean
createdVia*|
Value in"signup""invitation""worker_signup""oidc_auto_provision"null
locale*string|null
timezone*string|null
curl -X POST "https://example.com/v2/users" \  -H "Content-Type: application/json" \  -d '{    "sub": "stringstri",    "name": "string",    "email": "user@example.com"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "sub": "string",  "name": "string",  "email": "string",  "avatar": "string",  "avatarPlaceholder": "string",  "organizationId": "string",  "role": "viewer",  "isSuperadmin": true,  "createdVia": "signup",  "locale": "string",  "timezone": "string"}
GET
/v2/users/me

Authorization

openIdConnect
OpenID Connect<token>

Response Body

User profile

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
sub*string
name*string
email*string
avatar*string|null
avatarPlaceholder*string|null
organizationId*|
Lengthlength <= 24
role*|
Value in"viewer""user""admin""superadmin"null
isSuperadmin*boolean
createdVia*|
Value in"signup""invitation""worker_signup""oidc_auto_provision"null
locale*string|null
timezone*string|null
curl -X GET "https://example.com/v2/users/me"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "sub": "string",  "name": "string",  "email": "string",  "avatar": "string",  "avatarPlaceholder": "string",  "organizationId": "string",  "role": "viewer",  "isSuperadmin": true,  "createdVia": "signup",  "locale": "string",  "timezone": "string"}
PATCH
/v2/users/me

Authorization

openIdConnect
OpenID Connect<token>

Request Body

Profile update

application/json
  1. body
name?string
Length1 <= length <= 100
timezone?string
Length1 <= length <= 100

Response Body

Updated user profile

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
sub*string
name*string
email*string
avatar*string|null
avatarPlaceholder*string|null
organizationId*|
Lengthlength <= 24
role*|
Value in"viewer""user""admin""superadmin"null
isSuperadmin*boolean
createdVia*|
Value in"signup""invitation""worker_signup""oidc_auto_provision"null
locale*string|null
timezone*string|null
curl -X PATCH "https://example.com/v2/users/me" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "sub": "string",  "name": "string",  "email": "string",  "avatar": "string",  "avatarPlaceholder": "string",  "organizationId": "string",  "role": "viewer",  "isSuperadmin": true,  "createdVia": "signup",  "locale": "string",  "timezone": "string"}
GET
/v2/users/me/registration-status

Authorization

openIdConnect
OpenID Connect<token>

Response Body

The authenticated user's email confirmation status

application/json
  1. response
status*string
Value in"pending""accepted""expired""none"
curl -X GET "https://example.com/v2/users/me/registration-status"
{  "status": "pending"}
POST
/v2/users/me/resend-confirmation

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Confirmation email re-sent

application/json
  1. response
message*string
curl -X POST "https://example.com/v2/users/me/resend-confirmation"
{  "message": "string"}
PATCH
/v2/users/me/avatar

Authorization

openIdConnect
OpenID Connect<token>

Request Body

multipart/form-data
  1. body
avatar*file
Formatbinary

Response Body

Updated user with avatar

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
sub*string
name*string
email*string
avatar*string|null
avatarPlaceholder*string|null
organizationId*|
Lengthlength <= 24
role*|
Value in"viewer""user""admin""superadmin"null
isSuperadmin*boolean
createdVia*|
Value in"signup""invitation""worker_signup""oidc_auto_provision"null
locale*string|null
timezone*string|null
curl -X PATCH "https://example.com/v2/users/me/avatar" \  -F avatar="string"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "sub": "string",  "name": "string",  "email": "string",  "avatar": "string",  "avatarPlaceholder": "string",  "organizationId": "string",  "role": "viewer",  "isSuperadmin": true,  "createdVia": "signup",  "locale": "string",  "timezone": "string"}
GET
/v2/users/:userId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

userId*string
Formatcuid2

Response Body

User profile

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
sub*string
name*string
email*string
avatar*string|null
avatarPlaceholder*string|null
organizationId*|
Lengthlength <= 24
role*|
Value in"viewer""user""admin""superadmin"null
isSuperadmin*boolean
createdVia*|
Value in"signup""invitation""worker_signup""oidc_auto_provision"null
locale*string|null
timezone*string|null
curl -X GET "https://example.com/v2/users/:userId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "sub": "string",  "name": "string",  "email": "string",  "avatar": "string",  "avatarPlaceholder": "string",  "organizationId": "string",  "role": "viewer",  "isSuperadmin": true,  "createdVia": "signup",  "locale": "string",  "timezone": "string"}
DELETE
/v2/users/:userId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

userId*string
Formatcuid2

Response Body

User profile

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
sub*string
name*string
email*string
avatar*string|null
avatarPlaceholder*string|null
organizationId*|
Lengthlength <= 24
role*|
Value in"viewer""user""admin""superadmin"null
isSuperadmin*boolean
createdVia*|
Value in"signup""invitation""worker_signup""oidc_auto_provision"null
locale*string|null
timezone*string|null
curl -X DELETE "https://example.com/v2/users/:userId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "sub": "string",  "name": "string",  "email": "string",  "avatar": "string",  "avatarPlaceholder": "string",  "organizationId": "string",  "role": "viewer",  "isSuperadmin": true,  "createdVia": "signup",  "locale": "string",  "timezone": "string"}
POST
/v2/users/signup

Authorization

openIdConnect
OpenID Connect<token>

Request Body

The user to create

application/json
  1. body
name*string
Length3 <= length <= 50
email*string
Formatemail
avatar?string|null
avatarPlaceholder?string|null
isSuperadmin?boolean
createdVia?|
Value in"signup""invitation""worker_signup""oidc_auto_provision"null
locale?string|null
timezone?string|null
password*string
Length8 <= length
invitationId?string
Length24 <= length <= 24

Response Body

Success

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
sub*string
name*string
email*string
avatar*string|null
avatarPlaceholder*string|null
organizationId*|
Lengthlength <= 24
role*|
Value in"viewer""user""admin""superadmin"null
isSuperadmin*boolean
createdVia*|
Value in"signup""invitation""worker_signup""oidc_auto_provision"null
locale*string|null
timezone*string|null
curl -X POST "https://example.com/v2/users/signup" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "email": "user@example.com",    "password": "stringst"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "sub": "string",  "name": "string",  "email": "string",  "avatar": "string",  "avatarPlaceholder": "string",  "organizationId": "string",  "role": "viewer",  "isSuperadmin": true,  "createdVia": "signup",  "locale": "string",  "timezone": "string"}
GET
/v2/users/verify/:registrationId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

registrationId*string
Formatcuid2

Response Body

Updated registration

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
authentikUserId*integer
Range-2147483648 <= value <= 2147483647
userId*|
Lengthlength <= 24
status*string
Value in"pending""accepted""expired"
expirationDate*string
Formatdate-time
curl -X GET "https://example.com/v2/users/verify/:registrationId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "authentikUserId": -2147483648,  "userId": "string",  "status": "pending",  "expirationDate": "2019-08-24T14:15:22Z"}
POST
/v2/users/request-password-reset

Authorization

openIdConnect
OpenID Connect<token>

Request Body

Email address to send a password reset link to

application/json
  1. body
email*string
Formatemail

Response Body

A reset link was sent if an account with this email exists

application/json
  1. response
message*string
curl -X POST "https://example.com/v2/users/request-password-reset" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'
{  "message": "string"}
POST
/v2/users/reset-password

Authorization

openIdConnect
OpenID Connect<token>

Request Body

Reset token (from the emailed link) and the new password

application/json
  1. body
token*string
Length24 <= length <= 24
password*string
Length8 <= length

Response Body

Password updated

application/json
  1. response
message*string
curl -X POST "https://example.com/v2/users/reset-password" \  -H "Content-Type: application/json" \  -d '{    "token": "stringstringstringstring",    "password": "stringst"  }'
{  "message": "string"}
PUT
/v2/users/:userId/role

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

userId*string
Formatcuid2

Request Body

New role for the user within their organization (viewer, user or admin). Superadmin is a global flag, not settable here.

application/json
  1. body
role*string
Value in"viewer""user""admin"

Response Body

Updated user

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
sub*string
name*string
email*string
avatar*string|null
avatarPlaceholder*string|null
organizationId*|
Lengthlength <= 24
role*|
Value in"viewer""user""admin""superadmin"null
isSuperadmin*boolean
createdVia*|
Value in"signup""invitation""worker_signup""oidc_auto_provision"null
locale*string|null
timezone*string|null
curl -X PUT "https://example.com/v2/users/:userId/role" \  -H "Content-Type: application/json" \  -d '{    "role": "viewer"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "sub": "string",  "name": "string",  "email": "string",  "avatar": "string",  "avatarPlaceholder": "string",  "organizationId": "string",  "role": "viewer",  "isSuperadmin": true,  "createdVia": "signup",  "locale": "string",  "timezone": "string"}
GET
/v2/users/me/organizations

Authorization

openIdConnect
OpenID Connect<token>

Response Body

List of user's organization memberships with org details

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/users/me/organizations"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "userId": "string",    "organizationId": "string",    "role": "viewer",    "isDefault": true,    "organization": {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "name": "string",      "description": "string",      "balance_cents": -2147483648,      "blocked_balance_cents": -2147483648,      "modules": [        "crowdsourcing"      ],      "logo": "string",      "logoPlaceholder": "string"    }  }]
PUT
/v2/users/me/organizations/:organizationId/default

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Formatcuid2

Response Body

Default organization updated

application/json
  1. response
id*|
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
userId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
role*string
Value in"viewer""user""admin""superadmin"
isDefault*boolean
curl -X PUT "https://example.com/v2/users/me/organizations/:organizationId/default"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "userId": "string",  "organizationId": "string",  "role": "viewer",  "isDefault": true}
GET
/v2/users/me/api-keys

Authorization

openIdConnect
OpenID Connect<token>

Response Body

List of API keys for the authenticated user

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/users/me/api-keys"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "userId": "string",    "name": "string",    "role": "viewer",    "expirationDate": "2019-08-24T14:15:22Z",    "state": "active",    "organizationIds": [      "stringstringstringstring"    ]  }]
POST
/v2/users/me/api-keys

Authorization

openIdConnect
OpenID Connect<token>

Request Body

Create an API key for the authenticated user

application/json
  1. body
name*string
Length1 <= length <= 100
role?|
Value in"viewer""user""admin""superadmin"null
expirationDate?|
Formatdate-time
organizationIds?array<>

Response Body

Created API key and one-time plaintext key

application/json
  1. response
apiKey*
key*string
curl -X POST "https://example.com/v2/users/me/api-keys" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "apiKey": {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "userId": "string",    "name": "string",    "role": "viewer",    "expirationDate": "2019-08-24T14:15:22Z",    "state": "active",    "organizationIds": [      "stringstringstringstring"    ]  },  "key": "string"}
PATCH
/v2/users/me/api-keys/:apiKeyId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

apiKeyId*string
Formatcuid2

Request Body

Update an existing API key

application/json
  1. body
name?string
role?|
Value in"viewer""user""admin""superadmin"null
expirationDate?|
Formatdate-time
state?string
Value in"active""expired"
organizationIds?array<>

Response Body

Updated API key

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
userId*string
Lengthlength <= 24
name*string
role*|
Value in"viewer""user""admin""superadmin"null
expirationDate*|
Formatdate-time
state*string
Value in"active""expired"
organizationIds*array<>
curl -X PATCH "https://example.com/v2/users/me/api-keys/:apiKeyId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "userId": "string",  "name": "string",  "role": "viewer",  "expirationDate": "2019-08-24T14:15:22Z",  "state": "active",  "organizationIds": [    "stringstringstringstring"  ]}
DELETE
/v2/users/me/api-keys/:apiKeyId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

apiKeyId*string
Formatcuid2

Response Body

Revoked API key

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
userId*string
Lengthlength <= 24
name*string
role*|
Value in"viewer""user""admin""superadmin"null
expirationDate*|
Formatdate-time
state*string
Value in"active""expired"
organizationIds*array<>
curl -X DELETE "https://example.com/v2/users/me/api-keys/:apiKeyId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "userId": "string",  "name": "string",  "role": "viewer",  "expirationDate": "2019-08-24T14:15:22Z",  "state": "active",  "organizationIds": [    "stringstringstringstring"  ]}
POST
/v2/users/me/api-keys/:apiKeyId/rotate

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

apiKeyId*string
Formatcuid2

Response Body

Rotated API key and one-time plaintext key

application/json
  1. response
apiKey*
key*string
curl -X POST "https://example.com/v2/users/me/api-keys/:apiKeyId/rotate"
{  "apiKey": {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "userId": "string",    "name": "string",    "role": "viewer",    "expirationDate": "2019-08-24T14:15:22Z",    "state": "active",    "organizationIds": [      "stringstringstringstring"    ]  },  "key": "string"}
GET
/v2/workflows

Authorization

openIdConnect
OpenID Connect<token>

Response Body

The list of workflows

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/workflows"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "pipelineId": "621ef2b0-ba1d-48e5-89dc-b778e6ed42fd",    "pipelineName": "string",    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",    "status": "in_progress",    "statusMessage": "string",    "n8nExecutionId": -2147483648,    "n8nWorkflowId": "string",    "n8nWorkflowName": "string",    "n8nWorkflowNameLong": "string",    "result": "string",    "aiInterpretation": "string",    "projectId": "string"  }]
GET
/v2/workflows/:workflowId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

workflowId*string
Formatcuid2

Response Body

Metadata of the workflow

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
pipelineId*string
Formatuuid
pipelineName*string
uuid*string
Formatuuid
status*string
Value in"in_progress""finished""no_result""error"
statusMessage*string|null
n8nExecutionId*integer
Range-2147483648 <= value <= 2147483647
n8nWorkflowId*string
n8nWorkflowName*string
n8nWorkflowNameLong*string
result*string|null
aiInterpretation*string|null
projectId*string
Lengthlength <= 24
curl -X GET "https://example.com/v2/workflows/:workflowId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "pipelineId": "621ef2b0-ba1d-48e5-89dc-b778e6ed42fd",  "pipelineName": "string",  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",  "status": "in_progress",  "statusMessage": "string",  "n8nExecutionId": -2147483648,  "n8nWorkflowId": "string",  "n8nWorkflowName": "string",  "n8nWorkflowNameLong": "string",  "result": "string",  "aiInterpretation": "string",  "projectId": "string"}
PUT
/v2/workflows/:workflowId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

workflowId*string
Formatcuid2

Request Body

The updated workflow data

application/json
  1. body
pipelineId?string
Formatuuid
pipelineName?string
uuid?string
Formatuuid
status?string
Value in"in_progress""finished""no_result""error"
statusMessage?string|null
n8nExecutionId?integer
Range-2147483648 <= value <= 2147483647
n8nWorkflowId?string
n8nWorkflowName?string
n8nWorkflowNameLong?string
result?string|null
aiInterpretation?string|null

Response Body

The updated workflow

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
pipelineId*string
Formatuuid
pipelineName*string
uuid*string
Formatuuid
status*string
Value in"in_progress""finished""no_result""error"
statusMessage*string|null
n8nExecutionId*integer
Range-2147483648 <= value <= 2147483647
n8nWorkflowId*string
n8nWorkflowName*string
n8nWorkflowNameLong*string
result*string|null
aiInterpretation*string|null
projectId*string
Lengthlength <= 24
curl -X PUT "https://example.com/v2/workflows/:workflowId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "pipelineId": "621ef2b0-ba1d-48e5-89dc-b778e6ed42fd",  "pipelineName": "string",  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",  "status": "in_progress",  "statusMessage": "string",  "n8nExecutionId": -2147483648,  "n8nWorkflowId": "string",  "n8nWorkflowName": "string",  "n8nWorkflowNameLong": "string",  "result": "string",  "aiInterpretation": "string",  "projectId": "string"}
DELETE
/v2/workflows/:workflowId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

workflowId*string
Formatcuid2

Response Body

Metadata of the deleted workflow

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
pipelineId*string
Formatuuid
pipelineName*string
uuid*string
Formatuuid
status*string
Value in"in_progress""finished""no_result""error"
statusMessage*string|null
n8nExecutionId*integer
Range-2147483648 <= value <= 2147483647
n8nWorkflowId*string
n8nWorkflowName*string
n8nWorkflowNameLong*string
result*string|null
aiInterpretation*string|null
projectId*string
Lengthlength <= 24
curl -X DELETE "https://example.com/v2/workflows/:workflowId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "pipelineId": "621ef2b0-ba1d-48e5-89dc-b778e6ed42fd",  "pipelineName": "string",  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",  "status": "in_progress",  "statusMessage": "string",  "n8nExecutionId": -2147483648,  "n8nWorkflowId": "string",  "n8nWorkflowName": "string",  "n8nWorkflowNameLong": "string",  "result": "string",  "aiInterpretation": "string",  "projectId": "string"}
GET
/v2/workflows/:workflowId/comments

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

workflowId*string
Formatcuid2

Response Body

The list of comments

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/workflows/:workflowId/comments"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "text": "string",    "image": "string",    "time": "string",    "edited": true,    "authorId": "string",    "projectId": "string",    "fileId": "string",    "workflowId": "string",    "parentCommentId": "string",    "authorName": "string"  }]
POST
/v2/workflows/:workflowId/comments

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

workflowId*string
Formatcuid2

Request Body

The comment metadata

application/json
  1. body
text*string
Length1 <= length
image?string|null
time?string|null
edited?boolean
parentCommentId?|
Length24 <= length <= 24

Response Body

The created comment

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
text*string
image*string|null
time*string|null
edited*boolean
authorId*string
Lengthlength <= 24
projectId*string
Lengthlength <= 24
fileId*|
Lengthlength <= 24
workflowId*|
Lengthlength <= 24
parentCommentId*|
Lengthlength <= 24
authorName*string
curl -X POST "https://example.com/v2/workflows/:workflowId/comments" \  -H "Content-Type: application/json" \  -d '{    "text": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "text": "string",  "image": "string",  "time": "string",  "edited": true,  "authorId": "string",  "projectId": "string",  "fileId": "string",  "workflowId": "string",  "parentCommentId": "string",  "authorName": "string"}
GET
/v2/workflows/:workflowId/files

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

workflowId*string
Formatcuid2

Response Body

Files linked to the workflow

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/workflows/:workflowId/files"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "type": "string",    "size": -2147483648,    "path": "string",    "etag": "string",    "organizationId": "string",    "uploaderId": "string",    "lastModified": "2019-08-24T14:15:22Z",    "projectId": "string",    "privacyLevel": "private",    "tags": [      "string"    ],    "metadata": "string",    "additionalInfo": "string",    "origin": "user_upload",    "originWorkflowId": "string",    "sourceFileId": "string",    "enrichmentStatus": "pending",    "placeholder": "string",    "contentHash": "string",    "folderId": "string"  }]
GET
/v2/pipelines/catalog

Authorization

openIdConnect
OpenID Connect<token>

Response Body

List of all available verification pipelines

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/pipelines/catalog"
[  {    "slug": "string",    "name": "string",    "description": "string",    "status": "active",    "estimatedMinutes": 0,    "tier": "ai-only",    "requiredFiles": [      {        "label": "string",        "description": "string",        "mimeTypes": [          "string"        ],        "minCount": 0,        "maxCount": 0,        "requiredEnrichmentFields": [          "string"        ]      }    ],    "requiredContextFields": [      {        "key": "string",        "label": "string",        "description": "string",        "type": "string",        "enumValues": [          "string"        ]      }    ],    "optionalContextFields": [      {        "key": "string",        "label": "string",        "description": "string",        "type": "string",        "enumValues": [          "string"        ]      }    ],    "stages": [      {        "slug": "string",        "name": "string",        "type": "ai",        "description": "string"      }    ],    "costCredits": 0  }]
GET
/v2/pipelines/catalog/:slug

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

slug*string

Response Body

Verification pipeline definition

application/json
  1. response
slug*string
name*string
description*string
status*string
Value in"active""maintenance""deprecated"
estimatedMinutes*number
tier*string
Value in"ai-only""ai-crowd""context-only""multi-file"
requiredFiles*array<>
requiredContextFields*array<>
optionalContextFields*array<>
stages*array<>
costCredits*integer
Range0 <= value
curl -X GET "https://example.com/v2/pipelines/catalog/:slug"
{  "slug": "string",  "name": "string",  "description": "string",  "status": "active",  "estimatedMinutes": 0,  "tier": "ai-only",  "requiredFiles": [    {      "label": "string",      "description": "string",      "mimeTypes": [        "string"      ],      "minCount": 0,      "maxCount": 0,      "requiredEnrichmentFields": [        "string"      ]    }  ],  "requiredContextFields": [    {      "key": "string",      "label": "string",      "description": "string",      "type": "string",      "enumValues": [        "string"      ]    }  ],  "optionalContextFields": [    {      "key": "string",      "label": "string",      "description": "string",      "type": "string",      "enumValues": [        "string"      ]    }  ],  "stages": [    {      "slug": "string",      "name": "string",      "type": "ai",      "description": "string"    }  ],  "costCredits": 0}
GET
/v2/pipelines/:pipelineId/workflows

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

pipelineId*string
Formatuuid

Response Body

Files for the pipeline

application/json
  1. response
input*array<>
output*array<>
curl -X GET "https://example.com/v2/pipelines/:pipelineId/workflows"
{  "input": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "name": "string",      "type": "string",      "size": -2147483648,      "path": "string",      "etag": "string",      "organizationId": "string",      "uploaderId": "string",      "lastModified": "2019-08-24T14:15:22Z",      "projectId": "string",      "privacyLevel": "private",      "tags": [        "string"      ],      "metadata": "string",      "additionalInfo": "string",      "origin": "user_upload",      "originWorkflowId": "string",      "sourceFileId": "string",      "enrichmentStatus": "pending",      "placeholder": "string",      "contentHash": "string",      "folderId": "string"    }  ],  "output": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "name": "string",      "type": "string",      "size": -2147483648,      "path": "string",      "etag": "string",      "organizationId": "string",      "uploaderId": "string",      "lastModified": "2019-08-24T14:15:22Z",      "projectId": "string",      "privacyLevel": "private",      "tags": [        "string"      ],      "metadata": "string",      "additionalInfo": "string",      "origin": "user_upload",      "originWorkflowId": "string",      "sourceFileId": "string",      "enrichmentStatus": "pending",      "placeholder": "string",      "contentHash": "string",      "folderId": "string"    }  ]}
POST
/v2/shared-results

Authorization

openIdConnect
OpenID Connect<token>

Request Body

Create shared result payload

application/json
  1. body
projectId*string
Length24 <= length <= 24
pipelineId*string
Formatuuid
durationHours*number
Range0 < value

Response Body

Shared result created

application/json
  1. response
id*string
Length24 <= length <= 24
curl -X POST "https://example.com/v2/shared-results" \  -H "Content-Type: application/json" \  -d '{    "projectId": "stringstringstringstring",    "pipelineId": "621ef2b0-ba1d-48e5-89dc-b778e6ed42fd",    "durationHours": 1  }'
{  "id": "stringstringstringstring"}
GET
/v2/shared-results/:id

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Shared result details retrieved

application/json
  1. response
id*string
Length24 <= length <= 24
projectId*string
Length24 <= length <= 24
projectName*string
pipelineId*string
Formatuuid
workflows*array<>
pipelineFiles*
workflowFiles*
curl -X GET "https://example.com/v2/shared-results/:id"
{  "id": "stringstringstringstring",  "projectId": "stringstringstringstring",  "projectName": "string",  "pipelineId": "621ef2b0-ba1d-48e5-89dc-b778e6ed42fd",  "workflows": [    {      "id": "stringstringstringstring",      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",      "projectId": "stringstringstringstring",      "pipelineId": "621ef2b0-ba1d-48e5-89dc-b778e6ed42fd",      "pipelineName": "string",      "n8nWorkflowName": "string",      "status": "string",      "statusMessage": "string",      "aiInterpretation": "string",      "result": "string",      "createdAt": "string"    }  ],  "pipelineFiles": {    "input": [      {        "id": "stringstringstringstring",        "name": "string",        "size": 0,        "type": "string",        "projectId": "stringstringstringstring",        "originWorkflowId": "stringstringstringstring",        "createdAt": "string",        "url": "string"      }    ],    "output": [      {        "id": "stringstringstringstring",        "name": "string",        "size": 0,        "type": "string",        "projectId": "stringstringstringstring",        "originWorkflowId": "stringstringstringstring",        "createdAt": "string",        "url": "string"      }    ]  },  "workflowFiles": {    "property1": [      {        "id": "stringstringstringstring",        "name": "string",        "size": 0,        "type": "string",        "projectId": "stringstringstringstring",        "originWorkflowId": "stringstringstringstring",        "createdAt": "string",        "url": "string"      }    ],    "property2": [      {        "id": "stringstringstringstring",        "name": "string",        "size": 0,        "type": "string",        "projectId": "stringstringstringstring",        "originWorkflowId": "stringstringstringstring",        "createdAt": "string",        "url": "string"      }    ]  }}
GET
/v2/survey-templates

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

projectId?string
Length24 <= length <= 24
scope?string
Value in"project""organization""public"

Response Body

List of survey templates with their latest version

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/survey-templates"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "description": "string",    "scope": "project",    "language": "en",    "projectId": "string",    "organizationId": "string",    "latestVersion": {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "templateId": "string",      "versionNumber": -2147483648,      "surveyJs": "string",      "authorId": "string"    }  }]
GET
/v2/survey-templates/:templateId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

templateId*string
Formatcuid2

Response Body

Survey template with latest version

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string|null
scope*string
Value in"project""organization""public"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
latestVersion*|null
curl -X GET "https://example.com/v2/survey-templates/:templateId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "scope": "project",  "language": "en",  "projectId": "string",  "organizationId": "string",  "latestVersion": {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "templateId": "string",    "versionNumber": -2147483648,    "surveyJs": "string",    "authorId": "string"  }}
PUT
/v2/survey-templates/:templateId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

templateId*string
Formatcuid2

Request Body

Updated template data

application/json
  1. body
name?string
description?string|null
scope?string
Value in"project""organization""public"
language?string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
surveyJs?

Response Body

Updated survey template with latest version

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string|null
scope*string
Value in"project""organization""public"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
latestVersion*|null
curl -X PUT "https://example.com/v2/survey-templates/:templateId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "scope": "project",  "language": "en",  "projectId": "string",  "organizationId": "string",  "latestVersion": {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "templateId": "string",    "versionNumber": -2147483648,    "surveyJs": "string",    "authorId": "string"  }}
DELETE
/v2/survey-templates/:templateId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

templateId*string
Formatcuid2

Response Body

Deleted survey template

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string|null
scope*string
Value in"project""organization""public"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
latestVersion*|null
curl -X DELETE "https://example.com/v2/survey-templates/:templateId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "scope": "project",  "language": "en",  "projectId": "string",  "organizationId": "string",  "latestVersion": {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "templateId": "string",    "versionNumber": -2147483648,    "surveyJs": "string",    "authorId": "string"  }}
GET
/v2/survey-templates/:templateId/versions

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

templateId*string
Formatcuid2

Response Body

Version history newest-first

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/survey-templates/:templateId/versions"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "templateId": "string",    "versionNumber": -2147483648,    "surveyJs": "string",    "authorId": "string"  }]
DELETE
/v2/survey-templates/:templateId/versions/:versionId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

templateId*string
Length24 <= length <= 24
versionId*string
Length24 <= length <= 24

Response Body

Deleted version

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
templateId*string
Lengthlength <= 24
versionNumber*integer
Range-2147483648 <= value <= 2147483647
surveyJs*string|number|boolean|null||array<unknown>
authorId*string
Lengthlength <= 24
curl -X DELETE "https://example.com/v2/survey-templates/:templateId/versions/:versionId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "templateId": "string",  "versionNumber": -2147483648,  "surveyJs": "string",  "authorId": "string"}
GET
/v2/input-data

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

projectId?string
Length24 <= length <= 24
scope?string
Value in"project""organization"

Response Body

List of input data sets

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/input-data"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "description": "string",    "scope": "project",    "language": "en",    "projectId": "string",    "organizationId": "string",    "uploaderId": "string"  }]
GET
/v2/input-data/:dataSetId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

dataSetId*string
Formatcuid2

Response Body

Input data set with lists and groups

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string|null
scope*string
Value in"project""organization"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
uploaderId*|
Lengthlength <= 24
lists*array<>
groups*array<>
curl -X GET "https://example.com/v2/input-data/:dataSetId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "scope": "project",  "language": "en",  "projectId": "string",  "organizationId": "string",  "uploaderId": "string",  "lists": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "name": "string",      "values": "string",      "dataSetId": "string"    }  ],  "groups": [    {      "id": "string",      "name": "string",      "lists": [        {          "id": "string",          "name": "string",          "values": "string"        }      ]    }  ]}
PUT
/v2/input-data/:dataSetId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

dataSetId*string
Formatcuid2

Request Body

Updated data set metadata

application/json
  1. body
name?string
description?string|null
scope?string
Value in"project""organization"
language?string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"

Response Body

Updated input data set

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string|null
scope*string
Value in"project""organization"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
uploaderId*|
Lengthlength <= 24
lists*array<>
groups*array<>
curl -X PUT "https://example.com/v2/input-data/:dataSetId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "scope": "project",  "language": "en",  "projectId": "string",  "organizationId": "string",  "uploaderId": "string",  "lists": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "name": "string",      "values": "string",      "dataSetId": "string"    }  ],  "groups": [    {      "id": "string",      "name": "string",      "lists": [        {          "id": "string",          "name": "string",          "values": "string"        }      ]    }  ]}
DELETE
/v2/input-data/:dataSetId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

dataSetId*string
Formatcuid2

Response Body

Deleted input data set

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string|null
scope*string
Value in"project""organization"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
uploaderId*|
Lengthlength <= 24
curl -X DELETE "https://example.com/v2/input-data/:dataSetId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "scope": "project",  "language": "en",  "projectId": "string",  "organizationId": "string",  "uploaderId": "string"}
GET
/v2/input-data/:dataSetId/variants

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

dataSetId*string
Formatcuid2

Response Body

Computed variants from input data lists and groups

application/json
  1. response
count*number
variants*array<>
curl -X GET "https://example.com/v2/input-data/:dataSetId/variants"
{  "count": 0,  "variants": [    {      "index": 0,      "slots": [        {          "type": "list",          "id": "string",          "name": "string",          "valueIndex": 0,          "values": {            "property1": "string",            "property2": "string"          }        }      ]    }  ]}
POST
/v2/input-data/:dataSetId/lists

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

dataSetId*string
Formatcuid2

Request Body

New list (column) definition

application/json
  1. body
name*string
Length1 <= length
values*array<string>
Items1 <= items

Response Body

Created list

application/json
  1. response
id*string
Lengthlength <= 24
name*string
values*string|number|boolean|null||array<unknown>
curl -X POST "https://example.com/v2/input-data/:dataSetId/lists" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "values": [      "string"    ]  }'
{  "id": "string",  "name": "string",  "values": "string"}
DELETE
/v2/input-data/:dataSetId/lists/:listId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

dataSetId*string
Length24 <= length <= 24
listId*string
Length24 <= length <= 24

Response Body

Deleted list

application/json
  1. response
id*string
Lengthlength <= 24
name*string
values*string|number|boolean|null||array<unknown>
curl -X DELETE "https://example.com/v2/input-data/:dataSetId/lists/:listId"
{  "id": "string",  "name": "string",  "values": "string"}
POST
/v2/input-data/:dataSetId/groups

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

dataSetId*string
Formatcuid2

Request Body

New group definition

application/json
  1. body
name*string
Length1 <= length
listNames*array<string>
Items2 <= items

Response Body

Created group

application/json
  1. response
id*string
Lengthlength <= 24
name*string
lists*array<>
curl -X POST "https://example.com/v2/input-data/:dataSetId/groups" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "listNames": [      "string",      "string"    ]  }'
{  "id": "string",  "name": "string",  "lists": [    {      "id": "string",      "name": "string",      "values": "string"    }  ]}
PUT
/v2/input-data/:dataSetId/groups/:groupId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

dataSetId*string
Length24 <= length <= 24
groupId*string
Length24 <= length <= 24

Request Body

Updated group definition

application/json
  1. body
name?string
Length1 <= length
listNames?array<string>
Items2 <= items

Response Body

Updated group

application/json
  1. response
id*string
Lengthlength <= 24
name*string
lists*array<>
curl -X PUT "https://example.com/v2/input-data/:dataSetId/groups/:groupId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "lists": [    {      "id": "string",      "name": "string",      "values": "string"    }  ]}
DELETE
/v2/input-data/:dataSetId/groups/:groupId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

dataSetId*string
Length24 <= length <= 24
groupId*string
Length24 <= length <= 24

Response Body

Deleted group

application/json
  1. response
id*string
Lengthlength <= 24
name*string
lists*array<>
curl -X DELETE "https://example.com/v2/input-data/:dataSetId/groups/:groupId"
{  "id": "string",  "name": "string",  "lists": [    {      "id": "string",      "name": "string",      "values": "string"    }  ]}
GET
/v2/verification-contexts

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

projectId?string
Length24 <= length <= 24

Response Body

List of verification contexts

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/verification-contexts"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "description": "string",    "projectId": "string",    "organizationId": "string",    "contextData": "string",    "isDefault": true  }]
GET
/v2/verification-contexts/:contextId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

contextId*string
Formatcuid2

Response Body

Verification context

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string|null
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
contextData*string|number|boolean|null||array<unknown>
isDefault*boolean
curl -X GET "https://example.com/v2/verification-contexts/:contextId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "projectId": "string",  "organizationId": "string",  "contextData": "string",  "isDefault": true}
PUT
/v2/verification-contexts/:contextId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

contextId*string
Formatcuid2

Request Body

Updated context data

application/json
  1. body
name?string
description?string|null
contextData?
isDefault?boolean

Response Body

Updated verification context

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string|null
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
contextData*string|number|boolean|null||array<unknown>
isDefault*boolean
curl -X PUT "https://example.com/v2/verification-contexts/:contextId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "projectId": "string",  "organizationId": "string",  "contextData": "string",  "isDefault": true}
DELETE
/v2/verification-contexts/:contextId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

contextId*string
Formatcuid2

Response Body

Deleted verification context

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string|null
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
contextData*string|number|boolean|null||array<unknown>
isDefault*boolean
curl -X DELETE "https://example.com/v2/verification-contexts/:contextId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "projectId": "string",  "organizationId": "string",  "contextData": "string",  "isDefault": true}
GET
/v2/verification-runs

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

status?string
Value in"pending""running""awaiting_crowd""completed""failed"

Response Body

Org-level verification runs

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/verification-runs"
[  {    "id": "string",    "pipelineSlug": "string",    "status": "pending",    "verdict": "authentic",    "confidence": "string",    "projectId": "string",    "projectName": "string",    "fileCount": 0,    "createdAt": "string",    "updatedAt": "string"  }]
GET
/v2/compliance/checks

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Compliance checks with score

application/json
  1. response
checks*array<>
score*number
compliantCount*integer
warningCount*integer
nonCompliantCount*integer
curl -X GET "https://example.com/v2/compliance/checks"
{  "checks": [    {      "id": "string",      "organizationId": "string",      "regulation": "string",      "category": "string",      "status": "compliant",      "details": "string",      "actionRequired": "string",      "lastCheckedAt": "string",      "createdAt": "string",      "updatedAt": "string"    }  ],  "score": 0,  "compliantCount": 0,  "warningCount": 0,  "nonCompliantCount": 0}
POST
/v2/compliance/checks

Authorization

openIdConnect
OpenID Connect<token>

Request Body

New compliance check

application/json
  1. body
regulation*string
Length1 <= length
category*string
Length1 <= length
status?string
Value in"compliant""warning""non_compliant"
details*string
Length1 <= length
actionRequired?string

Response Body

Created compliance check

application/json
  1. response
id*string
organizationId*string
regulation*string
category*string
status*string
Value in"compliant""warning""non_compliant"
details*string
actionRequired*string|null
lastCheckedAt*string||null
createdAt*string||null
updatedAt*string||null
curl -X POST "https://example.com/v2/compliance/checks" \  -H "Content-Type: application/json" \  -d '{    "regulation": "string",    "category": "string",    "details": "string"  }'
{  "id": "string",  "organizationId": "string",  "regulation": "string",  "category": "string",  "status": "compliant",  "details": "string",  "actionRequired": "string",  "lastCheckedAt": "string",  "createdAt": "string",  "updatedAt": "string"}
POST
/v2/compliance/checks/run

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Updated checks after run

application/json
  1. response
checks*array<>
score*number
compliantCount*integer
warningCount*integer
nonCompliantCount*integer
curl -X POST "https://example.com/v2/compliance/checks/run"
{  "checks": [    {      "id": "string",      "organizationId": "string",      "regulation": "string",      "category": "string",      "status": "compliant",      "details": "string",      "actionRequired": "string",      "lastCheckedAt": "string",      "createdAt": "string",      "updatedAt": "string"    }  ],  "score": 0,  "compliantCount": 0,  "warningCount": 0,  "nonCompliantCount": 0}
PATCH
/v2/compliance/checks/:checkId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

checkId*string
Length24 <= length <= 24

Request Body

Updated compliance check fields

application/json
  1. body
status?string
Value in"compliant""warning""non_compliant"
details?string
Length1 <= length
actionRequired?string|null
lastCheckedAt?string
Formatdate-time

Response Body

Updated compliance check

application/json
  1. response
id*string
organizationId*string
regulation*string
category*string
status*string
Value in"compliant""warning""non_compliant"
details*string
actionRequired*string|null
lastCheckedAt*string||null
createdAt*string||null
updatedAt*string||null
curl -X PATCH "https://example.com/v2/compliance/checks/:checkId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "organizationId": "string",  "regulation": "string",  "category": "string",  "status": "compliant",  "details": "string",  "actionRequired": "string",  "lastCheckedAt": "string",  "createdAt": "string",  "updatedAt": "string"}
DELETE
/v2/compliance/checks/:checkId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

checkId*string
Length24 <= length <= 24

Response Body

Check deleted

curl -X DELETE "https://example.com/v2/compliance/checks/:checkId"
Empty
GET
/v2/compliance/audit-events

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

limit?integer
Range1 <= value <= 200
Default50

Response Body

Audit events

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/compliance/audit-events"
[  {    "id": "string",    "organizationId": "string",    "action": "string",    "userName": "string",    "userId": "string",    "regulation": "string",    "result": "pass",    "metadata": {      "property1": null,      "property2": null    },    "createdAt": "string"  }]
POST
/v2/compliance/audit-events

Authorization

openIdConnect
OpenID Connect<token>

Request Body

New audit event

application/json
  1. body
action*string
Length1 <= length
regulation*string
Length1 <= length
result?string
Value in"pass""info""warning"
metadata?

Response Body

Created audit event

application/json
  1. response
id*string
organizationId*string
action*string
userName*string
userId*string|null
regulation*string
result*string
Value in"pass""info""warning"
metadata*|null
createdAt*string||null
curl -X POST "https://example.com/v2/compliance/audit-events" \  -H "Content-Type: application/json" \  -d '{    "action": "string",    "regulation": "string"  }'
{  "id": "string",  "organizationId": "string",  "action": "string",  "userName": "string",  "userId": "string",  "regulation": "string",  "result": "pass",  "metadata": {    "property1": null,    "property2": null  },  "createdAt": "string"}
GET
/v2/compliance/exports

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Compliance exports

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/compliance/exports"
[  {    "id": "string",    "organizationId": "string",    "projectId": "string",    "projectName": "string",    "requestedByUserId": "string",    "requestedByName": "string",    "regulation": "string",    "dueDate": "string",    "status": "pending",    "createdAt": "string",    "updatedAt": "string"  }]
POST
/v2/compliance/exports

Authorization

openIdConnect
OpenID Connect<token>

Request Body

New compliance export

application/json
  1. body
projectName*string
Length1 <= length
projectId?string
Length24 <= length <= 24
regulation*string
Length1 <= length
dueDate*string
Formatdate-time

Response Body

Created compliance export

application/json
  1. response
id*string
organizationId*string
projectId*string|null
projectName*string
requestedByUserId*string|null
requestedByName*string
regulation*string
dueDate*string|
status*string
Value in"pending""in_progress""completed""cancelled"
createdAt*string||null
updatedAt*string||null
curl -X POST "https://example.com/v2/compliance/exports" \  -H "Content-Type: application/json" \  -d '{    "projectName": "string",    "regulation": "string",    "dueDate": "2019-08-24T14:15:22Z"  }'
{  "id": "string",  "organizationId": "string",  "projectId": "string",  "projectName": "string",  "requestedByUserId": "string",  "requestedByName": "string",  "regulation": "string",  "dueDate": "string",  "status": "pending",  "createdAt": "string",  "updatedAt": "string"}
PATCH
/v2/compliance/exports/:exportId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

exportId*string
Length24 <= length <= 24

Request Body

Updated export status

application/json
  1. body
status*string
Value in"pending""in_progress""completed""cancelled"

Response Body

Updated compliance export

application/json
  1. response
id*string
organizationId*string
projectId*string|null
projectName*string
requestedByUserId*string|null
requestedByName*string
regulation*string
dueDate*string|
status*string
Value in"pending""in_progress""completed""cancelled"
createdAt*string||null
updatedAt*string||null
curl -X PATCH "https://example.com/v2/compliance/exports/:exportId" \  -H "Content-Type: application/json" \  -d '{    "status": "pending"  }'
{  "id": "string",  "organizationId": "string",  "projectId": "string",  "projectName": "string",  "requestedByUserId": "string",  "requestedByName": "string",  "regulation": "string",  "dueDate": "string",  "status": "pending",  "createdAt": "string",  "updatedAt": "string"}
DELETE
/v2/compliance/exports/:exportId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

exportId*string
Length24 <= length <= 24

Response Body

Export cancelled/deleted

curl -X DELETE "https://example.com/v2/compliance/exports/:exportId"
Empty
GET
/v2/datasets/catalog/cleaning-pipelines

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Available cleaning pipelines

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/datasets/catalog/cleaning-pipelines"
[  {    "slug": "string",    "name": "string",    "description": "string",    "supportedModalities": [      "image"    ]  }]
GET
/v2/datasets

Authorization

openIdConnect
OpenID Connect<token>

Response Body

List of org datasets

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/datasets"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "internalId": "string",    "name": "string",    "description": "string",    "modality": "image",    "organizationId": "string",    "createdById": "string",    "versionCount": 0  }]
POST
/v2/datasets

Authorization

openIdConnect
OpenID Connect<token>

Request Body

New dataset

application/json
  1. body
internalId*string
Match^[\w-]+$
Length1 <= length <= 100
name*string
description?string|null
modality*string
Value in"image""audio""video""text""document""multimodal"
organizationId*string
Lengthlength <= 24
createdById?|
Lengthlength <= 24

Response Body

Created dataset

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
internalId*string
Lengthlength <= 100
name*string
description*string|null
modality*string
Value in"image""audio""video""text""document""multimodal"
organizationId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
curl -X POST "https://example.com/v2/datasets" \  -H "Content-Type: application/json" \  -d '{    "internalId": "string",    "name": "string",    "modality": "image",    "organizationId": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "internalId": "string",  "name": "string",  "description": "string",  "modality": "image",  "organizationId": "string",  "createdById": "string"}
GET
/v2/datasets/:datasetId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Response Body

Dataset with versions

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
internalId*string
Lengthlength <= 100
name*string
description*string|null
modality*string
Value in"image""audio""video""text""document""multimodal"
organizationId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
versions*array<>
curl -X GET "https://example.com/v2/datasets/:datasetId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "internalId": "string",  "name": "string",  "description": "string",  "modality": "image",  "organizationId": "string",  "createdById": "string",  "versions": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "datasetId": "string",      "state": "raw",      "label": "string",      "parentVersionId": "string",      "cleaningPipelineSlug": "string",      "jobId": "string",      "fileCount": -2147483648,      "error": "string"    }  ]}
PATCH
/v2/datasets/:datasetId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Request Body

Updated dataset metadata

application/json
  1. body
name?string
description?string|null

Response Body

Updated dataset

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
internalId*string
Lengthlength <= 100
name*string
description*string|null
modality*string
Value in"image""audio""video""text""document""multimodal"
organizationId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
curl -X PATCH "https://example.com/v2/datasets/:datasetId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "internalId": "string",  "name": "string",  "description": "string",  "modality": "image",  "organizationId": "string",  "createdById": "string"}
DELETE
/v2/datasets/:datasetId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Response Body

Deleted dataset

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
internalId*string
Lengthlength <= 100
name*string
description*string|null
modality*string
Value in"image""audio""video""text""document""multimodal"
organizationId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
curl -X DELETE "https://example.com/v2/datasets/:datasetId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "internalId": "string",  "name": "string",  "description": "string",  "modality": "image",  "organizationId": "string",  "createdById": "string"}
POST
/v2/datasets/:datasetId/files

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Request Body

multipart/form-data
  1. body
file[]*|

Response Body

Uploaded files

application/json
  1. response
[index: integer]?
curl -X POST "https://example.com/v2/datasets/:datasetId/files" \  -F file[]="string"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "type": "string",    "size": -2147483648,    "path": "string",    "etag": "string",    "organizationId": "string",    "uploaderId": "string",    "lastModified": "2019-08-24T14:15:22Z",    "projectId": "string",    "privacyLevel": "private",    "tags": [      "string"    ],    "metadata": "string",    "additionalInfo": "string",    "origin": "user_upload",    "originWorkflowId": "string",    "sourceFileId": "string",    "enrichmentStatus": "pending",    "placeholder": "string",    "contentHash": "string",    "folderId": "string"  }]
DELETE
/v2/datasets/:datasetId/files/:fileId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Length24 <= length <= 24
fileId*string
Length24 <= length <= 24

Response Body

Removed file

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
type*string
size*integer
Range-2147483648 <= value <= 2147483647
path*string
etag*string
organizationId*string
Lengthlength <= 24
uploaderId*string
Lengthlength <= 24
lastModified*|
Formatdate-time
projectId*|
Lengthlength <= 24
privacyLevel*string
Value in"private""sensitive""internal""public"
tags*array<string>|null
metadata*string|number|boolean|null||array<unknown>
additionalInfo*string|number|boolean|null||array<unknown>
origin*string
Value in"user_upload""workflow_generated"
originWorkflowId*|
Lengthlength <= 24
sourceFileId*|
Lengthlength <= 24
enrichmentStatus*|
Value in"pending""running""completed""failed"null
placeholder*string|null
contentHash*string|null
folderId*|
Lengthlength <= 24
curl -X DELETE "https://example.com/v2/datasets/:datasetId/files/:fileId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "type": "string",  "size": -2147483648,  "path": "string",  "etag": "string",  "organizationId": "string",  "uploaderId": "string",  "lastModified": "2019-08-24T14:15:22Z",  "projectId": "string",  "privacyLevel": "private",  "tags": [    "string"  ],  "metadata": "string",  "additionalInfo": "string",  "origin": "user_upload",  "originWorkflowId": "string",  "sourceFileId": "string",  "enrichmentStatus": "pending",  "placeholder": "string",  "contentHash": "string",  "folderId": "string"}
GET
/v2/datasets/:datasetId/versions

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Response Body

Dataset versions

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/datasets/:datasetId/versions"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "datasetId": "string",    "state": "raw",    "label": "string",    "parentVersionId": "string",    "cleaningPipelineSlug": "string",    "jobId": "string",    "fileCount": -2147483648,    "error": "string"  }]
GET
/v2/datasets/:datasetId/versions/:versionId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Length24 <= length <= 24
versionId*string
Length24 <= length <= 24

Query Parameters

page?integer
Range1 <= value
Default1
limit?integer
Range1 <= value <= 200
Default50

Response Body

Version with files

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
datasetId*string
Lengthlength <= 24
state*string
Value in"raw""cleaning""cleaned""enriching""cleaned_and_enriched""failed"
label*string|null
parentVersionId*|
Lengthlength <= 24
cleaningPipelineSlug*string|null
jobId*string|null
fileCount*integer
Range-2147483648 <= value <= 2147483647
error*string|null
files*array<>
curl -X GET "https://example.com/v2/datasets/:datasetId/versions/:versionId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "datasetId": "string",  "state": "raw",  "label": "string",  "parentVersionId": "string",  "cleaningPipelineSlug": "string",  "jobId": "string",  "fileCount": -2147483648,  "error": "string",  "files": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "name": "string",      "type": "string",      "size": -2147483648,      "path": "string",      "etag": "string",      "organizationId": "string",      "uploaderId": "string",      "lastModified": "2019-08-24T14:15:22Z",      "projectId": "string",      "privacyLevel": "private",      "tags": [        "string"      ],      "metadata": "string",      "additionalInfo": "string",      "origin": "user_upload",      "originWorkflowId": "string",      "sourceFileId": "string",      "enrichmentStatus": "pending",      "placeholder": "string",      "contentHash": "string",      "folderId": "string",      "excludedAt": "string"    }  ]}
PATCH
/v2/datasets/:datasetId/versions/:versionId/files/:fileId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Length24 <= length <= 24
versionId*string
Length24 <= length <= 24
fileId*string
Length24 <= length <= 24

Request Body

Whether this file should be excluded from the version

application/json
  1. body
excluded*boolean

Response Body

Updated dataset_version_files row

application/json
  1. response
datasetVersionId*string
fileId*string
excludedAt*string||null
curl -X PATCH "https://example.com/v2/datasets/:datasetId/versions/:versionId/files/:fileId" \  -H "Content-Type: application/json" \  -d '{    "excluded": true  }'
{  "datasetVersionId": "string",  "fileId": "string",  "excludedAt": "string"}
POST
/v2/datasets/:datasetId/versions/:versionId/clean

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Length24 <= length <= 24
versionId*string
Length24 <= length <= 24

Request Body

Cleaning pipeline configuration

application/json
  1. body
pipelineSlug*"clean-audio-silence"
Value in"clean-audio-silence"
label?string
Lengthlength <= 100

Response Body

New derived version

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
datasetId*string
Lengthlength <= 24
state*string
Value in"raw""cleaning""cleaned""enriching""cleaned_and_enriched""failed"
label*string|null
parentVersionId*|
Lengthlength <= 24
cleaningPipelineSlug*string|null
jobId*string|null
fileCount*integer
Range-2147483648 <= value <= 2147483647
error*string|null
curl -X POST "https://example.com/v2/datasets/:datasetId/versions/:versionId/clean" \  -H "Content-Type: application/json" \  -d '{    "pipelineSlug": "clean-audio-silence"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "datasetId": "string",  "state": "raw",  "label": "string",  "parentVersionId": "string",  "cleaningPipelineSlug": "string",  "jobId": "string",  "fileCount": -2147483648,  "error": "string"}
POST
/v2/datasets/:datasetId/versions/:versionId/enrich

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Length24 <= length <= 24
versionId*string
Length24 <= length <= 24

Response Body

Version with enrichment triggered

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
datasetId*string
Lengthlength <= 24
state*string
Value in"raw""cleaning""cleaned""enriching""cleaned_and_enriched""failed"
label*string|null
parentVersionId*|
Lengthlength <= 24
cleaningPipelineSlug*string|null
jobId*string|null
fileCount*integer
Range-2147483648 <= value <= 2147483647
error*string|null
curl -X POST "https://example.com/v2/datasets/:datasetId/versions/:versionId/enrich"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "datasetId": "string",  "state": "raw",  "label": "string",  "parentVersionId": "string",  "cleaningPipelineSlug": "string",  "jobId": "string",  "fileCount": -2147483648,  "error": "string"}
GET
/v2/datasets/:datasetId/versions/:versionId/export

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Length24 <= length <= 24
versionId*string
Length24 <= length <= 24

Response Body

Presigned URLs for all files in the version

application/json
  1. response
files*array<>
curl -X GET "https://example.com/v2/datasets/:datasetId/versions/:versionId/export"
{  "files": [    {      "fileId": "string",      "name": "string",      "mimeType": "string",      "size": 0,      "url": "string"    }  ]}
GET
/v2/lt-pipelines/catalog

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Available LT pipelines

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/lt-pipelines/catalog"
[  {    "slug": "string",    "name": "string",    "description": "string",    "status": "active",    "estimatedMinutes": 0,    "modality": "text",    "costCredits": 0,    "requiredFiles": [      {        "label": "string",        "description": "string",        "mimeTypes": [          "string"        ],        "minCount": 0,        "maxCount": 0      }    ],    "requiredContextFields": [      {        "key": "string",        "label": "string",        "description": "string",        "type": "string",        "enumValues": [          "string"        ]      }    ],    "optionalContextFields": [      {        "key": "string",        "label": "string",        "description": "string",        "type": "string",        "enumValues": [          "string"        ]      }    ],    "stages": [      {        "slug": "string",        "name": "string",        "type": "lt-ai",        "description": "string"      }    ]  }]
POST
/v2/lt-pipelines/project/:projectId/run

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string

Request Body

LT pipeline run request

application/json
  1. body
pipelineSlug*string
fileIds*array<string>
Items1 <= items
contextData?

Response Body

LT pipeline runs created

application/json
  1. response
runIds*array<string>
curl -X POST "https://example.com/v2/lt-pipelines/project/:projectId/run" \  -H "Content-Type: application/json" \  -d '{    "pipelineSlug": "string",    "fileIds": [      "string"    ]  }'
{  "runIds": [    "string"  ]}
GET
/v2/lt-pipelines/project/:projectId/runs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string

Query Parameters

status?string
Value in"pending""running""completed""failed"

Response Body

Project LT runs

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/lt-pipelines/project/:projectId/runs"
[  {    "id": "string",    "pipelineSlug": "string",    "fileId": "string",    "projectId": "string",    "datasetVersionId": "string",    "organizationId": "string",    "status": "pending",    "result": null,    "contextData": null,    "error": "string",    "createdAt": "string",    "updatedAt": "string"  }]
POST
/v2/lt-pipelines/dataset/:datasetId/versions/:versionId/run

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
versionId*string

Request Body

LT pipeline dataset version run request

application/json
  1. body
pipelineSlug*string
contextData?

Response Body

LT pipeline runs created for dataset version

application/json
  1. response
totalFiles*integer
runIds*array<string>
curl -X POST "https://example.com/v2/lt-pipelines/dataset/:datasetId/versions/:versionId/run" \  -H "Content-Type: application/json" \  -d '{    "pipelineSlug": "string"  }'
{  "totalFiles": 0,  "runIds": [    "string"  ]}
GET
/v2/lt-pipelines/dataset/:datasetId/versions/:versionId/runs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
versionId*string

Query Parameters

status?string
Value in"pending""running""completed""failed"

Response Body

Dataset version LT runs

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/lt-pipelines/dataset/:datasetId/versions/:versionId/runs"
[  {    "id": "string",    "pipelineSlug": "string",    "fileId": "string",    "projectId": "string",    "datasetVersionId": "string",    "organizationId": "string",    "status": "pending",    "result": null,    "contextData": null,    "error": "string",    "createdAt": "string",    "updatedAt": "string"  }]
GET
/v2/lt-pipelines/runs/:runId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

runId*string

Response Body

LT pipeline run

application/json
  1. response
id*string
pipelineSlug*string
fileId*string
projectId*string|null
datasetVersionId*string|null
organizationId*string
status*string
Value in"pending""running""completed""failed"
result?unknown
contextData?unknown
error*string|null
createdAt*string||null
updatedAt*string||null
curl -X GET "https://example.com/v2/lt-pipelines/runs/:runId"
{  "id": "string",  "pipelineSlug": "string",  "fileId": "string",  "projectId": "string",  "datasetVersionId": "string",  "organizationId": "string",  "status": "pending",  "result": null,  "contextData": null,  "error": "string",  "createdAt": "string",  "updatedAt": "string"}
GET
/v2/data-platform/pipelines/catalog

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Unified Data Platform pipeline catalog (cleaning + Language Technology)

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/data-platform/pipelines/catalog"
[  {    "slug": "string",    "name": "string",    "description": "string",    "status": "active",    "estimatedMinutes": 0,    "category": "clean",    "executionMode": "lt",    "appliesTo": [      "image"    ],    "targetTypes": [      "project_file"    ],    "producesVersions": true,    "costCredits": 0,    "requiredFiles": [      {        "label": "string",        "description": "string",        "mimeTypes": [          "string"        ],        "minCount": 0,        "maxCount": 0      }    ],    "requiredContextFields": [      {        "key": "string",        "label": "string",        "description": "string",        "type": "string",        "enumValues": [          "string"        ]      }    ],    "optionalContextFields": [      {        "key": "string",        "label": "string",        "description": "string",        "type": "string",        "enumValues": [          "string"        ]      }    ],    "stages": [      {        "slug": "string",        "name": "string",        "type": "lt-ai",        "description": "string"      }    ]  }]
POST
/v2/data-platform/pipelines/:slug/run

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

slug*string

Request Body

Data Platform pipeline run request

application/json
  1. body
targetType*"project_file"
Value in"project_file"
projectId*string
fileIds*array<string>
Items1 <= items
contextData?

Response Body

Data Platform pipeline run created

application/json
  1. response
runId*string
fileCount*integer
trainVersionId?string
valVersionId?string
testVersionId?string
crowdJobId?string
curl -X POST "https://example.com/v2/data-platform/pipelines/:slug/run" \  -H "Content-Type: application/json" \  -d '{    "targetType": "project_file",    "projectId": "string",    "fileIds": [      "string"    ]  }'
{  "runId": "string",  "fileCount": 0,  "trainVersionId": "string",  "valVersionId": "string",  "testVersionId": "string",  "crowdJobId": "string"}
GET
/v2/data-platform/pipelines/runs

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

projectId?string
datasetVersionId?string
status?string
Value in"pending""running""awaiting_crowd""completed""failed"

Response Body

Data Platform pipeline runs

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/data-platform/pipelines/runs"
[  {    "id": "string",    "pipelineSlug": "string",    "targetType": "project_file",    "projectId": "string",    "datasetVersionId": "string",    "organizationId": "string",    "status": "pending",    "contextData": null,    "result": null,    "error": "string",    "createdAt": "string",    "updatedAt": "string",    "completedAt": "string",    "stageRuns": [      {        "id": "string",        "runId": "string",        "fileId": "string",        "stageSlug": "string",        "stageType": "lt-ai",        "stageOrder": 0,        "status": "pending",        "result": null,        "error": "string",        "startedAt": "string",        "completedAt": "string"      }    ]  }]
GET
/v2/data-platform/pipelines/runs/:runId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

runId*string

Response Body

Data Platform pipeline run

application/json
  1. response
id*string
pipelineSlug*string
targetType*string
Value in"project_file""dataset_version"
projectId*string|null
datasetVersionId*string|null
organizationId*string
status*string
Value in"pending""running""awaiting_crowd""completed""failed"
contextData?unknown
result?unknown
error*string|null
createdAt*string||null
updatedAt*string||null
completedAt*string||null
stageRuns?array<>
curl -X GET "https://example.com/v2/data-platform/pipelines/runs/:runId"
{  "id": "string",  "pipelineSlug": "string",  "targetType": "project_file",  "projectId": "string",  "datasetVersionId": "string",  "organizationId": "string",  "status": "pending",  "contextData": null,  "result": null,  "error": "string",  "createdAt": "string",  "updatedAt": "string",  "completedAt": "string",  "stageRuns": [    {      "id": "string",      "runId": "string",      "fileId": "string",      "stageSlug": "string",      "stageType": "lt-ai",      "stageOrder": 0,      "status": "pending",      "result": null,      "error": "string",      "startedAt": "string",      "completedAt": "string"    }  ]}
GET
/v2/data-platform/datasets/catalog/cleaning-pipelines

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Available cleaning pipelines

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/data-platform/datasets/catalog/cleaning-pipelines"
[  {    "slug": "string",    "name": "string",    "description": "string",    "supportedModalities": [      "image"    ]  }]
GET
/v2/data-platform/datasets

Authorization

openIdConnect
OpenID Connect<token>

Response Body

List of org datasets

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/data-platform/datasets"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "internalId": "string",    "name": "string",    "description": "string",    "modality": "image",    "organizationId": "string",    "createdById": "string",    "versionCount": 0  }]
POST
/v2/data-platform/datasets

Authorization

openIdConnect
OpenID Connect<token>

Request Body

New dataset

application/json
  1. body
internalId*string
Match^[\w-]+$
Length1 <= length <= 100
name*string
description?string|null
modality*string
Value in"image""audio""video""text""document""multimodal"
organizationId*string
Lengthlength <= 24
createdById?|
Lengthlength <= 24

Response Body

Created dataset

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
internalId*string
Lengthlength <= 100
name*string
description*string|null
modality*string
Value in"image""audio""video""text""document""multimodal"
organizationId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
curl -X POST "https://example.com/v2/data-platform/datasets" \  -H "Content-Type: application/json" \  -d '{    "internalId": "string",    "name": "string",    "modality": "image",    "organizationId": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "internalId": "string",  "name": "string",  "description": "string",  "modality": "image",  "organizationId": "string",  "createdById": "string"}
GET
/v2/data-platform/datasets/:datasetId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Response Body

Dataset with versions

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
internalId*string
Lengthlength <= 100
name*string
description*string|null
modality*string
Value in"image""audio""video""text""document""multimodal"
organizationId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
versions*array<>
curl -X GET "https://example.com/v2/data-platform/datasets/:datasetId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "internalId": "string",  "name": "string",  "description": "string",  "modality": "image",  "organizationId": "string",  "createdById": "string",  "versions": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "datasetId": "string",      "state": "raw",      "label": "string",      "parentVersionId": "string",      "cleaningPipelineSlug": "string",      "jobId": "string",      "fileCount": -2147483648,      "error": "string"    }  ]}
PATCH
/v2/data-platform/datasets/:datasetId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Request Body

Updated dataset metadata

application/json
  1. body
name?string
description?string|null

Response Body

Updated dataset

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
internalId*string
Lengthlength <= 100
name*string
description*string|null
modality*string
Value in"image""audio""video""text""document""multimodal"
organizationId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
curl -X PATCH "https://example.com/v2/data-platform/datasets/:datasetId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "internalId": "string",  "name": "string",  "description": "string",  "modality": "image",  "organizationId": "string",  "createdById": "string"}
DELETE
/v2/data-platform/datasets/:datasetId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Response Body

Deleted dataset

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
internalId*string
Lengthlength <= 100
name*string
description*string|null
modality*string
Value in"image""audio""video""text""document""multimodal"
organizationId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
curl -X DELETE "https://example.com/v2/data-platform/datasets/:datasetId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "internalId": "string",  "name": "string",  "description": "string",  "modality": "image",  "organizationId": "string",  "createdById": "string"}
POST
/v2/data-platform/datasets/:datasetId/files

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Request Body

multipart/form-data
  1. body
file[]*|

Response Body

Uploaded files

application/json
  1. response
[index: integer]?
curl -X POST "https://example.com/v2/data-platform/datasets/:datasetId/files" \  -F file[]="string"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "type": "string",    "size": -2147483648,    "path": "string",    "etag": "string",    "organizationId": "string",    "uploaderId": "string",    "lastModified": "2019-08-24T14:15:22Z",    "projectId": "string",    "privacyLevel": "private",    "tags": [      "string"    ],    "metadata": "string",    "additionalInfo": "string",    "origin": "user_upload",    "originWorkflowId": "string",    "sourceFileId": "string",    "enrichmentStatus": "pending",    "placeholder": "string",    "contentHash": "string",    "folderId": "string"  }]
DELETE
/v2/data-platform/datasets/:datasetId/files/:fileId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Length24 <= length <= 24
fileId*string
Length24 <= length <= 24

Response Body

Removed file

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
type*string
size*integer
Range-2147483648 <= value <= 2147483647
path*string
etag*string
organizationId*string
Lengthlength <= 24
uploaderId*string
Lengthlength <= 24
lastModified*|
Formatdate-time
projectId*|
Lengthlength <= 24
privacyLevel*string
Value in"private""sensitive""internal""public"
tags*array<string>|null
metadata*string|number|boolean|null||array<unknown>
additionalInfo*string|number|boolean|null||array<unknown>
origin*string
Value in"user_upload""workflow_generated"
originWorkflowId*|
Lengthlength <= 24
sourceFileId*|
Lengthlength <= 24
enrichmentStatus*|
Value in"pending""running""completed""failed"null
placeholder*string|null
contentHash*string|null
folderId*|
Lengthlength <= 24
curl -X DELETE "https://example.com/v2/data-platform/datasets/:datasetId/files/:fileId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "type": "string",  "size": -2147483648,  "path": "string",  "etag": "string",  "organizationId": "string",  "uploaderId": "string",  "lastModified": "2019-08-24T14:15:22Z",  "projectId": "string",  "privacyLevel": "private",  "tags": [    "string"  ],  "metadata": "string",  "additionalInfo": "string",  "origin": "user_upload",  "originWorkflowId": "string",  "sourceFileId": "string",  "enrichmentStatus": "pending",  "placeholder": "string",  "contentHash": "string",  "folderId": "string"}
GET
/v2/data-platform/datasets/:datasetId/versions

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Response Body

Dataset versions

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/data-platform/datasets/:datasetId/versions"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "datasetId": "string",    "state": "raw",    "label": "string",    "parentVersionId": "string",    "cleaningPipelineSlug": "string",    "jobId": "string",    "fileCount": -2147483648,    "error": "string"  }]
GET
/v2/data-platform/datasets/:datasetId/versions/:versionId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Length24 <= length <= 24
versionId*string
Length24 <= length <= 24

Query Parameters

page?integer
Range1 <= value
Default1
limit?integer
Range1 <= value <= 200
Default50

Response Body

Version with files

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
datasetId*string
Lengthlength <= 24
state*string
Value in"raw""cleaning""cleaned""enriching""cleaned_and_enriched""failed"
label*string|null
parentVersionId*|
Lengthlength <= 24
cleaningPipelineSlug*string|null
jobId*string|null
fileCount*integer
Range-2147483648 <= value <= 2147483647
error*string|null
files*array<>
curl -X GET "https://example.com/v2/data-platform/datasets/:datasetId/versions/:versionId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "datasetId": "string",  "state": "raw",  "label": "string",  "parentVersionId": "string",  "cleaningPipelineSlug": "string",  "jobId": "string",  "fileCount": -2147483648,  "error": "string",  "files": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "name": "string",      "type": "string",      "size": -2147483648,      "path": "string",      "etag": "string",      "organizationId": "string",      "uploaderId": "string",      "lastModified": "2019-08-24T14:15:22Z",      "projectId": "string",      "privacyLevel": "private",      "tags": [        "string"      ],      "metadata": "string",      "additionalInfo": "string",      "origin": "user_upload",      "originWorkflowId": "string",      "sourceFileId": "string",      "enrichmentStatus": "pending",      "placeholder": "string",      "contentHash": "string",      "folderId": "string",      "excludedAt": "string"    }  ]}
PATCH
/v2/data-platform/datasets/:datasetId/versions/:versionId/files/:fileId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Length24 <= length <= 24
versionId*string
Length24 <= length <= 24
fileId*string
Length24 <= length <= 24

Request Body

Whether this file should be excluded from the version

application/json
  1. body
excluded*boolean

Response Body

Updated dataset_version_files row

application/json
  1. response
datasetVersionId*string
fileId*string
excludedAt*string||null
curl -X PATCH "https://example.com/v2/data-platform/datasets/:datasetId/versions/:versionId/files/:fileId" \  -H "Content-Type: application/json" \  -d '{    "excluded": true  }'
{  "datasetVersionId": "string",  "fileId": "string",  "excludedAt": "string"}
POST
/v2/data-platform/datasets/:datasetId/versions/:versionId/clean

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Length24 <= length <= 24
versionId*string
Length24 <= length <= 24

Request Body

Cleaning pipeline configuration

application/json
  1. body
pipelineSlug*"clean-audio-silence"
Value in"clean-audio-silence"
label?string
Lengthlength <= 100

Response Body

New derived version

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
datasetId*string
Lengthlength <= 24
state*string
Value in"raw""cleaning""cleaned""enriching""cleaned_and_enriched""failed"
label*string|null
parentVersionId*|
Lengthlength <= 24
cleaningPipelineSlug*string|null
jobId*string|null
fileCount*integer
Range-2147483648 <= value <= 2147483647
error*string|null
curl -X POST "https://example.com/v2/data-platform/datasets/:datasetId/versions/:versionId/clean" \  -H "Content-Type: application/json" \  -d '{    "pipelineSlug": "clean-audio-silence"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "datasetId": "string",  "state": "raw",  "label": "string",  "parentVersionId": "string",  "cleaningPipelineSlug": "string",  "jobId": "string",  "fileCount": -2147483648,  "error": "string"}
POST
/v2/data-platform/datasets/:datasetId/versions/:versionId/enrich

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Length24 <= length <= 24
versionId*string
Length24 <= length <= 24

Response Body

Version with enrichment triggered

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
datasetId*string
Lengthlength <= 24
state*string
Value in"raw""cleaning""cleaned""enriching""cleaned_and_enriched""failed"
label*string|null
parentVersionId*|
Lengthlength <= 24
cleaningPipelineSlug*string|null
jobId*string|null
fileCount*integer
Range-2147483648 <= value <= 2147483647
error*string|null
curl -X POST "https://example.com/v2/data-platform/datasets/:datasetId/versions/:versionId/enrich"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "datasetId": "string",  "state": "raw",  "label": "string",  "parentVersionId": "string",  "cleaningPipelineSlug": "string",  "jobId": "string",  "fileCount": -2147483648,  "error": "string"}
GET
/v2/data-platform/datasets/:datasetId/versions/:versionId/export

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Length24 <= length <= 24
versionId*string
Length24 <= length <= 24

Response Body

Presigned URLs for all files in the version

application/json
  1. response
files*array<>
curl -X GET "https://example.com/v2/data-platform/datasets/:datasetId/versions/:versionId/export"
{  "files": [    {      "fileId": "string",      "name": "string",      "mimeType": "string",      "size": 0,      "url": "string"    }  ]}
GET
/v2/ai-platform/base-models

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Catalog of open-source base models available for finetuning

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/ai-platform/base-models"
[  {    "slug": "string",    "name": "string",    "family": "ministral",    "parameterCount": "string",    "license": "string",    "contextWindow": 0,    "minVramGb": 0,    "recommendedUseCase": "string",    "estimatedMinutes": 0,    "costCredits": 0,    "status": "active"  }]
GET
/v2/ai-platform/finetune-datasets

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Finetune datasets for the active organization

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/ai-platform/finetune-datasets"
[  {    "id": "string",    "organizationId": "string",    "name": "string",    "sourceType": "dataset_version",    "sourceDatasetVersionId": "string",    "sourceCrowdJobId": "string",    "format": "classification",    "s3Path": "string",    "rowCount": 0,    "createdAt": "string",    "updatedAt": "string"  }]
POST
/v2/ai-platform/finetune-datasets

Authorization

openIdConnect
OpenID Connect<token>

Request Body

Assemble a training dataset from a Data Platform dataset version or a Crowd Platform job

application/json
  1. body
sourceType*"dataset_version"
Value in"dataset_version"
datasetId*string
versionId*string
name?string

Response Body

Finetune dataset created

application/json
  1. response
id*string
organizationId*string
name*string
sourceType*string
Value in"dataset_version""crowd_job"
sourceDatasetVersionId*string|null
sourceCrowdJobId*string|null
format*string
Value in"classification""instruction""preference"
s3Path*string
rowCount*integer
createdAt*string||null
updatedAt*string||null
curl -X POST "https://example.com/v2/ai-platform/finetune-datasets" \  -H "Content-Type: application/json" \  -d '{    "sourceType": "dataset_version",    "datasetId": "string",    "versionId": "string"  }'
{  "id": "string",  "organizationId": "string",  "name": "string",  "sourceType": "dataset_version",  "sourceDatasetVersionId": "string",  "sourceCrowdJobId": "string",  "format": "classification",  "s3Path": "string",  "rowCount": 0,  "createdAt": "string",  "updatedAt": "string"}
GET
/v2/ai-platform/finetune-dataset-sources/dataset-versions

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Dataset versions with at least one crowd-label-classify label — the only versions createFinetuneDataset will accept

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/ai-platform/finetune-dataset-sources/dataset-versions"
[  {    "datasetId": "string",    "datasetName": "string",    "versionId": "string",    "versionLabel": "string",    "fileCount": 0,    "labeledFileCount": 0  }]
GET
/v2/ai-platform/finetune-dataset-sources/crowd-jobs

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Crowd jobs with at least one accepted answer — the only jobs createFinetuneDataset will accept

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/ai-platform/finetune-dataset-sources/crowd-jobs"
[  {    "projectId": "string",    "projectName": "string",    "jobId": "string",    "jobName": "string",    "acceptedAnswerCount": 0  }]
POST
/v2/ai-platform/finetune-dataset-sources/instruction-response-template

Authorization

openIdConnect
OpenID Connect<token>

Request Body

Create the pre-built instruction/response capture survey template in a project

application/json
  1. body
projectId*string
name?string

Response Body

Created survey template

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
description*string|null
scope*string
Value in"project""organization""public"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
latestVersion*|null
curl -X POST "https://example.com/v2/ai-platform/finetune-dataset-sources/instruction-response-template" \  -H "Content-Type: application/json" \  -d '{    "projectId": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "description": "string",  "scope": "project",  "language": "en",  "projectId": "string",  "organizationId": "string",  "latestVersion": {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "templateId": "string",    "versionNumber": -2147483648,    "surveyJs": "string",    "authorId": "string"  }}
GET
/v2/ai-platform/finetune-runs

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

status?string
Value in"queued""running""completed""failed"

Response Body

Finetune runs for the active organization

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/ai-platform/finetune-runs"
[  {    "id": "string",    "organizationId": "string",    "finetuneDatasetId": "string",    "baseModelSlug": "string",    "status": "queued",    "hyperparams": null,    "progress": 0,    "error": "string",    "startedAt": "string",    "completedAt": "string",    "createdAt": "string",    "updatedAt": "string",    "resultModelArtifact": {      "id": "string",      "name": "string",      "ollamaTag": "string",      "status": "ready"    }  }]
POST
/v2/ai-platform/finetune-runs

Authorization

openIdConnect
OpenID Connect<token>

Request Body

Start a finetuning run

application/json
  1. body
finetuneDatasetId*string
baseModelSlug*string
hyperparams?

Response Body

Finetune run queued

application/json
  1. response
id*string
organizationId*string
finetuneDatasetId*string
baseModelSlug*string
status*string
Value in"queued""running""completed""failed"
hyperparams?unknown
progress*integer
error*string|null
startedAt*string||null
completedAt*string||null
createdAt*string||null
updatedAt*string||null
resultModelArtifact?|null
curl -X POST "https://example.com/v2/ai-platform/finetune-runs" \  -H "Content-Type: application/json" \  -d '{    "finetuneDatasetId": "string",    "baseModelSlug": "string"  }'
{  "id": "string",  "organizationId": "string",  "finetuneDatasetId": "string",  "baseModelSlug": "string",  "status": "queued",  "hyperparams": null,  "progress": 0,  "error": "string",  "startedAt": "string",  "completedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "resultModelArtifact": {    "id": "string",    "name": "string",    "ollamaTag": "string",    "status": "ready"  }}
GET
/v2/ai-platform/finetune-runs/:runId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

runId*string

Response Body

Finetune run

application/json
  1. response
id*string
organizationId*string
finetuneDatasetId*string
baseModelSlug*string
status*string
Value in"queued""running""completed""failed"
hyperparams?unknown
progress*integer
error*string|null
startedAt*string||null
completedAt*string||null
createdAt*string||null
updatedAt*string||null
resultModelArtifact?|null
curl -X GET "https://example.com/v2/ai-platform/finetune-runs/:runId"
{  "id": "string",  "organizationId": "string",  "finetuneDatasetId": "string",  "baseModelSlug": "string",  "status": "queued",  "hyperparams": null,  "progress": 0,  "error": "string",  "startedAt": "string",  "completedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "resultModelArtifact": {    "id": "string",    "name": "string",    "ollamaTag": "string",    "status": "ready"  }}
GET
/v2/ai-platform/models

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Finetuned models registered for the active organization

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/ai-platform/models"
[  {    "id": "string",    "organizationId": "string",    "finetuneJobId": "string",    "name": "string",    "baseModelSlug": "string",    "ollamaTag": "string",    "sizeBytes": 0,    "status": "ready",    "evalNotes": "string",    "createdAt": "string"  }]
POST
/v2/feedback-reports/submit

Authorization

openIdConnect
OpenID Connect<token>

Request Body

New feedback report

application/json
  1. body
category*string
Value in"feedback""bug""contact""support""security"
sourceApp*string
Value in"platform-v2""app-worker"
message*string
Length1 <= length <= 5000
name?|
Lengthlength <= 200
email?|
Formatemail
Lengthlength <= 320
pageUrl?|
Lengthlength <= 2000
userAgent?string|null
inReviewMessage?string|null
inReviewMessageAt?|
Formatdate-time
resolvedMessage?string|null
resolvedMessageAt?|
Formatdate-time
altchaPayload?string
guestWorkerToken?string

Response Body

The created feedback report

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
category*string
Value in"feedback""bug""contact""support""security"
sourceApp*string
Value in"platform-v2""app-worker"
message*string
name*string|null
email*string|null
pageUrl*string|null
userAgent*string|null
userId*|
Lengthlength <= 24
organizationId*|
Lengthlength <= 24
guestWorkerId*|
Lengthlength <= 24
status*string
Value in"new""in_review""resolved"
inReviewMessage*string|null
inReviewMessageAt*|
Formatdate-time
resolvedMessage*string|null
resolvedMessageAt*|
Formatdate-time
curl -X POST "https://example.com/v2/feedback-reports/submit" \  -H "Content-Type: application/json" \  -d '{    "category": "feedback",    "sourceApp": "platform-v2",    "message": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "category": "feedback",  "sourceApp": "platform-v2",  "message": "string",  "name": "string",  "email": "string",  "pageUrl": "string",  "userAgent": "string",  "userId": "string",  "organizationId": "string",  "guestWorkerId": "string",  "status": "new",  "inReviewMessage": "string",  "inReviewMessageAt": "2019-08-24T14:15:22Z",  "resolvedMessage": "string",  "resolvedMessageAt": "2019-08-24T14:15:22Z"}
GET
/v2/feedback-reports/mine

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

limit?number
Range1 <= value <= 200
Default50
offset?|
Range0 <= value
Default0

Response Body

The current user's own feedback reports

application/json
  1. response
total*number
items*array<>
curl -X GET "https://example.com/v2/feedback-reports/mine"
{  "total": 0,  "items": [    {      "id": "string",      "category": "feedback",      "message": "string",      "status": "new",      "createdAt": "2019-08-24T14:15:22Z",      "inReviewMessage": "string",      "inReviewMessageAt": "2019-08-24T14:15:22Z",      "resolvedMessage": "string",      "resolvedMessageAt": "2019-08-24T14:15:22Z"    }  ]}
GET
/v2/projects/:projectId/crowd-jobs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Length24 <= length <= 24

Query Parameters

status?string
Value in"assignable""not_assignable""no_tasks""finished""archived""paused"
includeArchived?|
Defaultfalse

Response Body

List of crowd jobs

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/projects/:projectId/crowd-jobs"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "title": "string",    "description": "string",    "status": "assignable",    "category": "survey",    "language": "en",    "surveyTemplateVersionId": "string",    "inputDataSetId": "string",    "maxAssignments": -32768,    "maxRepetitionsPerVariant": -2147483648,    "maxWorkTimeMinutes": -2147483648,    "rewardCredits": -9007199254740991,    "creditsBlocked": -9007199254740991,    "platformFeeBlocked": -9007199254740991,    "validFrom": "2019-08-24T14:15:22Z",    "validUntil": "2019-08-24T14:15:22Z",    "qualificationRequirements": "string",    "requiredPanelIds": [      "string"    ],    "verificationCode": "string",    "autoAcceptHours": -2147483648,    "forceUniqueTasks": true,    "isDryRun": true,    "dryRunAllowedEmails": [      "string"    ],    "dryRunMagicToken": "string",    "projectId": "string",    "createdById": "string",    "watcherUserIds": [      "string"    ],    "reviewerUserIds": [      "string"    ],    "noTasksReviewerNotifiedAt": "2019-08-24T14:15:22Z"  }]
POST
/v2/projects/:projectId/crowd-jobs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Length24 <= length <= 24

Request Body

New crowd job

application/json
  1. body
name*string
Length3 <= length <= 100
title*string
Length3 <= length <= 200
description*string
Length3 <= length <= 5000
category*string
Value in"survey""qualification_test""gathering"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
surveyTemplateVersionId*string
Lengthlength <= 24
inputDataSetId?|
Lengthlength <= 24
maxAssignments?integer
Range1 <= value <= 10000
maxRepetitionsPerVariant?integer
Range1 <= value <= 10000
maxWorkTimeMinutes?|
Range1 <= value <= 1440
rewardCredits?integer
Range0 <= value <= 100000
validFrom?|
Formatdate-time
validUntil?|
Formatdate-time
qualificationRequirements?|null
requiredPanelIds?array<>
Itemsitems <= 20
verificationCode?string|null
forceUniqueTasks?boolean
isDryRun?boolean
dryRunAllowedEmails?array<string>
dryRunMagicToken?string|null
watcherUserIds?array<>
Itemsitems <= 50
reviewerUserIds?array<>
Itemsitems <= 50
noTasksReviewerNotifiedAt?|
Formatdate-time
gatheringCriteria?
webhooks?array<>
Itemsitems <= 20

Response Body

Created crowd job

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
title*string
description*string
status*string
Value in"assignable""not_assignable""no_tasks""finished""archived""paused"
category*string
Value in"survey""qualification_test""gathering"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
surveyTemplateVersionId*string
Lengthlength <= 24
inputDataSetId*|
Lengthlength <= 24
maxAssignments*integer
Range-32768 <= value <= 32767
maxRepetitionsPerVariant*integer
Range-2147483648 <= value <= 2147483647
maxWorkTimeMinutes*|
Range-2147483648 <= value <= 2147483647
rewardCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
creditsBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
platformFeeBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
validFrom*|
Formatdate-time
validUntil*|
Formatdate-time
qualificationRequirements*string|number|boolean|null||array<unknown>
requiredPanelIds*array<>
verificationCode*string|null
autoAcceptHours*|
Range-2147483648 <= value <= 2147483647
forceUniqueTasks*boolean
isDryRun*boolean
dryRunAllowedEmails*array<string>
dryRunMagicToken*string|null
projectId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
watcherUserIds*array<>
reviewerUserIds*array<>
noTasksReviewerNotifiedAt*|
Formatdate-time
webhooks?array<>
curl -X POST "https://example.com/v2/projects/:projectId/crowd-jobs" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "title": "string",    "description": "string",    "category": "survey",    "language": "en",    "surveyTemplateVersionId": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "title": "string",  "description": "string",  "status": "assignable",  "category": "survey",  "language": "en",  "surveyTemplateVersionId": "string",  "inputDataSetId": "string",  "maxAssignments": -32768,  "maxRepetitionsPerVariant": -2147483648,  "maxWorkTimeMinutes": -2147483648,  "rewardCredits": -9007199254740991,  "creditsBlocked": -9007199254740991,  "platformFeeBlocked": -9007199254740991,  "validFrom": "2019-08-24T14:15:22Z",  "validUntil": "2019-08-24T14:15:22Z",  "qualificationRequirements": "string",  "requiredPanelIds": [    "string"  ],  "verificationCode": "string",  "autoAcceptHours": -2147483648,  "forceUniqueTasks": true,  "isDryRun": true,  "dryRunAllowedEmails": [    "string"  ],  "dryRunMagicToken": "string",  "projectId": "string",  "createdById": "string",  "watcherUserIds": [    "string"  ],  "reviewerUserIds": [    "string"  ],  "noTasksReviewerNotifiedAt": "2019-08-24T14:15:22Z",  "webhooks": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "jobId": "string",      "url": "string",      "description": "string",      "eventTypes": [        "job.created"      ],      "status": "active",      "consecutiveFailureCount": -2147483648,      "disabledAt": "2019-08-24T14:15:22Z",      "createdById": "string",      "secret": "string"    }  ]}
GET
/v2/projects/:projectId/crowd-jobs/preview-cost

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Length24 <= length <= 24

Query Parameters

rewardCredits?|
Range0 <= value
maxRepetitionsPerVariant*number
Range1 <= value
inputDataSetId?string
Length24 <= length <= 24
isDryRun?boolean|null

Response Body

Cost preview for a not-yet-created crowd job

application/json
  1. response
variantCount*number
maxSlots*number
baseCost*number
platformFeeAmount*number
totalCost*number
organizationBalance*number
sufficientBalance*boolean
curl -X GET "https://example.com/v2/projects/:projectId/crowd-jobs/preview-cost?maxRepetitionsPerVariant=1"
{  "variantCount": 0,  "maxSlots": 0,  "baseCost": 0,  "platformFeeAmount": 0,  "totalCost": 0,  "organizationBalance": 0,  "sufficientBalance": true}
GET
/v2/projects/:projectId/crowd-jobs/preview-compatibility

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Length24 <= length <= 24

Query Parameters

surveyTemplateVersionId*string
Length24 <= length <= 24
inputDataSetId?string
Length24 <= length <= 24

Response Body

Template/input-data variable compatibility for a not-yet-created or not-yet-updated crowd job

application/json
  1. response
missing*array<string>
unused*array<string>
curl -X GET "https://example.com/v2/projects/:projectId/crowd-jobs/preview-compatibility?surveyTemplateVersionId=stringstringstringstring"
{  "missing": [    "string"  ],  "unused": [    "string"  ]}
GET
/v2/projects/:projectId/crowd-jobs/stats-summary

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Length24 <= length <= 24

Query Parameters

group*string
Value in"active""archived""qualification"

Response Body

Aggregated stats across a group of the project's crowd jobs

application/json
  1. response
jobCount*number
maxSlots*number
currentlyWorking*number
submitted*number
accepted*number
rejected*number
pending*number
timedOut*number
cancelled*number
returned*number
earliestCreatedAt*|
Formatdate-time
maxWorkTimeMinutes*number|null
chartData*|null
curl -X GET "https://example.com/v2/projects/:projectId/crowd-jobs/stats-summary?group=active"
{  "jobCount": 0,  "maxSlots": 0,  "currentlyWorking": 0,  "submitted": 0,  "accepted": 0,  "rejected": 0,  "pending": 0,  "timedOut": 0,  "cancelled": 0,  "returned": 0,  "earliestCreatedAt": "2019-08-24T14:15:22Z",  "maxWorkTimeMinutes": 0,  "chartData": {    "jobCreatedAt": "2019-08-24T14:15:22Z",    "answers": [      {        "createdAt": "2019-08-24T14:15:22Z",        "reviewedAt": "2019-08-24T14:15:22Z",        "status": "pending",        "workDuration": 0      }    ]  }}
GET
/v2/crowd-jobs/:jobId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Response Body

Crowd job detail

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
title*string
description*string
status*string
Value in"assignable""not_assignable""no_tasks""finished""archived""paused"
category*string
Value in"survey""qualification_test""gathering"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
surveyTemplateVersionId*string
Lengthlength <= 24
inputDataSetId*|
Lengthlength <= 24
maxAssignments*integer
Range-32768 <= value <= 32767
maxRepetitionsPerVariant*integer
Range-2147483648 <= value <= 2147483647
maxWorkTimeMinutes*|
Range-2147483648 <= value <= 2147483647
rewardCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
creditsBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
platformFeeBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
validFrom*|
Formatdate-time
validUntil*|
Formatdate-time
qualificationRequirements*string|number|boolean|null||array<unknown>
requiredPanelIds*array<>
verificationCode*string|null
autoAcceptHours*|
Range-2147483648 <= value <= 2147483647
forceUniqueTasks*boolean
isDryRun*boolean
dryRunAllowedEmails*array<string>
dryRunMagicToken*string|null
projectId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
watcherUserIds*array<>
reviewerUserIds*array<>
noTasksReviewerNotifiedAt*|
Formatdate-time
computedStatus*string
maxSlots*number
gatheringCriteria?|null
surveyJs*|null
variantCount*number
curl -X GET "https://example.com/v2/crowd-jobs/:jobId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "title": "string",  "description": "string",  "status": "assignable",  "category": "survey",  "language": "en",  "surveyTemplateVersionId": "string",  "inputDataSetId": "string",  "maxAssignments": -32768,  "maxRepetitionsPerVariant": -2147483648,  "maxWorkTimeMinutes": -2147483648,  "rewardCredits": -9007199254740991,  "creditsBlocked": -9007199254740991,  "platformFeeBlocked": -9007199254740991,  "validFrom": "2019-08-24T14:15:22Z",  "validUntil": "2019-08-24T14:15:22Z",  "qualificationRequirements": "string",  "requiredPanelIds": [    "string"  ],  "verificationCode": "string",  "autoAcceptHours": -2147483648,  "forceUniqueTasks": true,  "isDryRun": true,  "dryRunAllowedEmails": [    "string"  ],  "dryRunMagicToken": "string",  "projectId": "string",  "createdById": "string",  "watcherUserIds": [    "string"  ],  "reviewerUserIds": [    "string"  ],  "noTasksReviewerNotifiedAt": "2019-08-24T14:15:22Z",  "computedStatus": "string",  "maxSlots": 0,  "gatheringCriteria": {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "jobId": "string",    "keywords": [      "string"    ],    "platforms": [      "string"    ],    "dateRangeFrom": "2019-08-24T14:15:22Z",    "dateRangeTo": "2019-08-24T14:15:22Z",    "languages": [      "string"    ],    "contentTypes": [      "string"    ],    "minEngagement": "string",    "useWebResearch": true  },  "surveyJs": {    "property1": null,    "property2": null  },  "variantCount": 0}
PUT
/v2/crowd-jobs/:jobId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Request Body

Updated crowd job

application/json
  1. body
name?string
Length3 <= length <= 100
title?string
Length3 <= length <= 200
description?string
Length3 <= length <= 5000
category?string
Value in"survey""qualification_test""gathering"
language?string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
inputDataSetId?|
Lengthlength <= 24
maxAssignments?integer
Range1 <= value <= 10000
maxRepetitionsPerVariant?integer
Range1 <= value <= 10000
maxWorkTimeMinutes?|
Range1 <= value <= 1440
rewardCredits?integer
Range0 <= value <= 100000
validFrom?|
Formatdate-time
validUntil?|
Formatdate-time
qualificationRequirements?|null
requiredPanelIds?array<>
Itemsitems <= 20
verificationCode?string|null
forceUniqueTasks?boolean
isDryRun?boolean
dryRunAllowedEmails?array<string>
dryRunMagicToken?string|null
watcherUserIds?array<>
Itemsitems <= 50
reviewerUserIds?array<>
Itemsitems <= 50
noTasksReviewerNotifiedAt?|
Formatdate-time
surveyTemplateVersionId?string
Length24 <= length <= 24
autoAcceptHours?|
Range0 <= value <= 120

Response Body

Updated crowd job

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
title*string
description*string
status*string
Value in"assignable""not_assignable""no_tasks""finished""archived""paused"
category*string
Value in"survey""qualification_test""gathering"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
surveyTemplateVersionId*string
Lengthlength <= 24
inputDataSetId*|
Lengthlength <= 24
maxAssignments*integer
Range-32768 <= value <= 32767
maxRepetitionsPerVariant*integer
Range-2147483648 <= value <= 2147483647
maxWorkTimeMinutes*|
Range-2147483648 <= value <= 2147483647
rewardCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
creditsBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
platformFeeBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
validFrom*|
Formatdate-time
validUntil*|
Formatdate-time
qualificationRequirements*string|number|boolean|null||array<unknown>
requiredPanelIds*array<>
verificationCode*string|null
autoAcceptHours*|
Range-2147483648 <= value <= 2147483647
forceUniqueTasks*boolean
isDryRun*boolean
dryRunAllowedEmails*array<string>
dryRunMagicToken*string|null
projectId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
watcherUserIds*array<>
reviewerUserIds*array<>
noTasksReviewerNotifiedAt*|
Formatdate-time
curl -X PUT "https://example.com/v2/crowd-jobs/:jobId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "title": "string",  "description": "string",  "status": "assignable",  "category": "survey",  "language": "en",  "surveyTemplateVersionId": "string",  "inputDataSetId": "string",  "maxAssignments": -32768,  "maxRepetitionsPerVariant": -2147483648,  "maxWorkTimeMinutes": -2147483648,  "rewardCredits": -9007199254740991,  "creditsBlocked": -9007199254740991,  "platformFeeBlocked": -9007199254740991,  "validFrom": "2019-08-24T14:15:22Z",  "validUntil": "2019-08-24T14:15:22Z",  "qualificationRequirements": "string",  "requiredPanelIds": [    "string"  ],  "verificationCode": "string",  "autoAcceptHours": -2147483648,  "forceUniqueTasks": true,  "isDryRun": true,  "dryRunAllowedEmails": [    "string"  ],  "dryRunMagicToken": "string",  "projectId": "string",  "createdById": "string",  "watcherUserIds": [    "string"  ],  "reviewerUserIds": [    "string"  ],  "noTasksReviewerNotifiedAt": "2019-08-24T14:15:22Z"}
DELETE
/v2/crowd-jobs/:jobId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Request Body

Pending-answers disposition

application/json
  1. body
pendingAnswersAction?string
Value in"accept""reject"
acceptanceNote?string
Lengthlength <= 500
rejectionReason?string
Lengthlength <= 500
rejectionCategory?string
Value in"too_fast""too_slow""failed_instructions""failed_attention_check""low_effort""missing_or_invalid_data""no_verification_code""invalid_verification_code""suspected_fraud_or_duplicate""unsupported_device_or_technical_issue""other"

Response Body

Archived job

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
title*string
description*string
status*string
Value in"assignable""not_assignable""no_tasks""finished""archived""paused"
category*string
Value in"survey""qualification_test""gathering"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
surveyTemplateVersionId*string
Lengthlength <= 24
inputDataSetId*|
Lengthlength <= 24
maxAssignments*integer
Range-32768 <= value <= 32767
maxRepetitionsPerVariant*integer
Range-2147483648 <= value <= 2147483647
maxWorkTimeMinutes*|
Range-2147483648 <= value <= 2147483647
rewardCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
creditsBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
platformFeeBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
validFrom*|
Formatdate-time
validUntil*|
Formatdate-time
qualificationRequirements*string|number|boolean|null||array<unknown>
requiredPanelIds*array<>
verificationCode*string|null
autoAcceptHours*|
Range-2147483648 <= value <= 2147483647
forceUniqueTasks*boolean
isDryRun*boolean
dryRunAllowedEmails*array<string>
dryRunMagicToken*string|null
projectId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
watcherUserIds*array<>
reviewerUserIds*array<>
noTasksReviewerNotifiedAt*|
Formatdate-time
curl -X DELETE "https://example.com/v2/crowd-jobs/:jobId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "title": "string",  "description": "string",  "status": "assignable",  "category": "survey",  "language": "en",  "surveyTemplateVersionId": "string",  "inputDataSetId": "string",  "maxAssignments": -32768,  "maxRepetitionsPerVariant": -2147483648,  "maxWorkTimeMinutes": -2147483648,  "rewardCredits": -9007199254740991,  "creditsBlocked": -9007199254740991,  "platformFeeBlocked": -9007199254740991,  "validFrom": "2019-08-24T14:15:22Z",  "validUntil": "2019-08-24T14:15:22Z",  "qualificationRequirements": "string",  "requiredPanelIds": [    "string"  ],  "verificationCode": "string",  "autoAcceptHours": -2147483648,  "forceUniqueTasks": true,  "isDryRun": true,  "dryRunAllowedEmails": [    "string"  ],  "dryRunMagicToken": "string",  "projectId": "string",  "createdById": "string",  "watcherUserIds": [    "string"  ],  "reviewerUserIds": [    "string"  ],  "noTasksReviewerNotifiedAt": "2019-08-24T14:15:22Z"}
PATCH
/v2/crowd-jobs/:jobId/pause

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Response Body

Paused job

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
title*string
description*string
status*string
Value in"assignable""not_assignable""no_tasks""finished""archived""paused"
category*string
Value in"survey""qualification_test""gathering"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
surveyTemplateVersionId*string
Lengthlength <= 24
inputDataSetId*|
Lengthlength <= 24
maxAssignments*integer
Range-32768 <= value <= 32767
maxRepetitionsPerVariant*integer
Range-2147483648 <= value <= 2147483647
maxWorkTimeMinutes*|
Range-2147483648 <= value <= 2147483647
rewardCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
creditsBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
platformFeeBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
validFrom*|
Formatdate-time
validUntil*|
Formatdate-time
qualificationRequirements*string|number|boolean|null||array<unknown>
requiredPanelIds*array<>
verificationCode*string|null
autoAcceptHours*|
Range-2147483648 <= value <= 2147483647
forceUniqueTasks*boolean
isDryRun*boolean
dryRunAllowedEmails*array<string>
dryRunMagicToken*string|null
projectId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
watcherUserIds*array<>
reviewerUserIds*array<>
noTasksReviewerNotifiedAt*|
Formatdate-time
curl -X PATCH "https://example.com/v2/crowd-jobs/:jobId/pause"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "title": "string",  "description": "string",  "status": "assignable",  "category": "survey",  "language": "en",  "surveyTemplateVersionId": "string",  "inputDataSetId": "string",  "maxAssignments": -32768,  "maxRepetitionsPerVariant": -2147483648,  "maxWorkTimeMinutes": -2147483648,  "rewardCredits": -9007199254740991,  "creditsBlocked": -9007199254740991,  "platformFeeBlocked": -9007199254740991,  "validFrom": "2019-08-24T14:15:22Z",  "validUntil": "2019-08-24T14:15:22Z",  "qualificationRequirements": "string",  "requiredPanelIds": [    "string"  ],  "verificationCode": "string",  "autoAcceptHours": -2147483648,  "forceUniqueTasks": true,  "isDryRun": true,  "dryRunAllowedEmails": [    "string"  ],  "dryRunMagicToken": "string",  "projectId": "string",  "createdById": "string",  "watcherUserIds": [    "string"  ],  "reviewerUserIds": [    "string"  ],  "noTasksReviewerNotifiedAt": "2019-08-24T14:15:22Z"}
PATCH
/v2/crowd-jobs/:jobId/resume

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Response Body

Resumed job

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
title*string
description*string
status*string
Value in"assignable""not_assignable""no_tasks""finished""archived""paused"
category*string
Value in"survey""qualification_test""gathering"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
surveyTemplateVersionId*string
Lengthlength <= 24
inputDataSetId*|
Lengthlength <= 24
maxAssignments*integer
Range-32768 <= value <= 32767
maxRepetitionsPerVariant*integer
Range-2147483648 <= value <= 2147483647
maxWorkTimeMinutes*|
Range-2147483648 <= value <= 2147483647
rewardCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
creditsBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
platformFeeBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
validFrom*|
Formatdate-time
validUntil*|
Formatdate-time
qualificationRequirements*string|number|boolean|null||array<unknown>
requiredPanelIds*array<>
verificationCode*string|null
autoAcceptHours*|
Range-2147483648 <= value <= 2147483647
forceUniqueTasks*boolean
isDryRun*boolean
dryRunAllowedEmails*array<string>
dryRunMagicToken*string|null
projectId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
watcherUserIds*array<>
reviewerUserIds*array<>
noTasksReviewerNotifiedAt*|
Formatdate-time
curl -X PATCH "https://example.com/v2/crowd-jobs/:jobId/resume"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "title": "string",  "description": "string",  "status": "assignable",  "category": "survey",  "language": "en",  "surveyTemplateVersionId": "string",  "inputDataSetId": "string",  "maxAssignments": -32768,  "maxRepetitionsPerVariant": -2147483648,  "maxWorkTimeMinutes": -2147483648,  "rewardCredits": -9007199254740991,  "creditsBlocked": -9007199254740991,  "platformFeeBlocked": -9007199254740991,  "validFrom": "2019-08-24T14:15:22Z",  "validUntil": "2019-08-24T14:15:22Z",  "qualificationRequirements": "string",  "requiredPanelIds": [    "string"  ],  "verificationCode": "string",  "autoAcceptHours": -2147483648,  "forceUniqueTasks": true,  "isDryRun": true,  "dryRunAllowedEmails": [    "string"  ],  "dryRunMagicToken": "string",  "projectId": "string",  "createdById": "string",  "watcherUserIds": [    "string"  ],  "reviewerUserIds": [    "string"  ],  "noTasksReviewerNotifiedAt": "2019-08-24T14:15:22Z"}
GET
/v2/crowd-jobs/:jobId/stats

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Response Body

Job statistics

application/json
  1. response
maxSlots*number
currentlyWorking*number
submitted*number
accepted*number
rejected*number
pending*number
timedOut*number
cancelled*number
returned*number
workers*
curl -X GET "https://example.com/v2/crowd-jobs/:jobId/stats"
{  "maxSlots": 0,  "currentlyWorking": 0,  "submitted": 0,  "accepted": 0,  "rejected": 0,  "pending": 0,  "timedOut": 0,  "cancelled": 0,  "returned": 0,  "workers": {    "started": [      {        "workerId": "string",        "guestWorkerId": "string",        "taskId": "string",        "assignedAt": "2019-08-24T14:15:22Z"      }    ],    "submitted": [      {        "workerId": "string",        "guestWorkerId": "string",        "answerId": "string",        "createdAt": "2019-08-24T14:15:22Z"      }    ],    "cancelled": [      {        "workerId": "string",        "guestWorkerId": "string",        "taskId": "string",        "updatedAt": "2019-08-24T14:15:22Z"      }    ],    "timedOut": [      {        "workerId": "string",        "guestWorkerId": "string",        "taskId": "string",        "expiresAt": "2019-08-24T14:15:22Z"      }    ]  }}
GET
/v2/crowd-jobs/:jobId/answers

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Query Parameters

status?string
Value in"pending""accepted""rejected"
limit?number
Range1 <= value <= 200
Default50
offset?|
Range0 <= value
Default0
search?string
sortBy?string
Value in"workerId""status""submittedAt""duration"
sortDir?string
Value in"asc""desc"

Response Body

Paginated answers

application/json
  1. response
total*number
items*array<>
curl -X GET "https://example.com/v2/crowd-jobs/:jobId/answers"
{  "total": 0,  "items": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "taskId": "string",      "workerId": "string",      "guestWorkerId": "string",      "jobId": "string",      "organizationId": "string",      "answers": "string",      "metadata": "string",      "inputDataSetId": "string",      "inputDataVariantIndex": -2147483648,      "status": "pending",      "reviewedAt": "2019-08-24T14:15:22Z",      "rejectionReason": "string",      "rejectionCategory": "too_fast",      "acceptanceNote": "string",      "reviewedById": "string",      "creditsEarned": -9007199254740991,      "autoAcceptReminderSentAt": "2019-08-24T14:15:22Z",      "inputDataSnapshot": {        "property1": "string",        "property2": "string"      },      "startedAt": "2019-08-24T14:15:22Z",      "feedback": {        "id": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "answerId": "string",        "taskId": "string",        "jobId": "string",        "organizationId": "string",        "workerId": "string",        "guestWorkerId": "string",        "rating": -32768,        "labels": [          "string"        ],        "message": "string"      },      "reviewedBy": {        "id": "string",        "name": "string",        "email": "string"      }    }  ]}
GET
/v2/crowd-jobs/:jobId/feedback

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Query Parameters

limit?number
Range1 <= value <= 200
Default50
offset?|
Range0 <= value
Default0

Response Body

Paginated post-task worker feedback plus aggregate stats

application/json
  1. response
total*number
averageRating*number|null
labelCounts*
items*array<>
curl -X GET "https://example.com/v2/crowd-jobs/:jobId/feedback"
{  "total": 0,  "averageRating": 0,  "labelCounts": {    "property1": 0,    "property2": 0  },  "items": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "answerId": "string",      "taskId": "string",      "jobId": "string",      "organizationId": "string",      "workerId": "string",      "guestWorkerId": "string",      "rating": -32768,      "labels": [        "string"      ],      "message": "string"    }  ]}
GET
/v2/crowd-jobs/:jobId/chart-data

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Response Body

Raw per-answer data (timestamp/status/workDuration) for the answers timeseries and duration box-plot charts

application/json
  1. response
jobCreatedAt*|
Formatdate-time
answers*array<>
curl -X GET "https://example.com/v2/crowd-jobs/:jobId/chart-data"
{  "jobCreatedAt": "2019-08-24T14:15:22Z",  "answers": [    {      "createdAt": "2019-08-24T14:15:22Z",      "reviewedAt": "2019-08-24T14:15:22Z",      "status": "pending",      "workDuration": 0    }  ]}
GET
/v2/crowd-jobs/:jobId/answers/visualization-data

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Query Parameters

status?string
Default"all"
Value in"pending""accepted""rejected""all"
variantIndex?string

Response Body

Every matching answer's raw survey answers, for per-question aggregation/charting

application/json
  1. response
items*array<>
curl -X GET "https://example.com/v2/crowd-jobs/:jobId/answers/visualization-data"
{  "items": [    {      "property1": null,      "property2": null    }  ]}
GET
/v2/crowd-jobs/:jobId/answers/export

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Query Parameters

format?string
Default"json"
Value in"json""csv"
status?string
Default"all"
Value in"pending""accepted""rejected""all"
pretty?|
Defaulttrue

Response Body

Exported answers (JSON array or CSV; JSON is pretty-printed with 2-space indentation unless pretty=false)

  1. response
[index: integer]?
curl -X GET "https://example.com/v2/crowd-jobs/:jobId/answers/export"
[  {    "property1": null,    "property2": null  }]
GET
/v2/crowd-jobs/:jobId/files

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Response Body

Files attached to job answers

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/crowd-jobs/:jobId/files"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "name": "string",    "type": "string",    "size": -2147483648,    "path": "string",    "etag": "string",    "organizationId": "string",    "uploaderId": "string",    "lastModified": "2019-08-24T14:15:22Z",    "projectId": "string",    "privacyLevel": "private",    "tags": [      "string"    ],    "metadata": "string",    "additionalInfo": "string",    "origin": "user_upload",    "originWorkflowId": "string",    "sourceFileId": "string",    "enrichmentStatus": "pending",    "placeholder": "string",    "contentHash": "string",    "folderId": "string"  }]
GET
/v2/crowd-jobs/:jobId/files/download

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Response Body

ZIP archive of all job answer files

response?fileapplication/zip
Formatbinary
curl -X GET "https://example.com/v2/crowd-jobs/:jobId/files/download"
"string"
POST
/v2/crowd-jobs/:jobId/answers-to-dataset

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Request Body

Dataset creation options

application/json
  1. body
datasetName*string
Length1 <= length <= 100
fileFieldNames?array<string>
answerStatus?string
Default"all"
Value in"pending""accepted""rejected""all"

Response Body

Created dataset from answer files

application/json
  1. response
datasetId*string
fileCount*number
curl -X POST "https://example.com/v2/crowd-jobs/:jobId/answers-to-dataset" \  -H "Content-Type: application/json" \  -d '{    "datasetName": "string"  }'
{  "datasetId": "string",  "fileCount": 0}
POST
/v2/crowd-jobs/:jobId/answers-to-input-data

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Request Body

Input data creation options

application/json
  1. body
inputDataName*string
Length1 <= length <= 100
textFieldNames*array<string>
Items1 <= items
scope?string
Default"project"
Value in"project""organization"
answerStatus?string
Default"all"
Value in"pending""accepted""rejected""all"

Response Body

Created input data set from textual answers

application/json
  1. response
inputDataSetId*string
recordCount*number
curl -X POST "https://example.com/v2/crowd-jobs/:jobId/answers-to-input-data" \  -H "Content-Type: application/json" \  -d '{    "inputDataName": "string",    "textFieldNames": [      "string"    ]  }'
{  "inputDataSetId": "string",  "recordCount": 0}
GET
/v2/crowd-jobs/:jobId/gathered-items

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Query Parameters

reviewStatus?string
Value in"pending""accepted""rejected""duplicate"
limit?number
Range1 <= value <= 200
Default50
offset?|
Range0 <= value
Default0

Response Body

Paginated gathered items

application/json
  1. response
total*number
items*array<>
curl -X GET "https://example.com/v2/crowd-jobs/:jobId/gathered-items"
{  "total": 0,  "items": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "jobId": "string",      "crowdAnswerId": "string",      "sourceUrl": "string",      "platform": "string",      "contentType": "string",      "authorHandle": "string",      "textContent": "string",      "fileId": "string",      "metrics": "string",      "dedupeHash": "string",      "reviewStatus": "pending"    }  ]}
POST
/v2/crowd-jobs/:jobId/gathered-items/export-to-dataset

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Request Body

Dataset creation options

application/json
  1. body
datasetName*string
Length1 <= length <= 100
reviewStatus?string
Default"accepted"
Value in"pending""accepted""rejected""duplicate""all"

Response Body

Created dataset from gathered item files

application/json
  1. response
datasetId*string
fileCount*number
curl -X POST "https://example.com/v2/crowd-jobs/:jobId/gathered-items/export-to-dataset" \  -H "Content-Type: application/json" \  -d '{    "datasetName": "string"  }'
{  "datasetId": "string",  "fileCount": 0}
POST
/v2/crowd-jobs/:jobId/gathered-items/export-to-input-data

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Request Body

Input data creation options

application/json
  1. body
inputDataName*string
Length1 <= length <= 100
scope?string
Default"project"
Value in"project""organization"
reviewStatus?string
Default"accepted"
Value in"pending""accepted""rejected""duplicate""all"

Response Body

Created input data set from gathered item URLs

application/json
  1. response
inputDataSetId*string
recordCount*number
curl -X POST "https://example.com/v2/crowd-jobs/:jobId/gathered-items/export-to-input-data" \  -H "Content-Type: application/json" \  -d '{    "inputDataName": "string"  }'
{  "inputDataSetId": "string",  "recordCount": 0}
POST
/v2/crowd-jobs/:jobId/clone

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Request Body

Clone options

application/json
  1. body
isDryRun?boolean
name?string
Length3 <= length <= 100

Response Body

Cloned crowd job

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
title*string
description*string
status*string
Value in"assignable""not_assignable""no_tasks""finished""archived""paused"
category*string
Value in"survey""qualification_test""gathering"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
surveyTemplateVersionId*string
Lengthlength <= 24
inputDataSetId*|
Lengthlength <= 24
maxAssignments*integer
Range-32768 <= value <= 32767
maxRepetitionsPerVariant*integer
Range-2147483648 <= value <= 2147483647
maxWorkTimeMinutes*|
Range-2147483648 <= value <= 2147483647
rewardCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
creditsBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
platformFeeBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
validFrom*|
Formatdate-time
validUntil*|
Formatdate-time
qualificationRequirements*string|number|boolean|null||array<unknown>
requiredPanelIds*array<>
verificationCode*string|null
autoAcceptHours*|
Range-2147483648 <= value <= 2147483647
forceUniqueTasks*boolean
isDryRun*boolean
dryRunAllowedEmails*array<string>
dryRunMagicToken*string|null
projectId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
watcherUserIds*array<>
reviewerUserIds*array<>
noTasksReviewerNotifiedAt*|
Formatdate-time
curl -X POST "https://example.com/v2/crowd-jobs/:jobId/clone" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "title": "string",  "description": "string",  "status": "assignable",  "category": "survey",  "language": "en",  "surveyTemplateVersionId": "string",  "inputDataSetId": "string",  "maxAssignments": -32768,  "maxRepetitionsPerVariant": -2147483648,  "maxWorkTimeMinutes": -2147483648,  "rewardCredits": -9007199254740991,  "creditsBlocked": -9007199254740991,  "platformFeeBlocked": -9007199254740991,  "validFrom": "2019-08-24T14:15:22Z",  "validUntil": "2019-08-24T14:15:22Z",  "qualificationRequirements": "string",  "requiredPanelIds": [    "string"  ],  "verificationCode": "string",  "autoAcceptHours": -2147483648,  "forceUniqueTasks": true,  "isDryRun": true,  "dryRunAllowedEmails": [    "string"  ],  "dryRunMagicToken": "string",  "projectId": "string",  "createdById": "string",  "watcherUserIds": [    "string"  ],  "reviewerUserIds": [    "string"  ],  "noTasksReviewerNotifiedAt": "2019-08-24T14:15:22Z"}
GET
/v2/crowd-jobs/:jobId/extend/preview

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Query Parameters

additionalRepetitions*integer
Range1 <= value

Response Body

Cost preview for extending this job

application/json
  1. response
currentMaxRepetitionsPerVariant*number
newMaxRepetitionsPerVariant*number
variantCount*number
currentMaxSlots*number
newMaxSlots*number
additionalCost*number
platformFeeAmount*number
totalCost*number
organizationBalance*number
sufficientBalance*boolean
isPaid*boolean
curl -X GET "https://example.com/v2/crowd-jobs/:jobId/extend/preview?additionalRepetitions=1"
{  "currentMaxRepetitionsPerVariant": 0,  "newMaxRepetitionsPerVariant": 0,  "variantCount": 0,  "currentMaxSlots": 0,  "newMaxSlots": 0,  "additionalCost": 0,  "platformFeeAmount": 0,  "totalCost": 0,  "organizationBalance": 0,  "sufficientBalance": true,  "isPaid": true}
POST
/v2/crowd-jobs/:jobId/extend

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Request Body

Extend options

application/json
  1. body
additionalRepetitions*integer
Range1 <= value

Response Body

Extended crowd job

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
title*string
description*string
status*string
Value in"assignable""not_assignable""no_tasks""finished""archived""paused"
category*string
Value in"survey""qualification_test""gathering"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
surveyTemplateVersionId*string
Lengthlength <= 24
inputDataSetId*|
Lengthlength <= 24
maxAssignments*integer
Range-32768 <= value <= 32767
maxRepetitionsPerVariant*integer
Range-2147483648 <= value <= 2147483647
maxWorkTimeMinutes*|
Range-2147483648 <= value <= 2147483647
rewardCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
creditsBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
platformFeeBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
validFrom*|
Formatdate-time
validUntil*|
Formatdate-time
qualificationRequirements*string|number|boolean|null||array<unknown>
requiredPanelIds*array<>
verificationCode*string|null
autoAcceptHours*|
Range-2147483648 <= value <= 2147483647
forceUniqueTasks*boolean
isDryRun*boolean
dryRunAllowedEmails*array<string>
dryRunMagicToken*string|null
projectId*string
Lengthlength <= 24
createdById*|
Lengthlength <= 24
watcherUserIds*array<>
reviewerUserIds*array<>
noTasksReviewerNotifiedAt*|
Formatdate-time
curl -X POST "https://example.com/v2/crowd-jobs/:jobId/extend" \  -H "Content-Type: application/json" \  -d '{    "additionalRepetitions": 1  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "title": "string",  "description": "string",  "status": "assignable",  "category": "survey",  "language": "en",  "surveyTemplateVersionId": "string",  "inputDataSetId": "string",  "maxAssignments": -32768,  "maxRepetitionsPerVariant": -2147483648,  "maxWorkTimeMinutes": -2147483648,  "rewardCredits": -9007199254740991,  "creditsBlocked": -9007199254740991,  "platformFeeBlocked": -9007199254740991,  "validFrom": "2019-08-24T14:15:22Z",  "validUntil": "2019-08-24T14:15:22Z",  "qualificationRequirements": "string",  "requiredPanelIds": [    "string"  ],  "verificationCode": "string",  "autoAcceptHours": -2147483648,  "forceUniqueTasks": true,  "isDryRun": true,  "dryRunAllowedEmails": [    "string"  ],  "dryRunMagicToken": "string",  "projectId": "string",  "createdById": "string",  "watcherUserIds": [    "string"  ],  "reviewerUserIds": [    "string"  ],  "noTasksReviewerNotifiedAt": "2019-08-24T14:15:22Z"}
GET
/v2/crowd-jobs/:jobId/webhooks

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Response Body

Job webhooks

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/crowd-jobs/:jobId/webhooks"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "jobId": "string",    "url": "string",    "description": "string",    "eventTypes": [      "job.created"    ],    "status": "active",    "consecutiveFailureCount": -2147483648,    "disabledAt": "2019-08-24T14:15:22Z",    "createdById": "string"  }]
POST
/v2/crowd-jobs/:jobId/webhooks

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Request Body

New webhook

application/json
  1. body
url*string
Formaturi
Lengthlength <= 2048
description?|
Lengthlength <= 200
eventTypes*array<>
Items1 <= items

Response Body

Created webhook (includes the signing secret once)

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
jobId*string
Lengthlength <= 24
url*string
description*string|null
eventTypes*array<>
status*string
Value in"active""disabled"
consecutiveFailureCount*integer
Range-2147483648 <= value <= 2147483647
disabledAt*|
Formatdate-time
createdById*|
Lengthlength <= 24
secret*string
curl -X POST "https://example.com/v2/crowd-jobs/:jobId/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com",    "eventTypes": [      "job.created"    ]  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "jobId": "string",  "url": "string",  "description": "string",  "eventTypes": [    "job.created"  ],  "status": "active",  "consecutiveFailureCount": -2147483648,  "disabledAt": "2019-08-24T14:15:22Z",  "createdById": "string",  "secret": "string"}
PUT
/v2/crowd-jobs/:jobId/webhooks/:webhookId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24
webhookId*string
Length24 <= length <= 24

Request Body

Updated webhook

application/json
  1. body
url?string
Formaturi
Lengthlength <= 2048
description?|
Lengthlength <= 200
eventTypes?array<>
Items1 <= items
status?string
Value in"active""disabled"

Response Body

Updated webhook

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
jobId*string
Lengthlength <= 24
url*string
description*string|null
eventTypes*array<>
status*string
Value in"active""disabled"
consecutiveFailureCount*integer
Range-2147483648 <= value <= 2147483647
disabledAt*|
Formatdate-time
createdById*|
Lengthlength <= 24
curl -X PUT "https://example.com/v2/crowd-jobs/:jobId/webhooks/:webhookId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "jobId": "string",  "url": "string",  "description": "string",  "eventTypes": [    "job.created"  ],  "status": "active",  "consecutiveFailureCount": -2147483648,  "disabledAt": "2019-08-24T14:15:22Z",  "createdById": "string"}
DELETE
/v2/crowd-jobs/:jobId/webhooks/:webhookId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24
webhookId*string
Length24 <= length <= 24

Response Body

Webhook deleted

curl -X DELETE "https://example.com/v2/crowd-jobs/:jobId/webhooks/:webhookId"
Empty
POST
/v2/crowd-jobs/:jobId/webhooks/:webhookId/rotate-secret

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24
webhookId*string
Length24 <= length <= 24

Response Body

Rotated webhook secret (shown once)

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
jobId*string
Lengthlength <= 24
url*string
description*string|null
eventTypes*array<>
status*string
Value in"active""disabled"
consecutiveFailureCount*integer
Range-2147483648 <= value <= 2147483647
disabledAt*|
Formatdate-time
createdById*|
Lengthlength <= 24
secret*string
curl -X POST "https://example.com/v2/crowd-jobs/:jobId/webhooks/:webhookId/rotate-secret"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "jobId": "string",  "url": "string",  "description": "string",  "eventTypes": [    "job.created"  ],  "status": "active",  "consecutiveFailureCount": -2147483648,  "disabledAt": "2019-08-24T14:15:22Z",  "createdById": "string",  "secret": "string"}
POST
/v2/crowd-jobs/:jobId/webhooks/:webhookId/test

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24
webhookId*string
Length24 <= length <= 24

Response Body

Result of a synchronous test delivery

application/json
  1. response
ok*boolean
statusCode*number|null
errorMessage*string|null
durationMs*number
curl -X POST "https://example.com/v2/crowd-jobs/:jobId/webhooks/:webhookId/test"
{  "ok": true,  "statusCode": 0,  "errorMessage": "string",  "durationMs": 0}
GET
/v2/crowd-jobs/:jobId/webhooks/:webhookId/deliveries

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24
webhookId*string
Length24 <= length <= 24

Query Parameters

limit?number
Range1 <= value <= 200
Default50
offset?|
Range0 <= value
Default0

Response Body

Paginated delivery log, newest first

application/json
  1. response
total*number
items*array<>
curl -X GET "https://example.com/v2/crowd-jobs/:jobId/webhooks/:webhookId/deliveries"
{  "total": 0,  "items": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "webhookId": "string",      "jobId": "string",      "event": "job.created",      "payload": "string",      "attempt": -2147483648,      "status": "pending",      "responseStatusCode": -2147483648,      "responseBodySnippet": "string",      "errorMessage": "string",      "durationMs": -2147483648,      "deliveredAt": "2019-08-24T14:15:22Z",      "redeliveryOfId": "string"    }  ]}
POST
/v2/crowd-jobs/:jobId/webhooks/:webhookId/deliveries/:deliveryId/redeliver

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24
webhookId*string
Length24 <= length <= 24
deliveryId*string
Length24 <= length <= 24

Response Body

New delivery attempt enqueued

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
webhookId*string
Lengthlength <= 24
jobId*string
Lengthlength <= 24
event*string
Value in"job.created""job.paused""job.resumed""job.no_tasks""job.finished""job.expired""job.archived""job.extended""answer.received""answer.received.full""answer.accepted""answer.rejected"
payload*string|number|boolean|null||array<unknown>
attempt*integer
Range-2147483648 <= value <= 2147483647
status*string
Value in"pending""succeeded""failed""exhausted"
responseStatusCode*|
Range-2147483648 <= value <= 2147483647
responseBodySnippet*string|null
errorMessage*string|null
durationMs*|
Range-2147483648 <= value <= 2147483647
deliveredAt*|
Formatdate-time
redeliveryOfId*|
Lengthlength <= 24
curl -X POST "https://example.com/v2/crowd-jobs/:jobId/webhooks/:webhookId/deliveries/:deliveryId/redeliver"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "webhookId": "string",  "jobId": "string",  "event": "job.created",  "payload": "string",  "attempt": -2147483648,  "status": "pending",  "responseStatusCode": -2147483648,  "responseBodySnippet": "string",  "errorMessage": "string",  "durationMs": -2147483648,  "deliveredAt": "2019-08-24T14:15:22Z",  "redeliveryOfId": "string"}
PATCH
/v2/crowd-answers/:answerId/accept

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

answerId*string
Length24 <= length <= 24

Request Body

Acceptance note

application/json
  1. body
acceptanceNote?string
Lengthlength <= 500

Response Body

Accepted answer

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
taskId*string
Lengthlength <= 24
workerId*|
Lengthlength <= 24
guestWorkerId*|
Lengthlength <= 24
jobId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
answers*string|number|boolean|null||array<unknown>
metadata*string|number|boolean|null||array<unknown>
inputDataSetId*|
Lengthlength <= 24
inputDataVariantIndex*|
Range-2147483648 <= value <= 2147483647
status*string
Value in"pending""accepted""rejected"
reviewedAt*|
Formatdate-time
rejectionReason*string|null
rejectionCategory*|
Value in"too_fast""too_slow""failed_instructions""failed_attention_check""low_effort""missing_or_invalid_data""no_verification_code""invalid_verification_code""suspected_fraud_or_duplicate""unsupported_device_or_technical_issue""other"null
acceptanceNote*string|null
reviewedById*|
Lengthlength <= 24
creditsEarned*integer
Range-9007199254740991 <= value <= 9007199254740991
autoAcceptReminderSentAt*|
Formatdate-time
curl -X PATCH "https://example.com/v2/crowd-answers/:answerId/accept" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "taskId": "string",  "workerId": "string",  "guestWorkerId": "string",  "jobId": "string",  "organizationId": "string",  "answers": "string",  "metadata": "string",  "inputDataSetId": "string",  "inputDataVariantIndex": -2147483648,  "status": "pending",  "reviewedAt": "2019-08-24T14:15:22Z",  "rejectionReason": "string",  "rejectionCategory": "too_fast",  "acceptanceNote": "string",  "reviewedById": "string",  "creditsEarned": -9007199254740991,  "autoAcceptReminderSentAt": "2019-08-24T14:15:22Z"}
PATCH
/v2/crowd-answers/:answerId/reject

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

answerId*string
Length24 <= length <= 24

Request Body

Rejection reason

application/json
  1. body
rejectionReason?string
Lengthlength <= 500
rejectionCategory*string
Value in"too_fast""too_slow""failed_instructions""failed_attention_check""low_effort""missing_or_invalid_data""no_verification_code""invalid_verification_code""suspected_fraud_or_duplicate""unsupported_device_or_technical_issue""other"

Response Body

Rejected answer

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
taskId*string
Lengthlength <= 24
workerId*|
Lengthlength <= 24
guestWorkerId*|
Lengthlength <= 24
jobId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
answers*string|number|boolean|null||array<unknown>
metadata*string|number|boolean|null||array<unknown>
inputDataSetId*|
Lengthlength <= 24
inputDataVariantIndex*|
Range-2147483648 <= value <= 2147483647
status*string
Value in"pending""accepted""rejected"
reviewedAt*|
Formatdate-time
rejectionReason*string|null
rejectionCategory*|
Value in"too_fast""too_slow""failed_instructions""failed_attention_check""low_effort""missing_or_invalid_data""no_verification_code""invalid_verification_code""suspected_fraud_or_duplicate""unsupported_device_or_technical_issue""other"null
acceptanceNote*string|null
reviewedById*|
Lengthlength <= 24
creditsEarned*integer
Range-9007199254740991 <= value <= 9007199254740991
autoAcceptReminderSentAt*|
Formatdate-time
curl -X PATCH "https://example.com/v2/crowd-answers/:answerId/reject" \  -H "Content-Type: application/json" \  -d '{    "rejectionCategory": "too_fast"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "taskId": "string",  "workerId": "string",  "guestWorkerId": "string",  "jobId": "string",  "organizationId": "string",  "answers": "string",  "metadata": "string",  "inputDataSetId": "string",  "inputDataVariantIndex": -2147483648,  "status": "pending",  "reviewedAt": "2019-08-24T14:15:22Z",  "rejectionReason": "string",  "rejectionCategory": "too_fast",  "acceptanceNote": "string",  "reviewedById": "string",  "creditsEarned": -9007199254740991,  "autoAcceptReminderSentAt": "2019-08-24T14:15:22Z"}
PATCH
/v2/gathered-items/:itemId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

itemId*string
Length24 <= length <= 24

Request Body

New review status

application/json
  1. body
reviewStatus*string
Value in"pending""accepted""rejected""duplicate"

Response Body

Updated gathered item

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
jobId*string
Lengthlength <= 24
crowdAnswerId*string
Lengthlength <= 24
sourceUrl*string
platform*string|null
contentType*string|null
authorHandle*string|null
textContent*string|null
fileId*|
Lengthlength <= 24
metrics*string|number|boolean|null||array<unknown>
dedupeHash*string
reviewStatus*string
Value in"pending""accepted""rejected""duplicate"
curl -X PATCH "https://example.com/v2/gathered-items/:itemId" \  -H "Content-Type: application/json" \  -d '{    "reviewStatus": "pending"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "jobId": "string",  "crowdAnswerId": "string",  "sourceUrl": "string",  "platform": "string",  "contentType": "string",  "authorHandle": "string",  "textContent": "string",  "fileId": "string",  "metrics": "string",  "dedupeHash": "string",  "reviewStatus": "pending"}
POST
/v2/workers/sign-up

Authorization

openIdConnect
OpenID Connect<token>

Request Body

The worker account to create

application/json
  1. body
name*string
Length3 <= length <= 50
email*string
Formatemail
avatar?string|null
avatarPlaceholder?string|null
isSuperadmin?boolean
createdVia?|
Value in"signup""invitation""worker_signup""oidc_auto_provision"null
locale?string
Default"en"
Value in"en""de"
timezone?string|null
password*string
Length8 <= length
profile?
group?string
Lengthlength <= 100

Response Body

Created worker account (pending email verification)

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
sub*string
name*string
email*string
avatar*string|null
avatarPlaceholder*string|null
organizationId*|
Lengthlength <= 24
role*|
Value in"viewer""user""admin""superadmin"null
isSuperadmin*boolean
createdVia*|
Value in"signup""invitation""worker_signup""oidc_auto_provision"null
locale*string|null
timezone*string|null
curl -X POST "https://example.com/v2/workers/sign-up" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "email": "user@example.com",    "password": "stringst"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "sub": "string",  "name": "string",  "email": "string",  "avatar": "string",  "avatarPlaceholder": "string",  "organizationId": "string",  "role": "viewer",  "isSuperadmin": true,  "createdVia": "signup",  "locale": "string",  "timezone": "string"}
GET
/v2/workers/verify/:registrationId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

registrationId*string
Length24 <= length <= 24

Response Body

Updated registration

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
authentikUserId*integer
Range-2147483648 <= value <= 2147483647
userId*|
Lengthlength <= 24
status*string
Value in"pending""accepted""expired"
expirationDate*string
Formatdate-time
curl -X GET "https://example.com/v2/workers/verify/:registrationId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "authentikUserId": -2147483648,  "userId": "string",  "status": "pending",  "expirationDate": "2019-08-24T14:15:22Z"}
GET
/v2/workers/jobs/:jobId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Query Parameters

dryRunToken?string
guestWorkerId?string

Response Body

Crowd job detail for workers

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
name*string
title*string
description*string
status*string
Value in"assignable""not_assignable""no_tasks""finished""archived""paused"
category*string
Value in"survey""qualification_test""gathering"
language*string
Value in"en""de""fr""es""it""pt""nl""pl""sv""no""da""fi""ru""tr""ar""zh""ja"
surveyTemplateVersionId*string
Lengthlength <= 24
inputDataSetId*|
Lengthlength <= 24
maxAssignments*integer
Range-32768 <= value <= 32767
maxRepetitionsPerVariant*integer
Range-2147483648 <= value <= 2147483647
maxWorkTimeMinutes*|
Range-2147483648 <= value <= 2147483647
rewardCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
creditsBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
platformFeeBlocked*integer
Range-9007199254740991 <= value <= 9007199254740991
validFrom*|
Formatdate-time
validUntil*|
Formatdate-time
qualificationRequirements*string|number|boolean|null||array<unknown>
requiredPanelIds*array<>
verificationCode*string|null
autoAcceptHours*|
Range-2147483648 <= value <= 2147483647
forceUniqueTasks*boolean
isDryRun*boolean
dryRunAllowedEmails*array<string>
dryRunMagicToken*string|null
projectId*string
Lengthlength <= 24
noTasksReviewerNotifiedAt*|
Formatdate-time
maxSlots*number
computedStatus*string
qualificationEligibility*||
panelEligibility*||
curl -X GET "https://example.com/v2/workers/jobs/:jobId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "name": "string",  "title": "string",  "description": "string",  "status": "assignable",  "category": "survey",  "language": "en",  "surveyTemplateVersionId": "string",  "inputDataSetId": "string",  "maxAssignments": -32768,  "maxRepetitionsPerVariant": -2147483648,  "maxWorkTimeMinutes": -2147483648,  "rewardCredits": -9007199254740991,  "creditsBlocked": -9007199254740991,  "platformFeeBlocked": -9007199254740991,  "validFrom": "2019-08-24T14:15:22Z",  "validUntil": "2019-08-24T14:15:22Z",  "qualificationRequirements": "string",  "requiredPanelIds": [    "string"  ],  "verificationCode": "string",  "autoAcceptHours": -2147483648,  "forceUniqueTasks": true,  "isDryRun": true,  "dryRunAllowedEmails": [    "string"  ],  "dryRunMagicToken": "string",  "projectId": "string",  "noTasksReviewerNotifiedAt": "2019-08-24T14:15:22Z",  "maxSlots": 0,  "computedStatus": "string",  "qualificationEligibility": {    "state": "eligible"  },  "panelEligibility": {    "state": "eligible"  }}
POST
/v2/workers/jobs/:jobId/claim-task

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Query Parameters

guestWorkerId?string
dryRunToken?string
guestGroup?string
Length1 <= length <= 100
externalProvider?string
externalWorkerId?string
externalDisplayName?string
externalCorrelationToken?string
externalSubmissionId?string

Response Body

Claimed task with SurveyJS template

application/json
  1. response
taskId*string
expiresAt*string
Formatdate-time
surveyJs*
inputDataSnapshot*|null
curl -X POST "https://example.com/v2/workers/jobs/:jobId/claim-task"
{  "taskId": "string",  "expiresAt": "2019-08-24T14:15:22Z",  "surveyJs": {    "property1": null,    "property2": null  },  "inputDataSnapshot": {    "property1": "string",    "property2": "string"  }}
DELETE
/v2/workers/tasks/:taskId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

taskId*string
Length24 <= length <= 24

Query Parameters

guestWorkerId?string

Response Body

Cancelled task

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
jobId*string
Lengthlength <= 24
workerId*|
Lengthlength <= 24
guestWorkerId*|
Lengthlength <= 24
inputDataSetId*|
Lengthlength <= 24
inputDataVariantIndex*|
Range-2147483648 <= value <= 2147483647
inputDataSnapshot*string|number|boolean|null||array<unknown>
status*string
Value in"assigned""submitted""timed_out""cancelled""returned"
assignedAt*string
Formatdate-time
externalJobId*|
Lengthlength <= 24
externalSubmissionId*string|null
expiresAt*string
Formatdate-time
curl -X DELETE "https://example.com/v2/workers/tasks/:taskId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "jobId": "string",  "workerId": "string",  "guestWorkerId": "string",  "inputDataSetId": "string",  "inputDataVariantIndex": -2147483648,  "inputDataSnapshot": "string",  "status": "assigned",  "assignedAt": "2019-08-24T14:15:22Z",  "externalJobId": "string",  "externalSubmissionId": "string",  "expiresAt": "2019-08-24T14:15:22Z"}
POST
/v2/workers/tasks/:taskId/answer

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

taskId*string
Length24 <= length <= 24

Query Parameters

guestWorkerId?string
externalCorrelationToken?string

Request Body

Answer submission

application/json
  1. body
answers*
fileIds?array<>
screenResolution?string
Lengthlength <= 20
userAgent?string
Lengthlength <= 500

Response Body

Submitted answer

application/json
  1. response
answerId*string
verificationCode*string|null
curl -X POST "https://example.com/v2/workers/tasks/:taskId/answer" \  -H "Content-Type: application/json" \  -d '{    "answers": {      "property1": null,      "property2": null    }  }'
{  "answerId": "string",  "verificationCode": "string"}
POST
/v2/workers/tasks/:taskId/feedback

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

taskId*string
Length24 <= length <= 24

Query Parameters

guestWorkerId?string

Request Body

Post-task feedback

application/json
  1. body
rating*integer
Range1 <= value <= 5
labels?array<>
Itemsitems <= 8
Default[]
message?string
Lengthlength <= 2000

Response Body

Stored feedback

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
answerId*string
Lengthlength <= 24
taskId*string
Lengthlength <= 24
jobId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
workerId*|
Lengthlength <= 24
guestWorkerId*|
Lengthlength <= 24
rating*integer
Range-32768 <= value <= 32767
labels*array<string>
message*string|null
curl -X POST "https://example.com/v2/workers/tasks/:taskId/feedback" \  -H "Content-Type: application/json" \  -d '{    "rating": 1  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "answerId": "string",  "taskId": "string",  "jobId": "string",  "organizationId": "string",  "workerId": "string",  "guestWorkerId": "string",  "rating": -32768,  "labels": [    "string"  ],  "message": "string"}
POST
/v2/workers/tasks/:taskId/files

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

taskId*string
Length24 <= length <= 24

Query Parameters

guestWorkerId?string
transcribe?|
Defaultfalse
language?string

Response Body

Stored file and optional Whisper transcription (audio only)

application/json
  1. response
fileId*string
transcription*string|null
curl -X POST "https://example.com/v2/workers/tasks/:taskId/files"
{  "fileId": "string",  "transcription": "string"}
POST
/v2/workers/tasks/:taskId/web-search

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

taskId*string
Length24 <= length <= 24

Query Parameters

guestWorkerId?string

Request Body

Search query

application/json
  1. body
query*string
Length1 <= length <= 200

Response Body

Search results

application/json
  1. response
results*array<>
curl -X POST "https://example.com/v2/workers/tasks/:taskId/web-search" \  -H "Content-Type: application/json" \  -d '{    "query": "string"  }'
{  "results": [    {      "title": "string",      "url": "string",      "snippet": "string"    }  ]}
GET
/v2/workers/guest/me

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

guestWorkerId*string

Response Body

Guest worker profile

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
guestToken*string
profile*string|number|boolean|null||array<unknown>
lastSeenAt*string
Formatdate-time
curl -X GET "https://example.com/v2/workers/guest/me?guestWorkerId=string"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "guestToken": "string",  "profile": "string",  "lastSeenAt": "2019-08-24T14:15:22Z"}
PATCH
/v2/workers/guest/me

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

guestWorkerId*string
guestGroup?string
Length1 <= length <= 100

Request Body

Guest profile update

application/json
  1. body
profile*

Response Body

Updated guest worker profile

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
guestToken*string
profile*string|number|boolean|null||array<unknown>
lastSeenAt*string
Formatdate-time
curl -X PATCH "https://example.com/v2/workers/guest/me?guestWorkerId=string" \  -H "Content-Type: application/json" \  -d '{    "profile": {}  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "guestToken": "string",  "profile": "string",  "lastSeenAt": "2019-08-24T14:15:22Z"}
GET
/v2/workers/jobs

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

limit?number
Range1 <= value <= 100
Default50
offset?|
Range0 <= value
Default0

Response Body

Assignable crowd jobs for this worker

application/json
  1. response
total*number
items*array<>
curl -X GET "https://example.com/v2/workers/jobs"
{  "total": 0,  "items": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "name": "string",      "title": "string",      "description": "string",      "status": "assignable",      "category": "survey",      "language": "en",      "surveyTemplateVersionId": "string",      "inputDataSetId": "string",      "maxAssignments": -32768,      "maxRepetitionsPerVariant": -2147483648,      "maxWorkTimeMinutes": -2147483648,      "rewardCredits": -9007199254740991,      "creditsBlocked": -9007199254740991,      "platformFeeBlocked": -9007199254740991,      "validFrom": "2019-08-24T14:15:22Z",      "validUntil": "2019-08-24T14:15:22Z",      "qualificationRequirements": "string",      "requiredPanelIds": [        "string"      ],      "verificationCode": "string",      "autoAcceptHours": -2147483648,      "forceUniqueTasks": true,      "isDryRun": true,      "dryRunAllowedEmails": [        "string"      ],      "dryRunMagicToken": "string",      "projectId": "string",      "noTasksReviewerNotifiedAt": "2019-08-24T14:15:22Z",      "maxSlots": 0    }  ]}
POST
/v2/workers/register

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Created worker profile

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
userId*string
Lengthlength <= 24
balanceCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
blockedCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
totalEarned*integer
Range-9007199254740991 <= value <= 9007199254740991
profile*string|number|boolean|null||array<unknown>
isBlocked*boolean
blockedAt*|
Formatdate-time
blockReason*string|null
paymentEmail*string|null
bankAccount*string|number|boolean|null||array<unknown>
lastSeenAt*|
Formatdate-time
payoutReminderSentAt*|
Formatdate-time
curl -X POST "https://example.com/v2/workers/register"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "userId": "string",  "balanceCredits": -9007199254740991,  "blockedCredits": -9007199254740991,  "totalEarned": -9007199254740991,  "profile": "string",  "isBlocked": true,  "blockedAt": "2019-08-24T14:15:22Z",  "blockReason": "string",  "paymentEmail": "string",  "bankAccount": "string",  "lastSeenAt": "2019-08-24T14:15:22Z",  "payoutReminderSentAt": "2019-08-24T14:15:22Z"}
GET
/v2/workers/me

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Worker profile

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
userId*string
Lengthlength <= 24
balanceCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
blockedCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
totalEarned*integer
Range-9007199254740991 <= value <= 9007199254740991
profile*string|number|boolean|null||array<unknown>
isBlocked*boolean
blockedAt*|
Formatdate-time
blockReason*string|null
paymentEmail*string|null
bankAccount*string|number|boolean|null||array<unknown>
lastSeenAt*|
Formatdate-time
payoutReminderSentAt*|
Formatdate-time
curl -X GET "https://example.com/v2/workers/me"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "userId": "string",  "balanceCredits": -9007199254740991,  "blockedCredits": -9007199254740991,  "totalEarned": -9007199254740991,  "profile": "string",  "isBlocked": true,  "blockedAt": "2019-08-24T14:15:22Z",  "blockReason": "string",  "paymentEmail": "string",  "bankAccount": "string",  "lastSeenAt": "2019-08-24T14:15:22Z",  "payoutReminderSentAt": "2019-08-24T14:15:22Z"}
PATCH
/v2/workers/me

Authorization

openIdConnect
OpenID Connect<token>

Request Body

Profile update

application/json
  1. body
paymentEmail?|
Formatemail
bankAccount?|null
profile?

Response Body

Updated worker profile

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
userId*string
Lengthlength <= 24
balanceCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
blockedCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
totalEarned*integer
Range-9007199254740991 <= value <= 9007199254740991
profile*string|number|boolean|null||array<unknown>
isBlocked*boolean
blockedAt*|
Formatdate-time
blockReason*string|null
paymentEmail*string|null
bankAccount*string|number|boolean|null||array<unknown>
lastSeenAt*|
Formatdate-time
payoutReminderSentAt*|
Formatdate-time
curl -X PATCH "https://example.com/v2/workers/me" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "userId": "string",  "balanceCredits": -9007199254740991,  "blockedCredits": -9007199254740991,  "totalEarned": -9007199254740991,  "profile": "string",  "isBlocked": true,  "blockedAt": "2019-08-24T14:15:22Z",  "blockReason": "string",  "paymentEmail": "string",  "bankAccount": "string",  "lastSeenAt": "2019-08-24T14:15:22Z",  "payoutReminderSentAt": "2019-08-24T14:15:22Z"}
DELETE
/v2/workers/me

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Account deleted

application/json
  1. response
message*string
curl -X DELETE "https://example.com/v2/workers/me"
{  "message": "string"}
GET
/v2/workers/me/tasks

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

status?string
Value in"assigned""submitted""timed_out""cancelled""returned"
jobId?string
Length24 <= length <= 24
limit?number
Range1 <= value <= 200
Default50
offset?|
Range0 <= value
Default0

Response Body

Worker task history

application/json
  1. response
total*number
items*array<>
curl -X GET "https://example.com/v2/workers/me/tasks"
{  "total": 0,  "items": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "jobId": "string",      "workerId": "string",      "guestWorkerId": "string",      "inputDataSetId": "string",      "inputDataVariantIndex": -2147483648,      "inputDataSnapshot": "string",      "status": "assigned",      "assignedAt": "2019-08-24T14:15:22Z",      "externalJobId": "string",      "externalSubmissionId": "string",      "expiresAt": "2019-08-24T14:15:22Z",      "reviewNote": "string"    }  ]}
GET
/v2/workers/me/billing

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Worker billing/tax info

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
workerId*string
Lengthlength <= 24
name*string
billingStreet*string
billingSupplement*string|null
billingZip*string
billingCity*string
billingCountryCode*string
Lengthlength <= 2
taxResidencyCountryCode*string
Lengthlength <= 2
taxId*string|null
vatId*string|null
version*integer
Range-2147483648 <= value <= 2147483647
curl -X GET "https://example.com/v2/workers/me/billing"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "workerId": "string",  "name": "string",  "billingStreet": "string",  "billingSupplement": "string",  "billingZip": "string",  "billingCity": "string",  "billingCountryCode": "st",  "taxResidencyCountryCode": "st",  "taxId": "string",  "vatId": "string",  "version": -2147483648}
POST
/v2/workers/me/billing

Authorization

openIdConnect
OpenID Connect<token>

Request Body

Billing/tax info to create

application/json
  1. body
name*string
billingStreet*string
billingSupplement?string|null
billingZip*string
billingCity*string
billingCountryCode*string
Lengthlength <= 2
taxResidencyCountryCode*string
Lengthlength <= 2
taxId?string|null
vatId?string|null

Response Body

Created billing/tax info

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
workerId*string
Lengthlength <= 24
name*string
billingStreet*string
billingSupplement*string|null
billingZip*string
billingCity*string
billingCountryCode*string
Lengthlength <= 2
taxResidencyCountryCode*string
Lengthlength <= 2
taxId*string|null
vatId*string|null
version*integer
Range-2147483648 <= value <= 2147483647
curl -X POST "https://example.com/v2/workers/me/billing" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "billingStreet": "string",    "billingZip": "string",    "billingCity": "string",    "billingCountryCode": "st",    "taxResidencyCountryCode": "st"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "workerId": "string",  "name": "string",  "billingStreet": "string",  "billingSupplement": "string",  "billingZip": "string",  "billingCity": "string",  "billingCountryCode": "st",  "taxResidencyCountryCode": "st",  "taxId": "string",  "vatId": "string",  "version": -2147483648}
PUT
/v2/workers/me/billing

Authorization

openIdConnect
OpenID Connect<token>

Request Body

Billing/tax info to replace

application/json
  1. body
name*string
billingStreet*string
billingSupplement?string|null
billingZip*string
billingCity*string
billingCountryCode*string
Lengthlength <= 2
taxResidencyCountryCode*string
Lengthlength <= 2
taxId?string|null
vatId?string|null

Response Body

Updated billing/tax info

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
workerId*string
Lengthlength <= 24
name*string
billingStreet*string
billingSupplement*string|null
billingZip*string
billingCity*string
billingCountryCode*string
Lengthlength <= 2
taxResidencyCountryCode*string
Lengthlength <= 2
taxId*string|null
vatId*string|null
version*integer
Range-2147483648 <= value <= 2147483647
curl -X PUT "https://example.com/v2/workers/me/billing" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "billingStreet": "string",    "billingZip": "string",    "billingCity": "string",    "billingCountryCode": "st",    "taxResidencyCountryCode": "st"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "workerId": "string",  "name": "string",  "billingStreet": "string",  "billingSupplement": "string",  "billingZip": "string",  "billingCity": "string",  "billingCountryCode": "st",  "taxResidencyCountryCode": "st",  "taxId": "string",  "vatId": "string",  "version": -2147483648}
GET
/v2/workers/me/transfer-requests

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Worker payout requests

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/workers/me/transfer-requests"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "workerId": "string",    "amountCredits": -9007199254740991,    "currency": "str",    "status": "pending",    "paymentMethod": "bank",    "paymentDetails": "string",    "processedAt": "2019-08-24T14:15:22Z",    "reference": "string",    "notes": "string",    "approvedAt": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "feeAmountCents": -9007199254740991,    "feeCurrency": "str",    "manualPayout": true  }]
POST
/v2/workers/me/transfer-requests

Authorization

openIdConnect
OpenID Connect<token>

Request Body

Payout request

application/json
  1. body
paymentMethod*"paypal"
Value in"paypal"
amountCredits*integer
Range1000 <= value
paymentDetails*

Response Body

Created transfer request

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
workerId*string
Lengthlength <= 24
amountCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
currency*string
Lengthlength <= 3
status*string
Value in"pending""approved""processing""rejected""completed""error"
paymentMethod*string
Value in"bank""paypal"
paymentDetails*string|number|boolean|null||array<unknown>
processedAt*|
Formatdate-time
reference*string|null
notes*string|null
approvedAt*|
Formatdate-time
completedAt*|
Formatdate-time
feeAmountCents*|
Range-9007199254740991 <= value <= 9007199254740991
feeCurrency*|
Lengthlength <= 3
manualPayout*boolean
curl -X POST "https://example.com/v2/workers/me/transfer-requests" \  -H "Content-Type: application/json" \  -d '{    "paymentMethod": "paypal",    "amountCredits": 1000,    "paymentDetails": {      "email": "user@example.com"    }  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "workerId": "string",  "amountCredits": -9007199254740991,  "currency": "str",  "status": "pending",  "paymentMethod": "bank",  "paymentDetails": "string",  "processedAt": "2019-08-24T14:15:22Z",  "reference": "string",  "notes": "string",  "approvedAt": "2019-08-24T14:15:22Z",  "completedAt": "2019-08-24T14:15:22Z",  "feeAmountCents": -9007199254740991,  "feeCurrency": "str",  "manualPayout": true}
GET
/v2/workers/me/receipts

Authorization

openIdConnect
OpenID Connect<token>

Response Body

The worker's own payout receipts, newest first

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/workers/me/receipts"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "sequenceNumber": -9007199254740991,    "transferRequestId": "string",    "workerId": "string",    "amountCredits": -9007199254740991,    "currency": "str",    "completedAt": "2019-08-24T14:15:22Z",    "data": "string"  }]
GET
/v2/workers/me/receipts/:receiptId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

receiptId*string
Length24 <= length <= 24

Response Body

A payout receipt

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
sequenceNumber*integer
Range-9007199254740991 <= value <= 9007199254740991
transferRequestId*string
Lengthlength <= 24
workerId*string
Lengthlength <= 24
amountCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
currency*string
Lengthlength <= 3
completedAt*string
Formatdate-time
data*string|number|boolean|null||array<unknown>
curl -X GET "https://example.com/v2/workers/me/receipts/:receiptId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "sequenceNumber": -9007199254740991,  "transferRequestId": "string",  "workerId": "string",  "amountCredits": -9007199254740991,  "currency": "str",  "completedAt": "2019-08-24T14:15:22Z",  "data": "string"}
GET
/v2/workers/me/receipts/:receiptId/pdf

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

receiptId*string
Length24 <= length <= 24

Response Body

The payout receipt as a PDF file

response?fileapplication/pdf
Formatbinary
curl -X GET "https://example.com/v2/workers/me/receipts/:receiptId/pdf"
"string"
GET
/v2/workers/me/credit-ledger

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

limit?integer
Range1 <= value <= 200
Default50
offset?|
Range0 <= value
Default0

Response Body

The worker's own credit ledger, newest first

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/workers/me/credit-ledger"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "workerId": "string",    "type": "task_earned",    "amountCredits": -2147483648,    "balanceAfterCredits": -2147483648,    "blockedAfterCredits": -2147483648,    "referenceType": "string",    "referenceId": "string",    "description": "string"  }]
GET
/v2/worker-admin/workers

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

limit?number
Range1 <= value <= 200
Default50
offset?|
Range0 <= value
Default0
isBlocked?boolean|null

Response Body

Authenticated worker profiles (org-scoped, unless the caller is superadmin — then global with name/email)

application/json
  1. response
total*number
items*array<>
curl -X GET "https://example.com/v2/worker-admin/workers"
{  "total": 0,  "items": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "userId": "string",      "balanceCredits": -9007199254740991,      "blockedCredits": -9007199254740991,      "totalEarned": -9007199254740991,      "profile": "string",      "isBlocked": true,      "blockedAt": "2019-08-24T14:15:22Z",      "blockReason": "string",      "paymentEmail": "string",      "bankAccount": "string",      "lastSeenAt": "2019-08-24T14:15:22Z",      "payoutReminderSentAt": "2019-08-24T14:15:22Z",      "name": "string",      "email": "string"    }  ]}
GET
/v2/worker-admin/guest-workers

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

limit?number
Range1 <= value <= 200
Default50
offset?|
Range0 <= value
Default0
isBlocked?boolean|null

Response Body

Guest worker records

application/json
  1. response
total*number
items*array<>
curl -X GET "https://example.com/v2/worker-admin/guest-workers"
{  "total": 0,  "items": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "guestToken": "string",      "profile": "string",      "isBlocked": true,      "blockedAt": "2019-08-24T14:15:22Z",      "blockReason": "string",      "lastSeenAt": "2019-08-24T14:15:22Z"    }  ]}
POST
/v2/worker-admin/workers/:userId/block

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

userId*string
Length24 <= length <= 24

Request Body

Block reason

application/json
  1. body
reason?string
Lengthlength <= 500

Response Body

Blocked worker

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
userId*string
Lengthlength <= 24
balanceCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
blockedCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
totalEarned*integer
Range-9007199254740991 <= value <= 9007199254740991
profile*string|number|boolean|null||array<unknown>
isBlocked*boolean
blockedAt*|
Formatdate-time
blockReason*string|null
paymentEmail*string|null
bankAccount*string|number|boolean|null||array<unknown>
lastSeenAt*|
Formatdate-time
payoutReminderSentAt*|
Formatdate-time
curl -X POST "https://example.com/v2/worker-admin/workers/:userId/block" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "userId": "string",  "balanceCredits": -9007199254740991,  "blockedCredits": -9007199254740991,  "totalEarned": -9007199254740991,  "profile": "string",  "isBlocked": true,  "blockedAt": "2019-08-24T14:15:22Z",  "blockReason": "string",  "paymentEmail": "string",  "bankAccount": "string",  "lastSeenAt": "2019-08-24T14:15:22Z",  "payoutReminderSentAt": "2019-08-24T14:15:22Z"}
POST
/v2/worker-admin/workers/:userId/unblock

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

userId*string
Length24 <= length <= 24

Response Body

Unblocked worker

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
userId*string
Lengthlength <= 24
balanceCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
blockedCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
totalEarned*integer
Range-9007199254740991 <= value <= 9007199254740991
profile*string|number|boolean|null||array<unknown>
isBlocked*boolean
blockedAt*|
Formatdate-time
blockReason*string|null
paymentEmail*string|null
bankAccount*string|number|boolean|null||array<unknown>
lastSeenAt*|
Formatdate-time
payoutReminderSentAt*|
Formatdate-time
curl -X POST "https://example.com/v2/worker-admin/workers/:userId/unblock"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "userId": "string",  "balanceCredits": -9007199254740991,  "blockedCredits": -9007199254740991,  "totalEarned": -9007199254740991,  "profile": "string",  "isBlocked": true,  "blockedAt": "2019-08-24T14:15:22Z",  "blockReason": "string",  "paymentEmail": "string",  "bankAccount": "string",  "lastSeenAt": "2019-08-24T14:15:22Z",  "payoutReminderSentAt": "2019-08-24T14:15:22Z"}
POST
/v2/worker-admin/guest-workers/:guestWorkerId/block

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

guestWorkerId*string
Length24 <= length <= 24

Request Body

Block reason

application/json
  1. body
reason?string
Lengthlength <= 500

Response Body

Blocked guest worker

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
guestToken*string
profile*string|number|boolean|null||array<unknown>
isBlocked*boolean
blockedAt*|
Formatdate-time
blockReason*string|null
lastSeenAt*string
Formatdate-time
curl -X POST "https://example.com/v2/worker-admin/guest-workers/:guestWorkerId/block" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "guestToken": "string",  "profile": "string",  "isBlocked": true,  "blockedAt": "2019-08-24T14:15:22Z",  "blockReason": "string",  "lastSeenAt": "2019-08-24T14:15:22Z"}
POST
/v2/worker-admin/guest-workers/:guestWorkerId/unblock

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

guestWorkerId*string
Length24 <= length <= 24

Response Body

Unblocked guest worker

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
guestToken*string
profile*string|number|boolean|null||array<unknown>
isBlocked*boolean
blockedAt*|
Formatdate-time
blockReason*string|null
lastSeenAt*string
Formatdate-time
curl -X POST "https://example.com/v2/worker-admin/guest-workers/:guestWorkerId/unblock"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "guestToken": "string",  "profile": "string",  "isBlocked": true,  "blockedAt": "2019-08-24T14:15:22Z",  "blockReason": "string",  "lastSeenAt": "2019-08-24T14:15:22Z"}
PATCH
/v2/worker-admin/workers/:userId/profile

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

userId*string
Length24 <= length <= 24

Request Body

Profile key-value pairs

application/json
  1. body
profile*

Response Body

Updated worker profile

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
userId*string
Lengthlength <= 24
balanceCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
blockedCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
totalEarned*integer
Range-9007199254740991 <= value <= 9007199254740991
profile*string|number|boolean|null||array<unknown>
isBlocked*boolean
blockedAt*|
Formatdate-time
blockReason*string|null
paymentEmail*string|null
bankAccount*string|number|boolean|null||array<unknown>
lastSeenAt*|
Formatdate-time
payoutReminderSentAt*|
Formatdate-time
curl -X PATCH "https://example.com/v2/worker-admin/workers/:userId/profile" \  -H "Content-Type: application/json" \  -d '{    "profile": {      "property1": null,      "property2": null    }  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "userId": "string",  "balanceCredits": -9007199254740991,  "blockedCredits": -9007199254740991,  "totalEarned": -9007199254740991,  "profile": "string",  "isBlocked": true,  "blockedAt": "2019-08-24T14:15:22Z",  "blockReason": "string",  "paymentEmail": "string",  "bankAccount": "string",  "lastSeenAt": "2019-08-24T14:15:22Z",  "payoutReminderSentAt": "2019-08-24T14:15:22Z"}
PATCH
/v2/worker-admin/guest-workers/:guestWorkerId/profile

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

guestWorkerId*string
Length24 <= length <= 24

Request Body

Profile key-value pairs

application/json
  1. body
profile*

Response Body

Updated guest worker profile

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
guestToken*string
profile*string|number|boolean|null||array<unknown>
isBlocked*boolean
blockedAt*|
Formatdate-time
blockReason*string|null
lastSeenAt*string
Formatdate-time
curl -X PATCH "https://example.com/v2/worker-admin/guest-workers/:guestWorkerId/profile" \  -H "Content-Type: application/json" \  -d '{    "profile": {      "property1": null,      "property2": null    }  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "guestToken": "string",  "profile": "string",  "isBlocked": true,  "blockedAt": "2019-08-24T14:15:22Z",  "blockReason": "string",  "lastSeenAt": "2019-08-24T14:15:22Z"}
POST
/v2/worker-admin/workers/:userId/bonus

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

userId*string
Length24 <= length <= 24

Request Body

Bonus amount and note

application/json
  1. body
amountCredits*integer
Range1 <= value <= 5000
note*string
Length3 <= length <= 1000

Response Body

Bonus granted

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
organizationId*string
Lengthlength <= 24
workerId*string
Lengthlength <= 24
grantedByUserId*string
Lengthlength <= 24
amountCredits*integer
Range-2147483648 <= value <= 2147483647
platformFeeCents*integer
Range-2147483648 <= value <= 2147483647
totalChargeCents*integer
Range-2147483648 <= value <= 2147483647
note*string
curl -X POST "https://example.com/v2/worker-admin/workers/:userId/bonus" \  -H "Content-Type: application/json" \  -d '{    "amountCredits": 1,    "note": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "string",  "workerId": "string",  "grantedByUserId": "string",  "amountCredits": -2147483648,  "platformFeeCents": -2147483648,  "totalChargeCents": -2147483648,  "note": "string"}
GET
/v2/worker-admin/workers/:userId/bonuses

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

userId*string
Length24 <= length <= 24

Query Parameters

limit?number
Range1 <= value <= 200
Default50
offset?|
Range0 <= value
Default0

Response Body

Bonus history for this worker (org-scoped)

application/json
  1. response
total*number
items*array<>
curl -X GET "https://example.com/v2/worker-admin/workers/:userId/bonuses"
{  "total": 0,  "items": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "organizationId": "string",      "workerId": "string",      "grantedByUserId": "string",      "amountCredits": -2147483648,      "platformFeeCents": -2147483648,      "totalChargeCents": -2147483648,      "note": "string"    }  ]}
PATCH
/v2/worker-admin/workers/:userId/group

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

userId*string
Length24 <= length <= 24

Request Body

New group label (null or empty clears it)

application/json
  1. body
group*|
Lengthlength <= 100

Response Body

Updated worker profile

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
userId*string
Lengthlength <= 24
balanceCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
blockedCredits*integer
Range-9007199254740991 <= value <= 9007199254740991
totalEarned*integer
Range-9007199254740991 <= value <= 9007199254740991
profile*string|number|boolean|null||array<unknown>
isBlocked*boolean
blockedAt*|
Formatdate-time
blockReason*string|null
paymentEmail*string|null
bankAccount*string|number|boolean|null||array<unknown>
lastSeenAt*|
Formatdate-time
payoutReminderSentAt*|
Formatdate-time
curl -X PATCH "https://example.com/v2/worker-admin/workers/:userId/group" \  -H "Content-Type: application/json" \  -d '{    "group": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "userId": "string",  "balanceCredits": -9007199254740991,  "blockedCredits": -9007199254740991,  "totalEarned": -9007199254740991,  "profile": "string",  "isBlocked": true,  "blockedAt": "2019-08-24T14:15:22Z",  "blockReason": "string",  "paymentEmail": "string",  "bankAccount": "string",  "lastSeenAt": "2019-08-24T14:15:22Z",  "payoutReminderSentAt": "2019-08-24T14:15:22Z"}
PATCH
/v2/worker-admin/guest-workers/:guestWorkerId/group

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

guestWorkerId*string
Length24 <= length <= 24

Request Body

New group label (null or empty clears it)

application/json
  1. body
group*|
Lengthlength <= 100

Response Body

Updated guest worker

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
guestToken*string
profile*string|number|boolean|null||array<unknown>
isBlocked*boolean
blockedAt*|
Formatdate-time
blockReason*string|null
lastSeenAt*string
Formatdate-time
curl -X PATCH "https://example.com/v2/worker-admin/guest-workers/:guestWorkerId/group" \  -H "Content-Type: application/json" \  -d '{    "group": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "guestToken": "string",  "profile": "string",  "isBlocked": true,  "blockedAt": "2019-08-24T14:15:22Z",  "blockReason": "string",  "lastSeenAt": "2019-08-24T14:15:22Z"}
PATCH
/v2/worker-admin/workers/:userId/confirm-registration

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

userId*string
Length24 <= length <= 24

Response Body

Registration marked accepted

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
authentikUserId*integer
Range-2147483648 <= value <= 2147483647
userId*|
Lengthlength <= 24
status*string
Value in"pending""accepted""expired"
expirationDate*string
Formatdate-time
curl -X PATCH "https://example.com/v2/worker-admin/workers/:userId/confirm-registration"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "authentikUserId": -2147483648,  "userId": "string",  "status": "pending",  "expirationDate": "2019-08-24T14:15:22Z"}
PATCH
/v2/worker-admin/workers/:userId/manual-credit-grant

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

userId*string
Length24 <= length <= 24

Request Body

Grant amount and reason

application/json
  1. body
amountCredits*integer
Range1 <= value <= 20000
reason*string
Length3 <= length <= 500

Response Body

Credits granted

application/json
  1. response
balanceCredits*integer
ledgerEntryId*string
curl -X PATCH "https://example.com/v2/worker-admin/workers/:userId/manual-credit-grant" \  -H "Content-Type: application/json" \  -d '{    "amountCredits": 1,    "reason": "string"  }'
{  "balanceCredits": 0,  "ledgerEntryId": "string"}
GET
/v2/worker-admin/worker-stats

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

limit?number
Range1 <= value <= 200
Default50
offset?|
Range0 <= value
Default0

Response Body

Worker stats with aggregated metrics

application/json
  1. response
total*number
items*array<>
dailyActivity*array<>
curl -X GET "https://example.com/v2/worker-admin/worker-stats"
{  "total": 0,  "items": [    {      "id": "string",      "userId": "string",      "name": "string",      "email": "string",      "totalEarned": 0,      "balanceCredits": 0,      "isBlocked": true,      "joinedAt": "string",      "profile": {        "property1": null,        "property2": null      },      "tasksCompleted": 0,      "tasksThisWeek": 0,      "lastAnswerAt": "string",      "acceptRate": 0    }  ],  "dailyActivity": [    {      "day": "string",      "tasks": 0,      "workers": 0    }  ]}
GET
/v2/worker-panels

Authorization

openIdConnect
OpenID Connect<token>

Response Body

Worker panels for the active organization

application/json
  1. response
items*array<>
curl -X GET "https://example.com/v2/worker-panels"
{  "items": [    {      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "organizationId": "string",      "name": "string",      "description": "string",      "criteria": "string",      "matchingWorkerCount": 0,      "linkedJobCount": 0    }  ]}
POST
/v2/worker-panels

Authorization

openIdConnect
OpenID Connect<token>

Request Body

New worker panel

application/json
  1. body
name*string
Length1 <= length <= 100
description?string|null
criteria*array<>
Items1 <= items

Response Body

Created worker panel

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
organizationId*string
Lengthlength <= 24
name*string
description*string|null
criteria*string|number|boolean|null||array<unknown>
curl -X POST "https://example.com/v2/worker-panels" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "criteria": [      {        "key": "string",        "operator": "EQUAL"      }    ]  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "string",  "name": "string",  "description": "string",  "criteria": "string"}
GET
/v2/worker-panels/:panelId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

panelId*string
Length24 <= length <= 24

Response Body

Worker panel detail

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
organizationId*string
Lengthlength <= 24
name*string
description*string|null
criteria*string|number|boolean|null||array<unknown>
matchingWorkerCount*number
linkedJobs*array<>
curl -X GET "https://example.com/v2/worker-panels/:panelId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "string",  "name": "string",  "description": "string",  "criteria": "string",  "matchingWorkerCount": 0,  "linkedJobs": [    {      "id": "string",      "name": "string",      "projectId": "string",      "projectName": "string",      "status": "string"    }  ]}
PUT
/v2/worker-panels/:panelId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

panelId*string
Length24 <= length <= 24

Request Body

Updated worker panel

application/json
  1. body
name?string
Length1 <= length <= 100
description?string|null
criteria?array<>
Items1 <= items

Response Body

Updated worker panel

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
organizationId*string
Lengthlength <= 24
name*string
description*string|null
criteria*string|number|boolean|null||array<unknown>
curl -X PUT "https://example.com/v2/worker-panels/:panelId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "string",  "name": "string",  "description": "string",  "criteria": "string"}
DELETE
/v2/worker-panels/:panelId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

panelId*string
Length24 <= length <= 24

Response Body

Deleted worker panel

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
organizationId*string
Lengthlength <= 24
name*string
description*string|null
criteria*string|number|boolean|null||array<unknown>
curl -X DELETE "https://example.com/v2/worker-panels/:panelId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "string",  "name": "string",  "description": "string",  "criteria": "string"}
POST
/v2/projects/:projectId/ai-output-evaluations

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Length24 <= length <= 24

Request Body

New evaluation batch

application/json
  1. body
sourceType*string
Value in"verification_pipeline_run""lt_pipeline_run""external_submission"
sourceId*string
Length24 <= length <= 24
evaluationCriteria?
minResponses?integer
Range1 <= value <= 20

Response Body

Created evaluation batch

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
sourceType*string
Value in"verification_pipeline_run""lt_pipeline_run""external_submission"
sourceId*string
Lengthlength <= 24
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
crowdJobId*string|null
status*string
Value in"pending""dispatched""completed"
evaluationCriteria*string|number|boolean|null||array<unknown>
minResponses*integer
Range-2147483648 <= value <= 2147483647
aggregateTransparencyScore*string|null
curl -X POST "https://example.com/v2/projects/:projectId/ai-output-evaluations" \  -H "Content-Type: application/json" \  -d '{    "sourceType": "verification_pipeline_run",    "sourceId": "stringstringstringstring"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "sourceType": "verification_pipeline_run",  "sourceId": "string",  "projectId": "string",  "organizationId": "string",  "crowdJobId": "string",  "status": "pending",  "evaluationCriteria": "string",  "minResponses": -2147483648,  "aggregateTransparencyScore": "string"}
POST
/v2/projects/:projectId/ai-output-evaluations/external

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Length24 <= length <= 24

Request Body

External AI output to evaluate

application/json
  1. body
modelName*string

Name of the customer's AI system/model that produced the output

Length1 <= length <= 200
verdict*string

The verdict/label the external AI produced

Length1 <= length <= 500
explanation*string

The external AI's explanation or reasoning for the verdict

Length1 <= length <= 10000
confidence?number

The external AI's self-reported confidence, 0-100

Range0 <= value <= 100
evidenceUrls?array<string>

Supporting evidence links, if any

Itemsitems <= 20
evaluationCriteria?
minResponses?integer
Range1 <= value <= 20

Response Body

Created evaluation batch

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
sourceType*string
Value in"verification_pipeline_run""lt_pipeline_run""external_submission"
sourceId*string
Lengthlength <= 24
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
crowdJobId*string|null
status*string
Value in"pending""dispatched""completed"
evaluationCriteria*string|number|boolean|null||array<unknown>
minResponses*integer
Range-2147483648 <= value <= 2147483647
aggregateTransparencyScore*string|null
curl -X POST "https://example.com/v2/projects/:projectId/ai-output-evaluations/external" \  -H "Content-Type: application/json" \  -d '{    "modelName": "string",    "verdict": "string",    "explanation": "string"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "sourceType": "verification_pipeline_run",  "sourceId": "string",  "projectId": "string",  "organizationId": "string",  "crowdJobId": "string",  "status": "pending",  "evaluationCriteria": "string",  "minResponses": -2147483648,  "aggregateTransparencyScore": "string"}
GET
/v2/ai-output-evaluations

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

sourceType*string
Value in"verification_pipeline_run""lt_pipeline_run""external_submission"
sourceId*string
Length24 <= length <= 24

Response Body

Evaluation batches for a source run

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/ai-output-evaluations?sourceType=verification_pipeline_run&sourceId=stringstringstringstring"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "sourceType": "verification_pipeline_run",    "sourceId": "string",    "projectId": "string",    "organizationId": "string",    "crowdJobId": "string",    "status": "pending",    "evaluationCriteria": "string",    "minResponses": -2147483648,    "aggregateTransparencyScore": "string"  }]
GET
/v2/ai-output-evaluations/:batchId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

batchId*string
Length24 <= length <= 24

Response Body

Evaluation batch detail

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
sourceType*string
Value in"verification_pipeline_run""lt_pipeline_run""external_submission"
sourceId*string
Lengthlength <= 24
projectId*string
Lengthlength <= 24
organizationId*string
Lengthlength <= 24
crowdJobId*string|null
status*string
Value in"pending""dispatched""completed"
evaluationCriteria*string|number|boolean|null||array<unknown>
minResponses*integer
Range-2147483648 <= value <= 2147483647
aggregateTransparencyScore*string|null
responseCount*number
curl -X GET "https://example.com/v2/ai-output-evaluations/:batchId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "sourceType": "verification_pipeline_run",  "sourceId": "string",  "projectId": "string",  "organizationId": "string",  "crowdJobId": "string",  "status": "pending",  "evaluationCriteria": "string",  "minResponses": -2147483648,  "aggregateTransparencyScore": "string",  "responseCount": 0}
GET
/v2/ai-output-evaluations/:batchId/results

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

batchId*string
Length24 <= length <= 24

Response Body

Individual evaluations for this batch

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/ai-output-evaluations/:batchId/results"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "batchId": "string",    "crowdAnswerId": "string",    "ratings": "string",    "transparencyScore": "string",    "freeTextFeedback": "string",    "flaggedForRetraining": true,    "feedbackLogEntries": [      {        "id": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "aiStageSlug": "string",        "evaluationId": "string",        "signalType": "crowd_rating",        "payload": "string",        "appliedAt": "2019-08-24T14:15:22Z",        "appliedBy": "string",        "appliedNotes": "string"      }    ]  }]
PATCH
/v2/ai-output-evaluations/feedback/:feedbackLogId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

feedbackLogId*string
Length24 <= length <= 24

Request Body

Applied notes

application/json
  1. body
appliedNotes?string
Lengthlength <= 2000

Response Body

Updated feedback log entry

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
aiStageSlug*string
evaluationId*string
Lengthlength <= 24
signalType*string
Value in"crowd_rating""manual_review""auto_flagged"
payload*string|number|boolean|null||array<unknown>
appliedAt*|
Formatdate-time
appliedBy*|
Lengthlength <= 24
appliedNotes*string|null
curl -X PATCH "https://example.com/v2/ai-output-evaluations/feedback/:feedbackLogId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "aiStageSlug": "string",  "evaluationId": "string",  "signalType": "crowd_rating",  "payload": "string",  "appliedAt": "2019-08-24T14:15:22Z",  "appliedBy": "string",  "appliedNotes": "string"}
GET
/v2/monitoring-schedules

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

projectId?string
Length24 <= length <= 24

Response Body

List of monitoring schedules

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/monitoring-schedules"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "organizationId": "string",    "projectId": "string",    "sourceType": "verification_pipeline_run",    "sampleStrategy": "all",    "samplePercent": "string",    "sampleCount": -2147483648,    "cadence": "hourly",    "evaluationCriteria": "string",    "isActive": true,    "nextRunAt": "2019-08-24T14:15:22Z"  }]
POST
/v2/monitoring-schedules

Authorization

openIdConnect
OpenID Connect<token>

Request Body

New monitoring schedule

application/json
  1. body
projectId?string
Length24 <= length <= 24
sourceType*string
Value in"verification_pipeline_run""lt_pipeline_run""external_submission"
sampleStrategy?string
Value in"all""random_percent""fixed_count_per_period"
samplePercent?number
Range0 <= value <= 100
sampleCount?integer
Range1 <= value <= 50
cadence*string
Value in"hourly""daily""weekly"
evaluationCriteria?

Response Body

Created monitoring schedule

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
organizationId*string
Lengthlength <= 24
projectId*|
Lengthlength <= 24
sourceType*string
Value in"verification_pipeline_run""lt_pipeline_run""external_submission"
sampleStrategy*string
Value in"all""random_percent""fixed_count_per_period"
samplePercent*string|null
sampleCount*integer
Range-2147483648 <= value <= 2147483647
cadence*string
Value in"hourly""daily""weekly"
evaluationCriteria*string|number|boolean|null||array<unknown>
isActive*boolean
nextRunAt*|
Formatdate-time
curl -X POST "https://example.com/v2/monitoring-schedules" \  -H "Content-Type: application/json" \  -d '{    "sourceType": "verification_pipeline_run",    "cadence": "hourly"  }'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "string",  "projectId": "string",  "sourceType": "verification_pipeline_run",  "sampleStrategy": "all",  "samplePercent": "string",  "sampleCount": -2147483648,  "cadence": "hourly",  "evaluationCriteria": "string",  "isActive": true,  "nextRunAt": "2019-08-24T14:15:22Z"}
GET
/v2/monitoring-schedules/:scheduleId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

scheduleId*string
Formatcuid2

Response Body

Monitoring schedule

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
organizationId*string
Lengthlength <= 24
projectId*|
Lengthlength <= 24
sourceType*string
Value in"verification_pipeline_run""lt_pipeline_run""external_submission"
sampleStrategy*string
Value in"all""random_percent""fixed_count_per_period"
samplePercent*string|null
sampleCount*integer
Range-2147483648 <= value <= 2147483647
cadence*string
Value in"hourly""daily""weekly"
evaluationCriteria*string|number|boolean|null||array<unknown>
isActive*boolean
nextRunAt*|
Formatdate-time
curl -X GET "https://example.com/v2/monitoring-schedules/:scheduleId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "string",  "projectId": "string",  "sourceType": "verification_pipeline_run",  "sampleStrategy": "all",  "samplePercent": "string",  "sampleCount": -2147483648,  "cadence": "hourly",  "evaluationCriteria": "string",  "isActive": true,  "nextRunAt": "2019-08-24T14:15:22Z"}
PATCH
/v2/monitoring-schedules/:scheduleId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

scheduleId*string
Formatcuid2

Request Body

Updated schedule data

application/json
  1. body
sampleStrategy?string
Value in"all""random_percent""fixed_count_per_period"
samplePercent?number
Range0 <= value <= 100
sampleCount?integer
Range1 <= value <= 50
cadence?string
Value in"hourly""daily""weekly"
evaluationCriteria?
isActive?boolean

Response Body

Updated monitoring schedule

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
organizationId*string
Lengthlength <= 24
projectId*|
Lengthlength <= 24
sourceType*string
Value in"verification_pipeline_run""lt_pipeline_run""external_submission"
sampleStrategy*string
Value in"all""random_percent""fixed_count_per_period"
samplePercent*string|null
sampleCount*integer
Range-2147483648 <= value <= 2147483647
cadence*string
Value in"hourly""daily""weekly"
evaluationCriteria*string|number|boolean|null||array<unknown>
isActive*boolean
nextRunAt*|
Formatdate-time
curl -X PATCH "https://example.com/v2/monitoring-schedules/:scheduleId" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "string",  "projectId": "string",  "sourceType": "verification_pipeline_run",  "sampleStrategy": "all",  "samplePercent": "string",  "sampleCount": -2147483648,  "cadence": "hourly",  "evaluationCriteria": "string",  "isActive": true,  "nextRunAt": "2019-08-24T14:15:22Z"}
DELETE
/v2/monitoring-schedules/:scheduleId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

scheduleId*string
Formatcuid2

Response Body

Deleted monitoring schedule

application/json
  1. response
id*string
Lengthlength <= 24
createdAt*|
Formatdate-time
updatedAt*|
Formatdate-time
organizationId*string
Lengthlength <= 24
projectId*|
Lengthlength <= 24
sourceType*string
Value in"verification_pipeline_run""lt_pipeline_run""external_submission"
sampleStrategy*string
Value in"all""random_percent""fixed_count_per_period"
samplePercent*string|null
sampleCount*integer
Range-2147483648 <= value <= 2147483647
cadence*string
Value in"hourly""daily""weekly"
evaluationCriteria*string|number|boolean|null||array<unknown>
isActive*boolean
nextRunAt*|
Formatdate-time
curl -X DELETE "https://example.com/v2/monitoring-schedules/:scheduleId"
{  "id": "string",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "organizationId": "string",  "projectId": "string",  "sourceType": "verification_pipeline_run",  "sampleStrategy": "all",  "samplePercent": "string",  "sampleCount": -2147483648,  "cadence": "hourly",  "evaluationCriteria": "string",  "isActive": true,  "nextRunAt": "2019-08-24T14:15:22Z"}
GET
/v2/monitoring-schedules/:scheduleId/runs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

scheduleId*string
Formatcuid2

Response Body

Monitoring runs for a schedule

application/json
  1. response
[index: integer]?
curl -X GET "https://example.com/v2/monitoring-schedules/:scheduleId/runs"
[  {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "scheduleId": "string",    "periodStart": "2019-08-24T14:15:22Z",    "periodEnd": "2019-08-24T14:15:22Z",    "sampledCount": -2147483648,    "batchId": "string",    "aggregateScore": "string",    "driftFlag": true,    "status": "scheduled",    "error": "string"  }]

Organizations API

Manage organization settings, list and invite members, check balance, and configure modules.

Compliance Overview

Regulatory frameworks that Crowdee is designed to support.