Interactive API Reference

Authorization

openIdConnect

OpenID Connect<token>

Response Body

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

Empty

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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

{  "message": "string"}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

commentId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

commentId*string

Formatcuid2

Request Body

application/json

The updated comment data

TypeScript Definitions

Use the request body type in TypeScript.

text?string

Length1 <= length

image?string|null

time?string|null

edited?boolean

parentCommentId?|

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

commentId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

fileId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

fileId*string

Formatcuid2

Request Body

application/json

The fields to update on the file

TypeScript Definitions

Use the request body type in TypeScript.

metadata?unknown

tags?array<string>

privacyLevel?string

Value in

"private"
"sensitive"
"internal"
"public"

additionalInfo?unknown

folderId?|

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

fileId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

fileId*string

Formatcuid2

Response Body

`image/png`

`application/json`

curl -X GET "https://example.com/v2/files/:fileId/download"

{}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

fileId*string

Formatcuid2

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

fileId*string

Formatcuid2

Request Body

application/json

The comment metadata

TypeScript Definitions

Use the request body type in TypeScript.

text*string

Length1 <= length

image?string|null

time?string|null

edited?boolean

parentCommentId?|

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

fileId*string

Formatcuid2

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

fileId*string

Formatcuid2

Response Body

`application/json`

curl -X GET "https://example.com/v2/files/:fileId/presigned-url"

{  "url": "http://example.com"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

folderId*string

Formatcuid2

Request Body

application/json

The fields to update on the folder

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 100

parentId?|

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

folderId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

invitationId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

invitationId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

invitationId*string

Formatcuid2

Response Body

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

The organization to create

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length3 <= length <= 50

description*string

Length1 <= length <= 50

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

organizationId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

organizationId*string

Formatcuid2

Request Body

application/json

The organization fields to update

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length3 <= length <= 50

description?string

Length1 <= length <= 50

modules?array<>

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

organizationId*string

Formatcuid2

Request Body

application/json

The invite to create

TypeScript Definitions

Use the request body type in TypeScript.

inviteeEmail*string

Formatemail

role*string

Value in

"viewer"
"user"
"admin"
"superadmin"

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

organizationId*string

Formatcuid2

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

logo*file

Formatbinary

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

organizationId*string

Length24 <= length <= 24

userId*string

Length24 <= length <= 24

Request Body

application/json

New role for the member

TypeScript Definitions

Use the request body type in TypeScript.

role*string

Value in

"viewer"
"user"
"admin"

Response Body

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

organizationId*string

Formatcuid2

Response Body

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

organizationId*string

Formatcuid2

Request Body

application/json

The billing info to create for this organization

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

organizationId*string

Formatcuid2

Request Body

application/json

The billing info fields to update for this organization

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

organizationId*string

Formatcuid2

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

organizationId*string

Formatcuid2

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

id*string

Length24 <= length <= 24

Response Body

`application/json`

curl -X POST "https://example.com/v2/paypal/:id/create-order"

{  "orderId": "string"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

id*string

Length24 <= length <= 24

Response Body

`application/json`

curl -X POST "https://example.com/v2/paypal/:id/capture"

{  "ok": true}

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

type?string

Value in

"standard"
"research"

status?string

Value in

"active"
"archived"

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

The project metadata

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length3 <= length <= 50

description*string

Length1 <= length <= 50

type?string

Value in

"standard"
"research"

status?string

Value in

"active"
"archived"

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

curl -X GET "https://example.com/v2/projects/progress"

[  {    "projectId": "string",    "completed": 0,    "total": 0  }]

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

curl -X GET "https://example.com/v2/projects/stats"

{  "totalProjects": 0,  "activeProjects": 0,  "totalFiles": 0,  "totalCrowdAnswers": 0}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Request Body

application/json

The updated project data

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length3 <= length <= 50

description?string

Length1 <= length <= 50

type?string

Value in

"standard"
"research"

status?string

Value in

"active"
"archived"

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Query Parameters

pipelineId?string

Formatuuid

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Request Body

application/json

The workflow metadata

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file[]*|

folderId?string

Length24 <= length <= 24

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Request Body

application/json

The folder to create

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 100

parentId?|

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Request Body

application/json

The job metadata

TypeScript Definitions

Use the request body type in TypeScript.

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

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Response Body

`application/json`

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"      }    ]  ]]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Response Body

`application/json`

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"    }  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Request Body

application/json

New survey template with initial content

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"  }}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Response Body

`application/json`

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  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Request Body

application/json

New verification context

TypeScript Definitions

Use the request body type in TypeScript.

name*string

description?string|null

contextData*

isDefault?boolean

Response Body

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Request Body

application/json

New input data set with lists and optional groups

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"        }      ]    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"        }      ]    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Request Body

application/json

Pipeline run request

TypeScript Definitions

Use the request body type in TypeScript.

pipelineSlug*string

Length1 <= length <= 100

fileIds*array<>

Items1 <= items <= 50

contextId?string

Length24 <= length <= 24

Response Body

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Length24 <= length <= 24

fileId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Query Parameters

status?string

Value in

"pending"
"running"
"awaiting_crowd"
"completed"
"failed"

Response Body

`application/json`

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"      }    ]  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Formatcuid2

Request Body

application/json

Verification run request

TypeScript Definitions

Use the request body type in TypeScript.

pipelineSlug*string

Length1 <= length <= 100

fileIds*array<>

Itemsitems <= 50

contextId?string

Length24 <= length <= 24

contextData?

Response Body

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Length24 <= length <= 24

runId*string

Length24 <= length <= 24

Response Body

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Length24 <= length <= 24

runId*string

Length24 <= length <= 24

Response Body

`application/json`

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"    }  ]}

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

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

curl -X GET "https://example.com/v2/transactions/balance"

{  "balanceCents": 0}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

transactionId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

Charge request

TypeScript Definitions

Use the request body type in TypeScript.

amountCents*integer

Range100 <= value <= 500000

currency?"EUR"

Default"EUR"

Value in

"EUR"

description?string

Lengthlength <= 200

idempotencyKey?string

Length8 <= length <= 64

Response Body

`application/json`

curl -X POST "https://example.com/v2/transactions/charge" \  -H "Content-Type: application/json" \  -d '{    "amountCents": 100  }'

{  "transactionId": "stringstringstringstring",  "redirectUrl": "string"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

transactionId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

transactionId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

transactionId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

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

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

entryId*string

Length24 <= length <= 24

Response Body

`application/json`

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

Empty

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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      },      "panelSpecFields": [        "string"      ],      "panelSpecFieldOptions": {        "property1": [          {            "value": "string",            "labelEn": "string",            "labelDe": "string"          }        ],        "property2": [          {            "value": "string",            "labelEn": "string",            "labelDe": "string"          }        ]      },      "balanceCents": 0,      "currency": "string",      "activeExternalJobCount": 0    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

slug*string

Response Body

`application/json`

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  },  "panelSpecFields": [    "string"  ],  "panelSpecFieldOptions": {    "property1": [      {        "value": "string",        "labelEn": "string",        "labelDe": "string"      }    ],    "property2": [      {        "value": "string",        "labelEn": "string",        "labelDe": "string"      }    ]  },  "balanceCents": 0,  "currency": "string",  "activeExternalJobCount": 0}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

slug*string

Query Parameters

organizationId*string

Length24 <= length <= 24

Response Body

`application/json`

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"    }  ]}

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

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

slug*string

Request Body

application/json

New entry external job

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

slug*string

externalJobId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

slug*string

externalJobId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

slug*string

externalJobId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

slug*string

externalJobId*string

Length24 <= length <= 24

Response Body

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

slug*string

externalJobId*string

Length24 <= length <= 24

Response Body

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

slug*string

Response Body

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

slug*string

Request Body

application/json

Starting balance entry

TypeScript Definitions

Use the request body type in TypeScript.

amountCents*integer

currency?string

Length3 <= length <= 3

Default"EUR"

note*string

Length1 <= length

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

slug*string

Request Body

application/json

Balance correction entry

TypeScript Definitions

Use the request body type in TypeScript.

amountCents*integer

currency?string

Length3 <= length <= 3

Default"EUR"

note*string

Length1 <= length

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

The user to create

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

Profile update

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 100

timezone?string

Length1 <= length <= 100

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

curl -X GET "https://example.com/v2/users/me/registration-status"

{  "status": "pending"}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

curl -X POST "https://example.com/v2/users/me/resend-confirmation"

{  "message": "string"}

Authorization

openIdConnect

OpenID Connect<token>

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

avatar*file

Formatbinary

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

userId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

userId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

The user to create

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

registrationId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

Email address to send a password reset link to

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Formatemail

Response Body

`application/json`

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

{  "message": "string"}

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

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

TypeScript Definitions

Use the request body type in TypeScript.

token*string

Length24 <= length <= 24

password*string

Length8 <= length

Response Body

`application/json`

curl -X POST "https://example.com/v2/users/reset-password" \  -H "Content-Type: application/json" \  -d '{    "token": "stringstringstringstring",    "password": "stringst"  }'

{  "message": "string"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

userId*string

Formatcuid2

Request Body

application/json

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

TypeScript Definitions

Use the request body type in TypeScript.

role*string

Value in

"viewer"
"user"
"admin"

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"    }  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

organizationId*string

Formatcuid2

Response Body

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"    ]  }]

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

Create an API key for the authenticated user

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 100

role?|

Value in

"viewer"
"user"
"admin"
"superadmin"
null

expirationDate?|

Formatdate-time

organizationIds?array<>

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

apiKeyId*string

Formatcuid2

Request Body

application/json

Update an existing API key

TypeScript Definitions

Use the request body type in TypeScript.

name?string

role?|

Value in

"viewer"
"user"
"admin"
"superadmin"
null

expirationDate?|

Formatdate-time

state?string

Value in

"active"
"expired"

organizationIds?array<>

Response Body

`application/json`

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"  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

apiKeyId*string

Formatcuid2

Response Body

`application/json`

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"  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

apiKeyId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

workflowId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

workflowId*string

Formatcuid2

Request Body

application/json

The updated workflow data

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

workflowId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

workflowId*string

Formatcuid2

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

workflowId*string

Formatcuid2

Request Body

application/json

The comment metadata

TypeScript Definitions

Use the request body type in TypeScript.

text*string

Length1 <= length

image?string|null

time?string|null

edited?boolean

parentCommentId?|

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

workflowId*string

Formatcuid2

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

slug*string

Response Body

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

pipelineId*string

Formatuuid

Response Body

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

Create shared result payload

TypeScript Definitions

Use the request body type in TypeScript.

projectId*string

Length24 <= length <= 24

pipelineId*string

Formatuuid

durationHours*number

Range0 < value

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"      }    ]  }}

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

projectId?string

Length24 <= length <= 24

scope?string

Value in

"project"
"organization"
"public"

Response Body

`application/json`

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"    }  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

templateId*string

Formatcuid2

Response Body

`application/json`

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"  }}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

templateId*string

Formatcuid2

Request Body

application/json

Updated template data

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"  }}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

templateId*string

Formatcuid2

Response Body

`application/json`

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"  }}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

templateId*string

Formatcuid2

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

templateId*string

Length24 <= length <= 24

versionId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

projectId?string

Length24 <= length <= 24

scope?string

Value in

"project"
"organization"

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

dataSetId*string

Formatcuid2

Response Body

`application/json`

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"        }      ]    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

dataSetId*string

Formatcuid2

Request Body

application/json

Updated data set metadata

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"        }      ]    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

dataSetId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

dataSetId*string

Formatcuid2

Response Body

`application/json`

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"          }        }      ]    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

dataSetId*string

Formatcuid2

Request Body

application/json

New list (column) definition

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length

values*array<string>

Items1 <= items

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

dataSetId*string

Length24 <= length <= 24

listId*string

Length24 <= length <= 24

Response Body

`application/json`

curl -X DELETE "https://example.com/v2/input-data/:dataSetId/lists/:listId"

{  "id": "string",  "name": "string",  "values": "string"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

dataSetId*string

Formatcuid2

Request Body

application/json

New group definition

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length

listNames*array<string>

Items2 <= items

Response Body

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

dataSetId*string

Length24 <= length <= 24

groupId*string

Length24 <= length <= 24

Request Body

application/json

Updated group definition

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length

listNames?array<string>

Items2 <= items

Response Body

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

dataSetId*string

Length24 <= length <= 24

groupId*string

Length24 <= length <= 24

Response Body

`application/json`

curl -X DELETE "https://example.com/v2/input-data/:dataSetId/groups/:groupId"

{  "id": "string",  "name": "string",  "lists": [    {      "id": "string",      "name": "string",      "values": "string"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

projectId?string

Length24 <= length <= 24

Response Body

`application/json`

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  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

contextId*string

Formatcuid2

Response Body

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

contextId*string

Formatcuid2

Request Body

application/json

Updated context data

TypeScript Definitions

Use the request body type in TypeScript.

name?string

description?string|null

contextData?

isDefault?boolean

Response Body

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

contextId*string

Formatcuid2

Response Body

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

status?string

Value in

"pending"
"running"
"awaiting_crowd"
"completed"
"failed"

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

New compliance check

TypeScript Definitions

Use the request body type in TypeScript.

regulation*string

Length1 <= length

category*string

Length1 <= length

status?string

Value in

"compliant"
"warning"
"non_compliant"

details*string

Length1 <= length

actionRequired?string

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

checkId*string

Length24 <= length <= 24

Request Body

application/json

Updated compliance check fields

TypeScript Definitions

Use the request body type in TypeScript.

status?string

Value in

"compliant"
"warning"
"non_compliant"

details?string

Length1 <= length

actionRequired?string|null

lastCheckedAt?string

Formatdate-time

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

checkId*string

Length24 <= length <= 24

Response Body

`application/json`

curl -X DELETE "https://example.com/v2/compliance/checks/:checkId"

Empty

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

limit?integer

Range1 <= value <= 200

Default50

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

New audit event

TypeScript Definitions

Use the request body type in TypeScript.

action*string

Length1 <= length

regulation*string

Length1 <= length

result?string

Value in

"pass"
"info"
"warning"

metadata?

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

New compliance export

TypeScript Definitions

Use the request body type in TypeScript.

projectName*string

Length1 <= length

projectId?string

Length24 <= length <= 24

regulation*string

Length1 <= length

dueDate*string

Formatdate-time

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

exportId*string

Length24 <= length <= 24

Request Body

application/json

Updated export status

TypeScript Definitions

Use the request body type in TypeScript.

status*string

Value in

"pending"
"in_progress"
"completed"
"cancelled"

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

exportId*string

Length24 <= length <= 24

Response Body

`application/json`

curl -X DELETE "https://example.com/v2/compliance/exports/:exportId"

Empty

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

curl -X GET "https://example.com/v2/datasets/catalog/cleaning-pipelines"

[  {    "slug": "string",    "name": "string",    "description": "string",    "supportedModalities": [      "image"    ]  }]

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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  }]

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

New dataset

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Formatcuid2

Response Body

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Formatcuid2

Request Body

application/json

Updated dataset metadata

TypeScript Definitions

Use the request body type in TypeScript.

name?string

description?string|null

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Formatcuid2

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file[]*|

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Length24 <= length <= 24

fileId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Formatcuid2

Response Body

`application/json`

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"  }]

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

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Length24 <= length <= 24

versionId*string

Length24 <= length <= 24

fileId*string

Length24 <= length <= 24

Request Body

application/json

Whether this file should be excluded from the version

TypeScript Definitions

Use the request body type in TypeScript.

excluded*boolean

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Length24 <= length <= 24

versionId*string

Length24 <= length <= 24

Request Body

application/json

Cleaning pipeline configuration

TypeScript Definitions

Use the request body type in TypeScript.

pipelineSlug*"clean-audio-silence"

Value in

"clean-audio-silence"

label?string

Lengthlength <= 100

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Length24 <= length <= 24

versionId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Length24 <= length <= 24

versionId*string

Length24 <= length <= 24

Response Body

`application/json`

curl -X GET "https://example.com/v2/datasets/:datasetId/versions/:versionId/export"

{  "files": [    {      "fileId": "string",      "name": "string",      "mimeType": "string",      "size": 0,      "url": "string"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"      }    ]  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Request Body

application/json

LT pipeline run request

TypeScript Definitions

Use the request body type in TypeScript.

pipelineSlug*string

fileIds*array<string>

Items1 <= items

contextData?

Response Body

`application/json`

curl -X POST "https://example.com/v2/lt-pipelines/project/:projectId/run" \  -H "Content-Type: application/json" \  -d '{    "pipelineSlug": "string",    "fileIds": [      "string"    ]  }'

{  "runIds": [    "string"  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Query Parameters

status?string

Value in

"pending"
"running"
"completed"
"failed"

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

versionId*string

Request Body

application/json

LT pipeline dataset version run request

TypeScript Definitions

Use the request body type in TypeScript.

pipelineSlug*string

contextData?

Response Body

`application/json`

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"  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

versionId*string

Query Parameters

status?string

Value in

"pending"
"running"
"completed"
"failed"

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

runId*string

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"      }    ]  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

slug*string

Request Body

application/json

Data Platform pipeline run request

TypeScript Definitions

Use the request body type in TypeScript.

targetType*"project_file"

Value in

"project_file"

projectId*string

fileIds*array<string>

Items1 <= items

contextData?

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

projectId?string

datasetVersionId?string

status?string

Value in

"pending"
"running"
"awaiting_crowd"
"completed"
"failed"

Response Body

`application/json`

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"      }    ]  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

runId*string

Response Body

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

curl -X GET "https://example.com/v2/data-platform/datasets/catalog/cleaning-pipelines"

[  {    "slug": "string",    "name": "string",    "description": "string",    "supportedModalities": [      "image"    ]  }]

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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  }]

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

New dataset

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Formatcuid2

Response Body

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Formatcuid2

Request Body

application/json

Updated dataset metadata

TypeScript Definitions

Use the request body type in TypeScript.

name?string

description?string|null

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Formatcuid2

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file[]*|

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Length24 <= length <= 24

fileId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Formatcuid2

Response Body

`application/json`

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"  }]

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

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Length24 <= length <= 24

versionId*string

Length24 <= length <= 24

fileId*string

Length24 <= length <= 24

Request Body

application/json

Whether this file should be excluded from the version

TypeScript Definitions

Use the request body type in TypeScript.

excluded*boolean

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Length24 <= length <= 24

versionId*string

Length24 <= length <= 24

Request Body

application/json

Cleaning pipeline configuration

TypeScript Definitions

Use the request body type in TypeScript.

pipelineSlug*"clean-audio-silence"

Value in

"clean-audio-silence"

label?string

Lengthlength <= 100

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Length24 <= length <= 24

versionId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

datasetId*string

Length24 <= length <= 24

versionId*string

Length24 <= length <= 24

Response Body

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

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

TypeScript Definitions

Use the request body type in TypeScript.

sourceType*"dataset_version"

Value in

"dataset_version"

datasetId*string

versionId*string

name?string

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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  }]

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

curl -X GET "https://example.com/v2/ai-platform/finetune-dataset-sources/crowd-jobs"

[  {    "projectId": "string",    "projectName": "string",    "jobId": "string",    "jobName": "string",    "acceptedAnswerCount": 0  }]

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

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

TypeScript Definitions

Use the request body type in TypeScript.

projectId*string

name?string

Response Body

`application/json`

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"  }}

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

status?string

Value in

"queued"
"running"
"completed"
"failed"

Response Body

`application/json`

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"    }  }]

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

Start a finetuning run

TypeScript Definitions

Use the request body type in TypeScript.

finetuneDatasetId*string

baseModelSlug*string

hyperparams?

Response Body

`application/json`

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"  }}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

runId*string

Response Body

`application/json`

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"  }}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

New feedback report

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

limit?number

Range1 <= value <= 200

Default50

offset?|

Range0 <= value

Default0

Response Body

`application/json`

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"    }  ]}

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

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Length24 <= length <= 24

Request Body

application/json

New crowd job

TypeScript Definitions

Use the request body type in TypeScript.

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

gatheringCriteria?

Response Body

`application/json`

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"}

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

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Length24 <= length <= 24

Query Parameters

group*string

Value in

"active"
"archived"
"qualification"

Response Body

`application/json`

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      }    ]  }}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Response Body

`application/json`

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",  "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  }}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Request Body

application/json

Updated crowd job

TypeScript Definitions

Use the request body type in TypeScript.

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

surveyTemplateVersionId?string

Length24 <= length <= 24

autoAcceptHours?|

Range0 <= value <= 120

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Request Body

application/json

Pending-answers disposition

TypeScript Definitions

Use the request body type in TypeScript.

pendingAnswersAction?string

Value in

"accept"
"reject"

acceptanceNote?string

Lengthlength <= 500

rejectionReason?string

Lengthlength <= 500

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Response Body

`application/json`

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"      }    ]  }}

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

`application/json`

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",      "acceptanceNote": "string",      "creditsEarned": -9007199254740991,      "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"      }    }  ]}

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

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Response Body

`application/json`

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    }  ]}

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

`application/json`

curl -X GET "https://example.com/v2/crowd-jobs/:jobId/answers/export"

[  {    "property1": null,    "property2": null  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Response Body

`application/zip`

`application/json`

curl -X GET "https://example.com/v2/crowd-jobs/:jobId/files/download"

"string"

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Request Body

application/json

Dataset creation options

TypeScript Definitions

Use the request body type in TypeScript.

datasetName*string

Length1 <= length <= 100

fileFieldNames?array<string>

answerStatus?string

Default"all"

Value in

"pending"
"accepted"
"rejected"
"all"

Response Body

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Request Body

application/json

Input data creation options

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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}

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

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Request Body

application/json

Dataset creation options

TypeScript Definitions

Use the request body type in TypeScript.

datasetName*string

Length1 <= length <= 100

reviewStatus?string

Default"accepted"

Value in

"pending"
"accepted"
"rejected"
"duplicate"
"all"

Response Body

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Request Body

application/json

Input data creation options

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Request Body

application/json

Clone options

TypeScript Definitions

Use the request body type in TypeScript.

isDryRun?boolean

name?string

Length3 <= length <= 100

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Query Parameters

additionalRepetitions*integer

Range1 <= value

Response Body

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Request Body

application/json

Extend options

TypeScript Definitions

Use the request body type in TypeScript.

additionalRepetitions*integer

Range1 <= value

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

answerId*string

Length24 <= length <= 24

Request Body

application/json

Acceptance note

TypeScript Definitions

Use the request body type in TypeScript.

acceptanceNote?string

Lengthlength <= 500

Response Body

`application/json`

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",  "acceptanceNote": "string",  "creditsEarned": -9007199254740991}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

answerId*string

Length24 <= length <= 24

Request Body

application/json

Rejection reason

TypeScript Definitions

Use the request body type in TypeScript.

rejectionReason?string

Lengthlength <= 500

Response Body

`application/json`

curl -X PATCH "https://example.com/v2/crowd-answers/:answerId/reject" \  -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",  "acceptanceNote": "string",  "creditsEarned": -9007199254740991}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

itemId*string

Length24 <= length <= 24

Request Body

application/json

New review status

TypeScript Definitions

Use the request body type in TypeScript.

reviewStatus*string

Value in

"pending"
"accepted"
"rejected"
"duplicate"

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

The worker account to create

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

registrationId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

jobId*string

Length24 <= length <= 24

Query Parameters

dryRunToken?string

guestWorkerId?string

Response Body

`application/json`

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",  "maxSlots": 0,  "computedStatus": "string",  "qualificationEligibility": {    "state": "eligible"  },  "panelEligibility": {    "state": "eligible"  }}

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

Response Body

`application/json`

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"  }}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

taskId*string

Length24 <= length <= 24

Query Parameters

guestWorkerId?string

Response Body

`application/json`

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",  "expiresAt": "2019-08-24T14:15:22Z"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

taskId*string

Length24 <= length <= 24

Query Parameters

guestWorkerId?string

externalCorrelationToken?string

Request Body

application/json

Answer submission

TypeScript Definitions

Use the request body type in TypeScript.

answers*

fileIds?array<>

screenResolution?string

Lengthlength <= 20

userAgent?string

Lengthlength <= 500

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

taskId*string

Length24 <= length <= 24

Query Parameters

guestWorkerId?string

Request Body

application/json

Post-task feedback

TypeScript Definitions

Use the request body type in TypeScript.

rating*integer

Range1 <= value <= 5

labels?array<>

Itemsitems <= 8

Default[]

message?string

Lengthlength <= 2000

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

taskId*string

Length24 <= length <= 24

Query Parameters

guestWorkerId?string

transcribe?|

Defaultfalse

language?string

Response Body

`application/json`

curl -X POST "https://example.com/v2/workers/tasks/:taskId/files"

{  "fileId": "string",  "transcription": "string"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

taskId*string

Length24 <= length <= 24

Query Parameters

guestWorkerId?string

Request Body

application/json

Search query

TypeScript Definitions

Use the request body type in TypeScript.

query*string

Length1 <= length <= 200

Response Body

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

guestWorkerId*string

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

guestWorkerId*string

guestGroup?string

Length1 <= length <= 100

Request Body

application/json

Guest profile update

TypeScript Definitions

Use the request body type in TypeScript.

profile*

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

limit?number

Range1 <= value <= 100

Default50

offset?|

Range0 <= value

Default0

Response Body

`application/json`

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",      "maxSlots": 0    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

Profile update

TypeScript Definitions

Use the request body type in TypeScript.

paymentEmail?|

Formatemail

bankAccount?|null

profile?

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

curl -X DELETE "https://example.com/v2/workers/me"

{  "message": "string"}

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

`application/json`

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",      "expiresAt": "2019-08-24T14:15:22Z",      "reviewNote": "string"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

Billing/tax info to create

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

Billing/tax info to replace

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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  }]

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

Payout request

TypeScript Definitions

Use the request body type in TypeScript.

paymentMethod*"paypal"

Value in

"paypal"

amountCredits*integer

Range500 <= value

paymentDetails*

Response Body

`application/json`

curl -X POST "https://example.com/v2/workers/me/transfer-requests" \  -H "Content-Type: application/json" \  -d '{    "paymentMethod": "paypal",    "amountCredits": 500,    "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}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

receiptId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

limit?integer

Range1 <= value <= 200

Default50

offset?|

Range0 <= value

Default0

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

limit?number

Range1 <= value <= 200

Default50

offset?|

Range0 <= value

Default0

isBlocked?boolean|null

Response Body

`application/json`

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",      "name": "string",      "email": "string"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

limit?number

Range1 <= value <= 200

Default50

offset?|

Range0 <= value

Default0

isBlocked?boolean|null

Response Body

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

userId*string

Length24 <= length <= 24

Request Body

application/json

Block reason

TypeScript Definitions

Use the request body type in TypeScript.

reason?string

Lengthlength <= 500

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

userId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

guestWorkerId*string

Length24 <= length <= 24

Request Body

application/json

Block reason

TypeScript Definitions

Use the request body type in TypeScript.

reason?string

Lengthlength <= 500

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

guestWorkerId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

userId*string

Length24 <= length <= 24

Request Body

application/json

Profile key-value pairs

TypeScript Definitions

Use the request body type in TypeScript.

profile*

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

guestWorkerId*string

Length24 <= length <= 24

Request Body

application/json

Profile key-value pairs

TypeScript Definitions

Use the request body type in TypeScript.

profile*

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

userId*string

Length24 <= length <= 24

Request Body

application/json

Bonus amount and note

TypeScript Definitions

Use the request body type in TypeScript.

amountCredits*integer

Range1 <= value <= 5000

note*string

Length3 <= length <= 1000

Response Body

`application/json`

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"}

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

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

userId*string

Length24 <= length <= 24

Request Body

application/json

New group label (null or empty clears it)

TypeScript Definitions

Use the request body type in TypeScript.

group*|

Lengthlength <= 100

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

guestWorkerId*string

Length24 <= length <= 24

Request Body

application/json

New group label (null or empty clears it)

TypeScript Definitions

Use the request body type in TypeScript.

group*|

Lengthlength <= 100

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

userId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

userId*string

Length24 <= length <= 24

Request Body

application/json

Grant amount and reason

TypeScript Definitions

Use the request body type in TypeScript.

amountCredits*integer

Range1 <= value <= 20000

reason*string

Length3 <= length <= 500

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

limit?number

Range1 <= value <= 200

Default50

offset?|

Range0 <= value

Default0

Response Body

`application/json`

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    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Response Body

`application/json`

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    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

New worker panel

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 100

description?string|null

criteria*array<>

Items1 <= items

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

panelId*string

Length24 <= length <= 24

Response Body

`application/json`

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"    }  ]}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

panelId*string

Length24 <= length <= 24

Request Body

application/json

Updated worker panel

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 100

description?string|null

criteria?array<>

Items1 <= items

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

panelId*string

Length24 <= length <= 24

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Length24 <= length <= 24

Request Body

application/json

New evaluation batch

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

projectId*string

Length24 <= length <= 24

Request Body

application/json

External AI output to evaluate

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"}

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

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

batchId*string

Length24 <= length <= 24

Response Body

`application/json`

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}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

batchId*string

Length24 <= length <= 24

Response Body

`application/json`

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"      }    ]  }]

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

feedbackLogId*string

Length24 <= length <= 24

Request Body

application/json

Applied notes

TypeScript Definitions

Use the request body type in TypeScript.

appliedNotes?string

Lengthlength <= 2000

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Query Parameters

projectId?string

Length24 <= length <= 24

Response Body

`application/json`

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"  }]

Authorization

openIdConnect

OpenID Connect<token>

Request Body

application/json

New monitoring schedule

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

scheduleId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

scheduleId*string

Formatcuid2

Request Body

application/json

Updated schedule data

TypeScript Definitions

Use the request body type in TypeScript.

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

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

scheduleId*string

Formatcuid2

Response Body

`application/json`

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"}

Authorization

openIdConnect

OpenID Connect<token>

Path Parameters

scheduleId*string

Formatcuid2

Response Body

`application/json`

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"  }]

Interactive API Reference

302

200application/json

200application/json

200application/json

404application/json

422application/json

200application/json

400application/json

404application/json

422application/json

200application/json

404application/json

422application/json

200application/json

200application/json

404application/json

422application/json

200application/json

403application/json

404application/json

422application/json

200application/json

400application/json

404application/json

422application/json

302image/png

404application/json

422application/json

200application/json

404application/json

422application/json

200application/json

400application/json

404application/json

422application/json

200application/json

404application/json

422application/json

200application/json

403application/json

404application/json

422application/json

200application/json

400application/json

404application/json

422application/json

200application/json

400application/json

404application/json

422application/json

200application/json

403application/json

404application/json

422application/json

200application/json

400application/json

403application/json

404application/json

422application/json

200application/json

400application/json

403application/json

404application/json

409application/json

410application/json

422application/json

500application/json

200application/json

200application/json

400application/json

422application/json

200application/json

404application/json

422application/json

200application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`image/png`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`