Crowdee
API Reference

Interactive API Reference

Explore and test all Crowdee API endpoints interactively.

GET
/v2/auth/start

Authorization

openIdConnect
OpenID Connect<token>

Response Body

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

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

curl -X GET "https://example.com/v2/auth/logout"
{  "message": "string"}
GET
/v2/comments

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"  }]
GET
/v2/comments/:commentId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

commentId*string
Formatcuid2

Response Body

application/json

application/json

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"}
PUT
/v2/comments/:commentId

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.

Response Body

application/json

application/json

application/json

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"}
DELETE
/v2/comments/:commentId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

commentId*string
Formatcuid2

Response Body

application/json

application/json

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"}
GET
/v2/files

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"  }]
GET
/v2/files/:fileId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

fileId*string
Formatcuid2

Response Body

application/json

application/json

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"}
PUT
/v2/files/:fileId

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.

Response Body

application/json

application/json

application/json

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"}
DELETE
/v2/files/:fileId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

fileId*string
Formatcuid2

Response Body

application/json

application/json

application/json

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"}
GET
/v2/files/:fileId/download

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

fileId*string
Formatcuid2

Response Body

image/png

application/json

application/json

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

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

fileId*string
Formatcuid2

Response Body

application/json

application/json

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"  }]
POST
/v2/files/:fileId/comments

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.

Response Body

application/json

application/json

application/json

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"}
GET
/v2/files/:fileId/workflows

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

fileId*string
Formatcuid2

Response Body

application/json

application/json

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"  }]
GET
/v2/files/:fileId/presigned-url

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

fileId*string
Formatcuid2

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v2/files/:fileId/presigned-url"
{  "url": "http://example.com"}
PUT
/v2/folders/:folderId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

folderId*string
Formatcuid2

Request Body

application/json

The fields to update on the folder

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

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"}
DELETE
/v2/folders/:folderId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

folderId*string
Formatcuid2

Response Body

application/json

application/json

application/json

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"}
GET
/v2/invitations/:invitationId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

invitationId*string
Formatcuid2

Response Body

application/json

application/json

application/json

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"}
DELETE
/v2/invitations/:invitationId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

invitationId*string
Formatcuid2

Response Body

application/json

application/json

application/json

application/json

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"}
POST
/v2/invitations/:invitationId/accept

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

invitationId*string
Formatcuid2

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

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}
GET
/v2/organizations

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"  }]
POST
/v2/organizations

Authorization

openIdConnect
OpenID Connect<token>

Request Body

application/json

The organization to create

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

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"}
GET
/v2/organizations/:organizationId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Formatcuid2

Response Body

application/json

application/json

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"}
PUT
/v2/organizations/:organizationId

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.

Response Body

application/json

application/json

application/json

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"}
POST
/v2/organizations/:organizationId/invite

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.

Response Body

application/json

application/json

application/json

application/json

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"}
PATCH
/v2/organizations/:organizationId/logo

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Formatcuid2

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

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"}
PATCH
/v2/organizations/:organizationId/members/:userId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Request Body

application/json

New role for the member

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

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}
GET
/v2/organizations/:organizationId/billing

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Formatcuid2

Response Body

application/json

application/json

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}
POST
/v2/organizations/:organizationId/billing

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.

Response Body

application/json

application/json

application/json

application/json

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}
PUT
/v2/organizations/:organizationId/billing

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.

Response Body

application/json

application/json

application/json

application/json

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}
GET
/v2/organizations/:organizationId/users

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Formatcuid2

Response Body

application/json

application/json

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"  }]
GET
/v2/organizations/:organizationId/invitations

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Formatcuid2

Response Body

application/json

application/json

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"  }]
POST
/v2/paypal/:id/create-order

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

id*string
Length24 <= length <= 24

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v2/paypal/:id/create-order"
{  "orderId": "string"}
POST
/v2/paypal/:id/capture

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

id*string
Length24 <= length <= 24

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v2/paypal/:id/capture"
{  "ok": true}
GET
/v2/projects

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

type?string

Value in

  • "standard"
  • "research"

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"  }]
POST
/v2/projects

Authorization

openIdConnect
OpenID Connect<token>

Request Body

application/json

The project metadata

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

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"}
GET
/v2/projects/:projectId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

application/json

application/json

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"}
PUT
/v2/projects/:projectId

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.

Response Body

application/json

application/json

application/json

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"}
DELETE
/v2/projects/:projectId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

application/json

application/json

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"}
GET
/v2/projects/:projectId/workflows

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Query Parameters

pipelineId?string
Formatuuid

Response Body

application/json

application/json

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"  }]
POST
/v2/projects/:projectId/workflows

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.

Response Body

application/json

application/json

application/json

application/json

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"}
GET
/v2/projects/:projectId/files

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

application/json

application/json

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"  }]
POST
/v2/projects/:projectId/files

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

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"  }]
GET
/v2/projects/:projectId/comments

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

application/json

application/json

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"  }]
GET
/v2/projects/:projectId/folders

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

application/json

application/json

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"  }]
POST
/v2/projects/:projectId/folders

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.

Response Body

application/json

application/json

application/json

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"}
GET
/v2/projects/:projectId/jobs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

application/json

application/json

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"  }]
POST
/v2/projects/:projectId/jobs

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.

Response Body

application/json

application/json

application/json

application/json

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"}
GET
/v2/projects/:projectId/dossier

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

application/json

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"      }    ]  ]]
GET
/v2/projects/:projectId/survey-templates

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

application/json

application/json

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"    }  }]
POST
/v2/projects/:projectId/survey-templates

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.

Response Body

application/json

application/json

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"  }}
GET
/v2/projects/:projectId/verification-contexts

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

application/json

application/json

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  }]
POST
/v2/projects/:projectId/verification-contexts

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.

Response Body

application/json

application/json

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}
GET
/v2/projects/:projectId/input-data

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

application/json

application/json

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"  }]
POST
/v2/projects/:projectId/input-data

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.

Response Body

application/json

application/json

application/json

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"        }      ]    }  ]}
POST
/v2/projects/:projectId/input-data/from-csv

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

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"        }      ]    }  ]}
GET
/v2/projects/:projectId/pipeline-runs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Response Body

application/json

application/json

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"  }]
POST
/v2/projects/:projectId/run-pipeline

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.

Response Body

application/json

application/json

application/json

application/json

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"    }  ]}
POST
/v2/projects/:projectId/files/:fileId/enrichment/retry

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Response Body

application/json

application/json

application/json

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"}
GET
/v2/projects/:projectId/verification-runs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Formatcuid2

Query Parameters

status?string

Value in

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

Response Body

application/json

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"      }    ]  }]
POST
/v2/projects/:projectId/verification-runs

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.

Response Body

application/json

application/json

application/json

application/json

application/json

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"    }  ]}
GET
/v2/projects/:projectId/verification-runs/:runId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Response Body

application/json

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"    }  ]}
POST
/v2/projects/:projectId/verification-runs/:runId/restart

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Response Body

application/json

application/json

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"    }  ]}
GET
/v2/transactions

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

status?string

Value in

  • "pending"
  • "succeeded"
  • "failed"
  • "canceled"
type?string

Value in

  • "charge"
  • "refund"
limit?integer
Range1 <= value <= 200
Default50
offset?|
Range0 <= value
Default0

Response Body

application/json

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"  }]
GET
/v2/transactions/balance

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

application/json

curl -X GET "https://example.com/v2/transactions/balance"
{  "balanceCents": 0}
GET
/v2/transactions/:transactionId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

transactionId*string
Length24 <= length <= 24

Response Body

application/json

application/json

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"}
POST
/v2/transactions/charge

Authorization

openIdConnect
OpenID Connect<token>

Request Body

application/json

Charge request

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

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

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

transactionId*string
Length24 <= length <= 24

Response Body

application/json

application/json

application/json

application/json

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"}
POST
/v2/transactions/:transactionId/cancel

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

transactionId*string
Length24 <= length <= 24

Response Body

application/json

application/json

application/json

application/json

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"}
POST
/v2/transactions/:transactionId/fail

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

transactionId*string
Length24 <= length <= 24

Response Body

application/json

application/json

application/json

application/json

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"}
GET
/v2/credit-ledger

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

type?string

Value in

  • "paypal_charge"
  • "paypal_refund"
  • "job_funded"
  • "job_refunded"
  • "job_reward_adjusted_debit"
  • "job_reward_adjusted_credit"
  • "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

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"  }]
GET
/v2/credit-ledger/:entryId/receipt

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

entryId*string
Length24 <= length <= 24

Response Body

application/json

application/json

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

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"  }]
POST
/v2/users

Authorization

openIdConnect
OpenID Connect<token>

Request Body

application/json

The user to create

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

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"}
GET
/v2/users/me

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

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"}
PATCH
/v2/users/me

Authorization

openIdConnect
OpenID Connect<token>

Request Body

application/json

Profile update

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

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"}
GET
/v2/users/me/registration-status

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

curl -X GET "https://example.com/v2/users/me/registration-status"
{  "status": "pending"}
POST
/v2/users/me/resend-confirmation

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

application/json

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

Authorization

openIdConnect
OpenID Connect<token>

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

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"}
GET
/v2/users/:userId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

userId*string
Formatcuid2

Response Body

application/json

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"}
DELETE
/v2/users/:userId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

userId*string
Formatcuid2

Response Body

application/json

application/json

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"}
POST
/v2/users/signup

Authorization

openIdConnect
OpenID Connect<token>

Request Body

application/json

The user to create

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

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"}
GET
/v2/users/verify/:registrationId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

registrationId*string
Formatcuid2

Response Body

application/json

application/json

application/json

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"}
POST
/v2/users/request-password-reset

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.

Response Body

application/json

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"}
POST
/v2/users/reset-password

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.

Response Body

application/json

application/json

application/json

application/json

application/json

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

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

userId*string
Formatcuid2

Request Body

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.

Response Body

application/json

application/json

application/json

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"}
GET
/v2/users/me/organizations

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"    }  }]
PUT
/v2/users/me/organizations/:organizationId/default

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

organizationId*string
Formatcuid2

Response Body

application/json

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}
GET
/v2/users/me/api-keys

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"    ]  }]
POST
/v2/users/me/api-keys

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.

Response Body

application/json

application/json

application/json

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"}
PATCH
/v2/users/me/api-keys/:apiKeyId

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.

Response Body

application/json

application/json

application/json

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"  ]}
DELETE
/v2/users/me/api-keys/:apiKeyId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

apiKeyId*string
Formatcuid2

Response Body

application/json

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"  ]}
POST
/v2/users/me/api-keys/:apiKeyId/rotate

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

apiKeyId*string
Formatcuid2

Response Body

application/json

application/json

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"}
GET
/v2/workflows

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

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"  }]
GET
/v2/workflows/:workflowId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

workflowId*string
Formatcuid2

Response Body

application/json

application/json

application/json

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"}
PUT
/v2/workflows/:workflowId

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.

Response Body

application/json

application/json

application/json

application/json

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"}
DELETE
/v2/workflows/:workflowId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

workflowId*string
Formatcuid2

Response Body

application/json

application/json

application/json

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"}
GET
/v2/workflows/:workflowId/comments

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

workflowId*string
Formatcuid2

Response Body

application/json

application/json

application/json

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"  }]
POST
/v2/workflows/:workflowId/comments

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.

Response Body

application/json

application/json

application/json

application/json

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"}
GET
/v2/workflows/:workflowId/files

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

workflowId*string
Formatcuid2

Response Body

application/json

application/json

application/json

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"  }]
GET
/v2/pipelines/catalog

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  }]
GET
/v2/pipelines/catalog/:slug

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

slug*string

Response Body

application/json

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}
GET
/v2/pipelines/:pipelineId/workflows

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

pipelineId*string
Formatuuid

Response Body

application/json

application/json

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"    }  ]}
POST
/v2/shared-results

Authorization

openIdConnect
OpenID Connect<token>

Request Body

application/json

Create shared result payload

TypeScript Definitions

Use the request body type in TypeScript.

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"}
GET
/v2/shared-results/:id

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

application/json

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"      }    ]  }}
GET
/v2/survey-templates

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

projectId?string
Length24 <= length <= 24
scope?string

Value in

  • "project"
  • "organization"
  • "public"

Response Body

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"    }  }]
GET
/v2/survey-templates/:templateId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

templateId*string
Formatcuid2

Response Body

application/json

application/json

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"  }}
PUT
/v2/survey-templates/:templateId

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.

Response Body

application/json

application/json

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"  }}
DELETE
/v2/survey-templates/:templateId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

templateId*string
Formatcuid2

Response Body

application/json

application/json

application/json

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"  }}
GET
/v2/survey-templates/:templateId/versions

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

templateId*string
Formatcuid2

Response Body

application/json

application/json

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"  }]
DELETE
/v2/survey-templates/:templateId/versions/:versionId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Response Body

application/json

application/json

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"}
GET
/v2/input-data

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"  }]
GET
/v2/input-data/:dataSetId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

dataSetId*string
Formatcuid2

Response Body

application/json

application/json

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"        }      ]    }  ]}
PUT
/v2/input-data/:dataSetId

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.

Response Body

application/json

application/json

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"        }      ]    }  ]}
DELETE
/v2/input-data/:dataSetId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

dataSetId*string
Formatcuid2

Response Body

application/json

application/json

application/json

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"}
GET
/v2/input-data/:dataSetId/variants

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

dataSetId*string
Formatcuid2

Response Body

application/json

application/json

application/json

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"          }        }      ]    }  ]}
POST
/v2/input-data/:dataSetId/lists

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.

Response Body

application/json

application/json

application/json

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"}
DELETE
/v2/input-data/:dataSetId/lists/:listId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Response Body

application/json

application/json

curl -X DELETE "https://example.com/v2/input-data/:dataSetId/lists/:listId"
{  "id": "string",  "name": "string",  "values": "string"}
POST
/v2/input-data/:dataSetId/groups

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

dataSetId*string
Formatcuid2

Request Body

application/json

New group definition

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

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"    }  ]}
PUT
/v2/input-data/:dataSetId/groups/:groupId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Request Body

application/json

Updated group definition

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

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"    }  ]}
DELETE
/v2/input-data/:dataSetId/groups/:groupId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Response Body

application/json

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"    }  ]}
GET
/v2/verification-contexts

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  }]
GET
/v2/verification-contexts/:contextId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

contextId*string
Formatcuid2

Response Body

application/json

application/json

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}
PUT
/v2/verification-contexts/:contextId

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.

Response Body

application/json

application/json

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}
DELETE
/v2/verification-contexts/:contextId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

contextId*string
Formatcuid2

Response Body

application/json

application/json

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}
GET
/v2/verification-runs

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

status?string

Value in

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

Response Body

application/json

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"  }]
GET
/v2/compliance/checks

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

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}
POST
/v2/compliance/checks

Authorization

openIdConnect
OpenID Connect<token>

Request Body

application/json

New compliance check

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

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"}
POST
/v2/compliance/checks/run

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

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}
PATCH
/v2/compliance/checks/:checkId

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.

Response Body

application/json

application/json

application/json

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"}
DELETE
/v2/compliance/checks/:checkId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

checkId*string
Length24 <= length <= 24

Response Body

application/json

application/json

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

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

limit?integer
Range1 <= value <= 200
Default50

Response Body

application/json

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"  }]
POST
/v2/compliance/audit-events

Authorization

openIdConnect
OpenID Connect<token>

Request Body

application/json

New audit event

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

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"}
GET
/v2/compliance/exports

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

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"  }]
POST
/v2/compliance/exports

Authorization

openIdConnect
OpenID Connect<token>

Request Body

application/json

New compliance export

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

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"}
PATCH
/v2/compliance/exports/:exportId

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.

Response Body

application/json

application/json

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"}
DELETE
/v2/compliance/exports/:exportId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

exportId*string
Length24 <= length <= 24

Response Body

application/json

application/json

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

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"    ]  }]
GET
/v2/datasets

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  }]
POST
/v2/datasets

Authorization

openIdConnect
OpenID Connect<token>

Request Body

application/json

New dataset

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

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"}
GET
/v2/datasets/:datasetId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Response Body

application/json

application/json

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"    }  ]}
PATCH
/v2/datasets/:datasetId

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.

Response Body

application/json

application/json

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"}
DELETE
/v2/datasets/:datasetId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Response Body

application/json

application/json

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"}
POST
/v2/datasets/:datasetId/files

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

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"  }]
DELETE
/v2/datasets/:datasetId/files/:fileId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Response Body

application/json

application/json

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"}
GET
/v2/datasets/:datasetId/versions

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Response Body

application/json

application/json

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"  }]
GET
/v2/datasets/:datasetId/versions/:versionId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Query Parameters

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

Response Body

application/json

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"    }  ]}
PATCH
/v2/datasets/:datasetId/versions/:versionId/files/:fileId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Request Body

application/json

Whether this file should be excluded from the version

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

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"}
POST
/v2/datasets/:datasetId/versions/:versionId/clean

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Request Body

application/json

Cleaning pipeline configuration

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

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"}
POST
/v2/datasets/:datasetId/versions/:versionId/enrich

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Response Body

application/json

application/json

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"}
GET
/v2/datasets/:datasetId/versions/:versionId/export

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Response Body

application/json

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"    }  ]}
GET
/v2/lt-pipelines/catalog

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

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"      }    ]  }]
POST
/v2/lt-pipelines/project/:projectId/run

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.

Response Body

application/json

application/json

application/json

application/json

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"  ]}
GET
/v2/lt-pipelines/project/:projectId/runs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string

Query Parameters

status?string

Value in

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

Response Body

application/json

application/json

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"  }]
POST
/v2/lt-pipelines/dataset/:datasetId/versions/:versionId/run

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.

Response Body

application/json

application/json

application/json

application/json

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"  ]}
GET
/v2/lt-pipelines/dataset/:datasetId/versions/:versionId/runs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
versionId*string

Query Parameters

status?string

Value in

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

Response Body

application/json

application/json

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"  }]
GET
/v2/lt-pipelines/runs/:runId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

runId*string

Response Body

application/json

application/json

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"}
GET
/v2/data-platform/pipelines/catalog

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

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"      }    ]  }]
POST
/v2/data-platform/pipelines/:slug/run

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.

Response Body

application/json

application/json

application/json

application/json

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"}
GET
/v2/data-platform/pipelines/runs

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

projectId?string
datasetVersionId?string
status?string

Value in

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

Response Body

application/json

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"      }    ]  }]
GET
/v2/data-platform/pipelines/runs/:runId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

runId*string

Response Body

application/json

application/json

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"    }  ]}
GET
/v2/data-platform/datasets/catalog/cleaning-pipelines

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"    ]  }]
GET
/v2/data-platform/datasets

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  }]
POST
/v2/data-platform/datasets

Authorization

openIdConnect
OpenID Connect<token>

Request Body

application/json

New dataset

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

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"}
GET
/v2/data-platform/datasets/:datasetId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Response Body

application/json

application/json

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"    }  ]}
PATCH
/v2/data-platform/datasets/:datasetId

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.

Response Body

application/json

application/json

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"}
DELETE
/v2/data-platform/datasets/:datasetId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Response Body

application/json

application/json

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"}
POST
/v2/data-platform/datasets/:datasetId/files

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

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"  }]
DELETE
/v2/data-platform/datasets/:datasetId/files/:fileId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Response Body

application/json

application/json

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"}
GET
/v2/data-platform/datasets/:datasetId/versions

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

datasetId*string
Formatcuid2

Response Body

application/json

application/json

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"  }]
GET
/v2/data-platform/datasets/:datasetId/versions/:versionId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Query Parameters

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

Response Body

application/json

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"    }  ]}
PATCH
/v2/data-platform/datasets/:datasetId/versions/:versionId/files/:fileId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Request Body

application/json

Whether this file should be excluded from the version

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

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"}
POST
/v2/data-platform/datasets/:datasetId/versions/:versionId/clean

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Request Body

application/json

Cleaning pipeline configuration

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

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"}
POST
/v2/data-platform/datasets/:datasetId/versions/:versionId/enrich

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Response Body

application/json

application/json

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"}
GET
/v2/data-platform/datasets/:datasetId/versions/:versionId/export

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

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

Response Body

application/json

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"    }  ]}
GET
/v2/ai-platform/base-models

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

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"  }]
GET
/v2/ai-platform/finetune-datasets

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

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"  }]
POST
/v2/ai-platform/finetune-datasets

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.

Response Body

application/json

application/json

application/json

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"}
GET
/v2/ai-platform/finetune-dataset-sources/dataset-versions

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

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  }]
GET
/v2/ai-platform/finetune-dataset-sources/crowd-jobs

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

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  }]
POST
/v2/ai-platform/finetune-dataset-sources/instruction-response-template

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.

Response Body

application/json

application/json

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"  }}
GET
/v2/ai-platform/finetune-runs

Authorization

openIdConnect
OpenID Connect<token>

Query Parameters

status?string

Value in

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

Response Body

application/json

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"    }  }]
POST
/v2/ai-platform/finetune-runs

Authorization

openIdConnect
OpenID Connect<token>

Request Body

application/json

Start a finetuning run

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

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"  }}
GET
/v2/ai-platform/finetune-runs/:runId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

runId*string

Response Body

application/json

application/json

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"  }}
GET
/v2/ai-platform/models

Authorization

openIdConnect
OpenID Connect<token>

Response Body

application/json

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"  }]
POST
/v2/feedback-reports/submit

Authorization

openIdConnect
OpenID Connect<token>

Request Body

application/json

New feedback report

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

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"}
GET
/v2/feedback-reports/mine

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"    }  ]}
GET
/v2/projects/:projectId/crowd-jobs

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Length24 <= length <= 24

Query Parameters

status?string

Value in

  • "assignable"
  • "not_assignable"
  • "no_tasks"
  • "finished"
  • "archived"
  • "paused"
includeArchived?|
Defaultfalse

Response Body

application/json

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"  }]
POST
/v2/projects/:projectId/crowd-jobs

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.

Response Body

application/json

application/json

application/json

application/json

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"}
GET
/v2/projects/:projectId/crowd-jobs/preview-cost

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

projectId*string
Length24 <= length <= 24

Query Parameters

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

Response Body

application/json

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}
GET
/v2/crowd-jobs/:jobId

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Response Body

application/json

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  }}
PUT
/v2/crowd-jobs/:jobId

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.

Response Body

application/json

application/json

application/json

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"}
DELETE
/v2/crowd-jobs/:jobId

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.

Response Body

application/json

application/json

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"}
PATCH
/v2/crowd-jobs/:jobId/pause

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Response Body

application/json

application/json

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"}
PATCH
/v2/crowd-jobs/:jobId/resume

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Response Body

application/json

application/json

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"}
GET
/v2/crowd-jobs/:jobId/stats

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Response Body

application/json

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"      }    ]  }}
GET
/v2/crowd-jobs/:jobId/answers

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Query Parameters

status?string

Value in

  • "pending"
  • "accepted"
  • "rejected"
limit?number
Range1 <= value <= 200
Default50
offset?|
Range0 <= value
Default0
search?string
sortBy?string

Value in

  • "workerId"
  • "status"
  • "submittedAt"
  • "duration"
sortDir?string

Value in

  • "asc"
  • "desc"

Response Body

application/json

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"      }    }  ]}
GET
/v2/crowd-jobs/:jobId/feedback

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Query Parameters

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

Response Body

application/json

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"    }  ]}
GET
/v2/crowd-jobs/:jobId/chart-data

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Response Body

application/json

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    }  ]}
GET
/v2/crowd-jobs/:jobId/answers/export

Authorization

openIdConnect
OpenID Connect<token>

Path Parameters

jobId*string
Length24 <= length <= 24

Query Parameters

format?string
Default"json"

Value in

  • "json"
  • "csv"
status?string
Default"all"

Value in

  • "pending"
  • "accepted"
  • "rejected"
  • "all"
pretty?|
Defaulttrue

Response Body

application/json

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