DocumentationRecipesReferenceGraphQLChangelog
Log In

Kili Technology is designed by data scientists for data scientists. The entire application can be used programmatically via the API.

Table of Contents

Query

FieldArgumentTypeDescription
_Boolean
apiKeys[ApiKey!]

Retrieves page by page all api keys who verify where input parameters.

whereApiKeyWhere!
firstPageSize!
skipInt!
countApiKeysInt!

Count all api keys who verify where input parameters.

whereApiKeyWhere!
assets[Asset!]

Retrieves page by page all assets who verify where input parameters.

whereAssetWhere!
firstPageSize!
skipInt!
countAssetsInt!

Count all assets who verify where input parameters.

whereAssetWhere!
getAssetsMetadataValues[String!]

Get all values associated to a given metadata key

projectIDID!
metadataKeyString!
getNextAssetFromLabelAsset

Return the next asset

labelAssetIDs[ID!]
getNextAssetForReviewFromLabelAsset

Return the next asset

labelAssetIDs[ID!]
getNextAssetFromProjectAsset

Return the next asset available to label.

projectIDID!
getNextAssetForReviewFromProjectAsset

Return the next asset available to label.

projectIDID!
getUploadAssetsTokenString!

Get the encrypted token needed to upload data to the router

projectIDID!
comments[Comment!]

Retrieves page by page all comments who verify where input parameters.

whereCommentWhere!
firstPageSize!
skipInt!
countCommentsInt!

Count all comments who verify where input parameters.

whereCommentWhere!
dataIntegrations[DataIntegration!]

Retrieves page by page all dataIntegrations who verify where input parameters.

whereDataIntegrationWhere!
firstPageSize!
skipInt!
countDataIntegrationsInt!

Count all dataIntegrations who verify where input parameters.

whereDataIntegrationWhere!
getAvailablePathDataIntegration[JSON]!

Get available paths of the current data Integration

whereAvailablePathWhere!
dataProjectConnections[DataProjectConnection!]

Get data connections related with specific project

whereDataProjectConnectionsWhere!
firstPageSize!
skipInt!
graphData[Graph!]

Retrieves specific metrics on a specific period of time.

whereGraphWhere!
graphDataByLabeler[GraphByLabeler!]
whereGraphWhere!
graphDataConsensusRepartition[Graph!]
whereGraphWhere!
graphs[Graph!]
whereGraphWhere!
graphAggregatedNumberOfAssetsLabeledByLabeler[GraphAggregatedNumberOfAssetsLabeledByLabeler!]
whereGraphWhere!
communicationSubscriptions[CommunicationSubscription!]

Retrieves subscriptions for a specific user

whereCommunicationSubscriptionWhere!
issues[Issue!]

Retrieves page by page all issues who verify where input parameters.

whereIssueWhere!
firstPageSize!
skipInt!
countIssuesInt!

Count all issues who verify where input parameters.

whereIssueWhere!
labels[Label!]

Retrieves page by page all labels who verify where input parameters.

whereLabelWhere!
firstPageSize!
skipInt!
countLabelsInt!

Count all labels who verify where input parameters.

whereLabelWhere!
getLabelsOrPredictionsForUser[Label!]
assetIDID!
userIDID!
labelIDID
getLabelsToBeReviewed[Label!]
assetIDID!
labelIDID
locks[Lock!]

Retrieves page by page all locks who verify where input parameters.

whereLockWhere!
firstPageSize!
skipInt!
countLocksInt!

Count all labels who verify where input parameters.

whereLockWhere!
notifications[Notification!]

Retrieves page by page all notifications that verify input parameters.

whereNotificationWhere!
firstPageSize!
skipInt!
countNotificationsInt!

Count notifications that verify input parameters.

whereNotificationWhere!
organizations[Organization!]

Retrieves page by page all organizations who verify where input parameters.

whereOrganizationWhere!
firstPageSize!
skipInt!
countOrganizationsInt!

Count all organizations who verify where input parameters.

whereOrganizationWhere!
organizationMetricsOrganizationMetrics!

Count number of labeled assets, annotations and hours on a specific period of time

whereOrganizationMetricsWhere!
listEmailsInOrganization[String!]

List emails of users in an organization in alphabetical order.

whereOrganizationWhere!
exportDataString!

Export data from project.

whereProjectWhere!
exportTypeExportType
labelFormatLabelFormat
splitOptionSplitOption
versionNameString
projects[Project!]

Retrieves page by page all projects ordered by createdAt for the current user (starred projects come first then unstarred projects)

whereProjectWhere!
firstPageSize!
skipInt!
latestUpdatedProjects[Project!]

Retrieves page by page all projects ordered by updatedAt for the current user

whereProjectWhere!
firstPageSize!
skipInt!
countProjectsInt!

Count all projects for a specific userID,

whereProjectWhere!
projectUsers[ProjectUser!]

Retrieves page by page all projectUsers who verify where input parameters.

whereProjectUserWhere!
firstPageSize!
skipInt!
countProjectUsersInt!

Count all project users who verify where input parameters.

whereProjectUserWhere!
projectVersions[ProjectVersion!]

Retrieves project versions depending on the where object

whereProjectVersionWhere!
firstPageSize!
skipInt!
countProjectVersionsInt!

Count all projects versions depending on the where object

whereProjectVersionWhere!
userUser
idID!
meUser
users[User!]

Retrieves page by page all users who verify where input parameters.

whereUserWhere!
firstPageSize!
skipInt!
countUsersInt!

Count all users who verify where input parameters.

whereUserWhere!
adminOfUserString!

Technical query, used to request the email of an admin of a user

Mutation

FieldArgumentTypeDescription
_Boolean
appendToApiKeysApiKey

Add an api key to a user

dataAppendToApiKeysData!
whereUserWhere!
updatePropertiesInApiKeyApiKey
dataUpdateApiKeyPropertiesData!
whereApiKeyWhere!
addAllLabeledAssetsToReviewProject

Add all labeled assets specified, or if None, all in the project to the review queue

whereAssetWhere!
assignAssetsToLabelersProject

Assign assets to be labeled by given users

userWhereUserWhere!
whereAssetWhere!
appendManyToDatasetProject

Add one or more assets to the project specified.

You may specify for each asset its externalID, if it should be considered as honeypot, its status and some metadata.

dataAppendManyToDatasetData!
whereProjectWhere!
appendManyToDatasetFrontendUploadAssetsWarnings

Add one or more assets to the project specified.

You may specify for each asset its externalID, if it should be considered as honeypot, its status and some metadata.

dataAppendManyToDatasetData!
whereProjectWhere!
appendManyFramesToDatasetAsynchronouslyProject

Add one or more assets asynchronously to the project specified.

You may specify for each asset its externalID, if it should be considered as honeypot, its status and some metadata.

dataAppendManyFramesToDatasetAsynchronouslyData!
whereProjectWhere!
deleteManyFromDatasetProject

Delete one or more assets to the project specified, provided their IDs or the project ID

whereAssetWhere!
updatePropertiesInAssetAsset

Update the properties of one asset.

You may specify its externalID, its content (link to the asset), if it should be considered as a honeypot, its status and some metadata, among other things.

whereAssetWhere!
dataAssetData!
updatePropertiesInAssets[Asset]

Update the properties of one or more assets.

where[AssetWhere!]!
data[AssetData!]!
fetchAndUpdateOCRJsonMetadataAsset

Fetch OCR metadata using Vision API and put it in the asset metadata.

dataFetchAndUpdateOCRJsonMetadataData!
whereAssetWhere!
fetchAndUpdateOCRJsonMetadataForAssetsInProject[Asset]

Fetch OCR metadata using Vision API and put it in the asset metadata for all assets in a project.

dataFetchAndUpdateOCRJsonMetadataData!
whereAssetWhere!
sendBackAssetsToQueueProject

Add all reviewed assets specified, or if None, all in the project to the to do queue

whereAssetWhere!
prioritizeAssetsProject

Prioritize assets to specified priority

whereAssetWhere!
priorityInt!
signUpUser

The request to sign up a new email to the Kili app.

If authorized, the email will receive informations to sign in.

dataSignUpData!
resetPasswordUser

The request to reset a forgotten password

whereUserWhere!
appendToCommentsComment

Add a new comment

dataAppendToCommentsData!
whereIssueWhere!
updatePropertiesInCommentComment

Update an existing comment

dataCommentData!
whereCommentWhere!
dataIntegrationTestDataIntegrationTestData

Test a DataIntegration and return the dataIntegration

dataIntegrationIdID!
updatePropertiesInDataIntegrationDataIntegration

Update the dataIntegration's data

dataDataIntegrationData!
whereDataIntegrationWhere!
createDataIntegrationDataIntegration

Create a DataIntegration and return the dataIntegration

dataDataIntegrationData!
deleteDataIntegrationDataIntegration

Permanently delete a DataIntegration

whereDataIntegrationWhere!
addDataConnectionDataProjectConnection!

Add project data connection

dataDataProjectConnectionInput!
updateCommunicationSubscriptionBoolean

Update a communication (subscribe or unsubscribe) for a specific user to a mailing list

whereUpdateCommunicationSubscriptionWhere!
appendToIssuesIssue

Add a new issue

dataAppendToIssuesData!
whereAssetWhere!
updatePropertiesInIssueIssue

Update an existing issue

dataIssueData!
whereIssueWhere!
appendToLabelsLabel

Add a new annotation

dataAppendToLabelsData!
whereAssetWhere!
frontendAppendToLabelsLabel

Add a new annotation from the app

dataAppendToLabelsData!
whereAssetWhere!
updatePropertiesInLabelLabel

Change the annotations in a label.

dataLabelData!
whereLabelWhere!
createHoneypotLabel

Honeypot is a quality parameter to measure the agreement between aasset pre-annotated (a golden standard) and the annotation made by an annotator. Quality is measured against a predefined truth.

Create a honeypot for an asset, specifying all anotations for this asset.

dataCreateHoneypotData!
whereAssetWhere!
createPredictionsProject

Upload labels, considered as predictions by a model, aiming at speeding annotation by helping the labeler.

dataCreatePredictionsData!
whereAssetWhere!
renewLockLock

Renew a lock on an asset that has enough labeler or reviewer working on it when the initial lock timed out and the asset remains unsubmitted.

dataRenewLockData!
whereAssetWhere!
createNotificationNotification

Create a new notification.

dataNotificationData!
updatePropertiesInNotificationNotification

Update properties of the notification.

dataNotificationData!
whereNotificationWhere!
createOrganizationOrganization

Create a new organization

dataCreateOrganizationData!
updatePropertiesInOrganizationOrganization

Update properties of the organization

dataOrganizationData!
whereOrganizationWhere!
anonymizeOrganizationOrganization

Permanently delete an organization and all its relative data

whereOrganizationWhere!
changeProjectAuthorProject

Change the author of a project

whereProjectWhere!
createProjectProject

Create a new project

dataCreateProjectData!
deleteProjectProject

Permanently delete a project

whereProjectWhere!
deleteProjectAsynchronouslyString!

Permanently delete a project's assets using Airflow

whereProjectWhere!
hardDeleteProjectProject

Permanently hard delete a project

whereProjectWhere!
makeProjectPublicProject

Make a project public. Warning: This action is permanent and irreversible.

whereProjectWhere!
updatePropertiesInProjectProject

Update the project's name and tasks.

dataProjectData!
whereProjectWhere!
appendToRolesProject

Add a new user in the specified project.

dataAppendToRolesData!
whereProjectWhere!
frontendAppendToRolesProject

Add a new projectUser in the specified project and send an invite.

dataAppendToRolesData!
whereProjectWhere!
updatePropertiesInRoleProjectUser

Change the role of a projectUser

dataRoleData!
whereProjectUserWhere!
updatePropertiesInProjectUserProjectUser

Change properties of a projectUser

dataProjectUserData!
whereProjectUserWhere!
deleteFromRolesProject

Delete a projectUser from the project.

whereProjectUserWhere!
acceptOrDeclineInvitationProjectUser

Accept/decline an invitation to joining a new project.

dataAcceptOrDeclineInvitationData!
whereProjectWhere!
updatePropertiesInProjectVersionProjectVersion
dataProjectVersionData!
whereProjectVersionWhere!
deleteUserBoolean!
whereUserWhere!
createUserUser

Create a user if he does not exist or add him back to the organization if he already existed
Also allows you to update his organizationRole

dataCreateUserData!
createUserFromEmailIfNotExistsUser

Create a new user for a specific project inside the organization

dataCreateUserFromEmailIfNotExists!
whereProjectWhere!
updatePropertiesInUserUser

An admin of an organization can modify every user's information.

dataUserData!
whereUserWhere!
updatePasswordUser

Update password of a user.

dataUpdatePasswordData!
whereUserWhere!
resetAndReturnPasswordString

Reset password of a user.

whereUserWhere!

Objects

ApiKey

Api keys are used to connect to the API (Kili's Python SDK).

FieldArgumentTypeDescription
_Boolean
idID!

ID of the api key.

nameString!

Name of the api key.

keyString!

Api key

createdAtDateTime!

Date at which the api key was created

revokedBoolean!

If true, the api key cannot be used

userUser

User who owns the api key

userIdID!

ID of the user who owns the api key

ApiUsage

API usage keeps track of all API calls by user.

FieldArgumentTypeDescription
_Boolean
idID!
userString

API key of user.

createdAtDateTime!

Date of last API call made by user with API key "apiKey".

AppendManyToDatasetWarnings

FieldArgumentTypeDescription
duplicatedIds[String]
linesWithNoId[Int]

Asset

Asset are the data lines. They can either be images, text, videos, or pdf.

FieldArgumentTypeDescription
_Boolean
idID!
consensusMarkFloat

Consensus is a quality parameter to measure the agreement between several annotations of the same asset. In the case of Asset used for consensus, it is the agreement score between the annotators.

The global mark depends on the asset type, it can either be a mean estimator or the average of the Fleiss Kappas.

consensusMarkComputeJSON

Technical field.

consensusMarkPerCategoryJSON

Consensus is a quality parameter to measure the agreement between several annotations of the same asset. In the case of Asset used for consensus, it is the agreement score between the annotators.

The global mark depends on the asset type, it can either be a mean estimator or the average of the Fleiss Kappas.

contentString!

Content of the Asset or URL to the Asset.

contentJsonJSON

Used the same way as content, for upcoming video classification. Duplicate of jsonContent formatted as as JSON instead of a string.

contentJsonComputeJSON

Technical field.

createdAtDateTime!
durationInt

Sum of durations along all labels of the asset (in seconds)

durationComputeInt

Technical field.

externalIdString

Name of the Asset, visible on the top of the screen on the labelling page, and defined when uploading the image.

honeypotMarkFloat

Honeypot is a quality parameter to measure the agreement between a pre-annotated asset(a golden standard) and the annotation made by an annotator. Quality is measured against a predefined truth.

If this Asset is a Honeypot, average of the honeypots obtained by the annotators on this Asset.

honeypotMarkComputeFloat

Technical field.

inferenceMarkFloat

Inference mark at asset level is the inference mark on the very last label by creation date.

inferenceMarkComputeFloat

Technical field.

isHoneypotBoolean

Honeypot is a quality parameter to measure the agreement between a pre-annotated asset (a golden standard) and the annotation made by an annotator. Quality is measured against a predefined truth.

Indicates whether this asset is a Honeypot.

isToBeLabeledByBoolean

Indicates whether one or more user were attributed the asset to label

isUsedForConsensusBoolean

Consensus is a quality parameter to measure the agreement between several annotations of the same asset. In the case of Asset used for consensus, it is the agreement score between the annotators.

In the case of the use of consensus as a quality indicator for the project, this field indicates that the asset is retained to be annotated by different annotators.

isToReviewBoolean

Review is a quality assessment procedure in which the reviewer validate or not the label created on asset. He can create issues on the labels or on several annotations, or send back to annotation.

This field indicates if the asset will be part of this validation procedure. The percentage of asset up for review is set at the project level (see reviewCoverage).

jsonContentString

Used the same way as content, for upcoming video classification

jsonMetadataString

Asset metadata, i.e. additionnal information shown during the labeling process

issues[Issue!]!

The issues created for this asset.

latestLabelLabel

Latest label I can trust for my model.

latestLabelComputeLabel

Technical field

locks[Lock!]

Locks ensure that the asset is associated to only one user, when there is no consensus activated, or exactly the number of labeler/reviewer chosen

metadataJSON

Asset metadata, i.e. additionnal information shown during the labeling process. Duplicate of jsonMetadata formatted as as JSON instead of a string.

metadataComputeJSON

Technical field.

numberOfValidLocksInt!

Number of currently valid locks on this asset.

numberOfValidLocksForReviewInt!

Number of currently valid review locks on this asset.

numberOfValidLocksComputeInt

Technical field.

ocrMetadataString

Ocr metadata, i.e. hidden layer of text informations used for OCR tasks

priorityInt!

Assets can be ordered in the labeling process, the minimum value being 0

projectProject

Assets are always related to one project.

projectIdString!
projectIdComputeString

Technical field.

readPermissionsFromLabelsString!

Technical field.

readPermissionsFromProjectString!

Technical field.

labelVersionInt!

Lastest version of the label.

sentBackTo[ProjectUser!]

Technical field

skippedBoolean!

A boolean indicating whether the asset was skipped or not

skippedComputeBoolean

Technical field.

statusStatus!

Current annotation status of the asset. Can take the values: TODO, ONGOING, LABELED, REVIEWED, TO_REVIEW, AUTOSAVE.

statusComputeStatus

Technical field.

thumbnailString

Thumbnail of the asset to display in the frontend

NB : only available for on-premise and SaaS users

thumbnailComputeString

Technical field

toBeLabeledBy[ProjectUser!]

One or more user that were attributed the asset to label

updatedAtDateTime!
labels[Label!]!

The labels created for this asset.

AssetDeletedOutput

FieldArgumentTypeDescription
assetIdString!
successBoolean!

AuthPayload

The authentification object to create a token for a user.

FieldArgumentTypeDescription
_Boolean
idID!
tokenString!
userUser!

Comment

Comment contains comments associated to an issue.

FieldArgumentTypeDescription
idID!
authorProjectUser!

ProjectUser that created this comment.

authorIdID!
createdAtDateTime!
issueIssue!

ID of the issued this comment is attached to.

issueIdID!
textString!

Content of the comment.

updatedAtDateTime!

CommunicationSubscription

Communication subscription preference of a specific user in Hubspot.

FieldArgumentTypeDescription
_Boolean
idID!
nameString!

Name of the subscription

descriptionString!

Description of the subscription

subscribedBoolean!

Status of the subscription

DataIntegration

DataIntegration belong to an organization. They link the project data and an external bucket

FieldArgumentTypeDescription
_Boolean
idID!
accessBoolean!

The integration can be acceded

allowedPaths[String]!

The list of allowed paths for the dataIntegration if empty all paths are allowed

createdAtDateTime!
inProjectBoolean!

The integration is in a project

lastCheckDateTime!

Last time the integration's data was checked

nameString!

The name of the integration

platformDataIntegrationPlatform!

Third party plateform used by the integration to share data

statusDataIntegrationStatus!

Status of the integration.

typeDataIntegrationType!

Type of the storage of the integration

updatedAtDateTime!

DataIntegrationTestData

FieldArgumentTypeDescription
connectedBoolean
errorString

DataProjectConnection

DataProjectConnection is related with specific project.

FieldArgumentTypeDescription
_Boolean
idID!

Unique id

isCheckingBoolean!

Checking status

lastCheckedDateTime!

Last time the project data connection was checked

nbAssetInt!

Number of assets in connection

selectedFolders[String]

List of selected folders in scope of connection

Graph

Technical field.

FieldArgumentTypeDescription
_Boolean
idID!
xString!

Technical field.

yFloat!

Technical field.

jobString

Technical field.

GraphAggregatedNumberOfAssetsLabeledByLabeler

Technical field.

FieldArgumentTypeDescription
_Boolean
idID!
labelerNameString!

Technical field.

dataGraph!

Technical field.

GraphByLabeler

Technical field.

FieldArgumentTypeDescription
_Boolean
idID!
labelerNameString!

Technical field.

data[Graph!]!

Technical field.

Issue

Issue contains issues associated to a User and an Asset.

FieldArgumentTypeDescription
idID!
assetAsset

ID of the asset related to the issue.

assetIdID!
assigneeProjectUser

ID of the projectUser assigned to the issue.

assigneeIdID
authorProjectUser

ID of the projectUser author of the issue.

authorIdID!
comments[Comment!]

All the comments related to this issue

createdAtDateTime!
hasBeenSeenBoolean!

Whether the last activity on the issue has been seen by the author of the issue.

issueNumberInt!

Numeric ID of the issue

objectMidString

Object MID of the issue

projectProject

ID of the project of the issue.

projectIdID!
statusIssueStatus!

Current annotation status of the issue. Can take the values: OPENED, SOLVED.

typeIssueType!
updatedAtDateTime!

Label

A label include all information resulting of the action of annotation by a specific user.

FieldArgumentTypeDescription
_Boolean
idID!
assetIdString!
assetIdComputeString

Technical field.

authorUser!

User that created this label.

authorIdString!
authorIdComputeString

Technical field.

createdAtDateTime!
honeypotMarkFloat

Honeypot is a quality parameter to measure the agreement between a pre-annotated asset (a golden standard) and the annotation made by an annotator. Quality is measured against a predefined truth.

In the case of Honeypot Asset, chord note expressed in percentage between the label and the target. In the case of an Asset that is not of Honeypot type, the field is null.

honeypotMarkComputeFloat

Technical field.

inferenceMarkFloat

Inference mark is a quality parameter to measure the agreement between an inference run (from a model) and the annotation made by an annotator.

inferenceMarkComputeFloat

Technical field.

isLatestLabelForUserBoolean!

Boolean flagging whether the label is the latest submitted label for this asset for the user

isLatestLabelForUserComputeBoolean

Technical field.

isLatestDefaultLabelForUserBoolean!

Boolean flagging whether the label is the latest submitted DEFAULT label for this asset for the user.

isLatestDefaultLabelForUserComputeBoolean

Technical field.

isLatestReviewLabelForUserBoolean!

Boolean flagging whether the label is the latest submitted REVIEW label for this asset for the user.

isLatestReviewLabelForUserComputeBoolean

Technical field.

isSentBackToQueueBoolean

Technical field.

jsonResponseString!

The list of all annotations of this label, for each task of this project, in a JSON character string. Kili annotations closely follow the Google format.

labelOfAsset

Asset related to this label.

labelTypeLabelType!

Type of label used to identify if the label is a prediction (made by a model), an ordinary label (made by an annotator) or a journal (carried out by a reviewer).

Can take the following values:
DEFAULT
INFERENCE
PREDICTION
REVIEW

modelNameString

In case the label was uploaded (and is of type PREDICTION), name (chosen during the upload) of the model used to create the label.

numberOfAnnotationsInt

Total number of annotation elements on the asset.

numberOfAnnotationsComputeInt

Technical field.

projectIdString!
projectIdComputeString

Technical field.

readPermissionsFromProjectString!

Technical field.

responseJSON!

The list of all annotations of this label, for each task of this project, in a JSON field. Kili annotations closely follow the Google format.

responseComputeJSON

Technical field.

secondsToLabelFloat

Amount of time (in seconds) spent by the labeller on the interface before submitting the label.

searchJSON!

Technical field.

searchComputeJSON

Technical field.

skippedBoolean!

A boolean indicating whether the asset was skipped or not

totalSecondsToLabelInt

Total cumulated amount of time (in seconds) spent by the user on all other labels of the same asset on the interface.

totalSecondsToLabelComputeInt

Technical field.

versionInt!

Version of the label.

License

FieldArgumentTypeDescription
_Boolean
apiBoolean
apiPriorityBoolean
enableSmartToolsBoolean
expiryDateString
inputType[InputType]
maxNumberOfLabeledAssetsInt
organizationIdString
publicProjectBoolean
seatsInt
startDateString
typeLicenseType
uploadCloudDataBoolean

Lock

Locks ensure that the asset is associated to only one user, when there is no consensus activated, or exactly the number of labeler/reviewer chosen

FieldArgumentTypeDescription
_Boolean
idID!
authorUser!

The user that created this lock

authorIdString
authorIdComputeString

Technical field

createdAtDateTime!
lockOfAsset!

The asset this lock is protecting.

lockOfIdString
lockOfIdComputeString

Technical field

lockTypeLockType!

Type of lock (DEFAULT for default label, REVIEW for review asset)

Notification

Web notifications can be pushed to users to notify them from actions in Kili.

FieldArgumentTypeDescription
_Boolean
idID!
createdAtDateTime!
hasBeenSeenBoolean!
messageString!
statusNotificationStatus!
urlString!
userIDString!

Organization

Organization are the basic unit in for Kili, and can gather different users, that can create projects.

FieldArgumentTypeDescription
_Boolean
idID!
addressString!
cityString!
countryString!
dataIntegrations[DataIntegration]
licenseLicense
nameString!
numberOfAnnotationsInt!
numberOfLabeledAssetsInt!
numberOfHoursFloat!
users[User]
zipCodeString!

OrganizationMetrics

Technical field

FieldArgumentTypeDescription
_Boolean
maxNumberOfLabeledAssetsInt!

Technical field

numberOfAnnotationsInt!

Technical field

numberOfHoursFloat!

Technical field

numberOfLabeledAssetsInt!

Technical field

Project

It is the combination of an asset type, a dataset to be annotated, an interface adapted to the annotation task, of one or more participants, specific quality parameters, and potentially a specific machine learning model.

FieldArgumentTypeDescription
_Boolean
idID!
assetMetadataJSON!

Technical field

AssetMetadata groups all different metadata keys present in the assets of the project

assetMetadataComputeJSON

Technical field

AssetMetadata groups all different metadata keys present in the assets of the project

authorUser
consensusMarkFloat

Consensus is quality parameter to measure the agreement between several annotations of the same asset, made by different annotators

The global mark for the project depends on the

consensusMarkPerCategoryJSON

Consensus mark per category, averaged over all assets labeled on the project

consensusTotCoverageInt

Consensus is quality parameter to measure the agreement between several annotations of the same asset, made by different annotators

Its coverage is the percentage (between 0 and 100) of the dataset that will be annotated several times.

createdAtDateTime!
dataConnections[DataProjectConnection]
dataset[Asset!]

The Dataset is all the assets related to this project

descriptionString
deletedAtDateTime!
honeypotMarkFloat

Honeypot is a quality parameter to measure the agreement between a pre-annotated asset (a golden standard) and the annotation made by an annotator. Quality is measured against a predefined truth.

At the project level, it is the mean accross all anotators and all assets selected for honeypot.

inputTypeInputType!

The type of asset for the project :

AUDIO
IMAGE
PDF
TEXT
URL
VIDEO
NA

instructionsString
interfaceJSON!

A JSON file containing all the informations regarding the graphical user interface configured at the beginning of a project, made available to users, to enable them to perform the annotation task. Duplicate of jsonInterface formatted as as JSON instead of a string.

interfaceComputeJSON

Technical field.

jsonInterfaceString

A JSON file containing all the informations regarding the graphical user interface configured at the beginning of a project, made available to users, to enable them to perform the annotation task.

metadataTypesJSON

Custom types for metadata

minConsensusSizeInt

Consensus is quality parameter to measure the agreement between several annotations of the same asset, made by different annotators

Its minimum size is the number of annotators that will have to annotate the same asset. It must be set to a number less than or equal to the total number of annotators.
For now, it is limited to at most 10 labelers, for performance reasons.

mlTasksString

Technical field, the unique types of tasks found in the project interface.

mlTasksComputeString

Technical field.

numberOfAssetsInt
numberOfAssetsWithSkippedLabelsInt

The number of assets one annotator at least skipped in the project.

numberOfOpenIssuesInt

The total number of open issues in the project.

numberOfOpenQuestionsInt

The total number of open questions in the project.

numberOfRemainingAssetsInt

The number of unlabeled assets in the project

numberOfSolvedIssuesInt

The total number of solved issues in the project.

numberOfSolvedQuestionsInt

The total number of solved questions in the project.

numberOfReviewedAssetsInt

The number of assets reviewed in the project

versions[ProjectVersion!]

List of project versions.

publicTokenString!

Token to identify when the project has been made public.

readPermissionsForAssetsAndLabelsString!

Technical field.

reviewCoverageInt

Review is a quality assessment procedure in which the reviewer validate or not the label created on asset. He can create issues on the labels or on several annotations, or send back to annotation.

Its coverage is the percentage (between 0 and 100) of the dataset that will be up for review once labeled

rights[Right!]!

The list of project rights.

rules ⚠️JSON

[Deprecated] Constraints to be applied to the annotation jobs for rule-based annotation.

⚠️ DEPRECATED

This field is not used anymore. Please upgrade kili by typing pip install kili --upgrade

shouldRelaunchKpiComputationBoolean

Technical field.

titleString
updatedAtDateTime!
useHoneyPotBoolean

Honeypot is a quality parameter to measure the agreement between a pre-annotated asset (a golden standard) and the annotation made by an annotator. Quality is measured against a predefined truth.

True or false depending on if Honeypot is activated for this project.

minAndMaxPriority[Int!]

Min and max priority of the assets of the project

roles[ProjectUser!]

One or more projectUsers inivited to the project.

myRoleProjectUser

ProjectMutex

ProjectMutex ensure that pods are synchronized when accessing to next asset to label

FieldArgumentTypeDescription
_Boolean
idID!
projectIdID!

The user that created this lock

createdAtUtcDateTime!

ProjectUser

ProjectUser is the instance of a user within a project.

A projectUser has a role (ADMIN, TEAM_MANAGER, REVIEWER, LABELER) which grants him specific rights within this project in terms of read/write operations.

FieldArgumentTypeDescription
_Boolean
idID!
activatedBoolean!

Activated projectUsers can access their project. Deactivated projectUsers cannot access their project.

consensusMarkFloat

Consensus mark of a projectUser is the average of all consensus marks on all assets labeled with type DEFAULT by the projectUser.

This is a calculated field, so querying it may slow down the query.

consensusMarkPerCategoryJSON

Consensus mark per category, averaged over all assets labeled with type DEFAULT by the projectUser

consensusMarkComputeFloat

Technical field.

honeypotMarkFloat

Honeypot mark of a projectUser is the average of all honeypot marks on all assets labeled with type DEFAULT by the projectUser.

This is a calculated field, so querying it may slow down the query.

honeypotMarkComputeFloat

Technical field.

invitationStatusInvitationStatus!

invitationStatus indicates whether the invitation to a project as been accepted or not.

isAuthorBoolean

isAuthor indicates whether a project user is author of its project or not.

lastLabelingAtString
lastLabelingAtComputeString

Technical field.

numberOfAnnotationsInt

Number of annotations of a projectUser is the total count of all number of annotations on all assets labeled with type DEFAULT by the projectUser.

This is a calculated field, so querying it may slow down the query.

numberOfAnnotationsComputeInt

Technical field.

numberOfLabeledAssetsInt

Number of labeled assets of a projectUser is the number of assets labeled with type DEFAULT by the projectUser.

numberOfLabeledAssetsComputeInt

Technical field.

numberOfLabelsInt

Number of labels of type "DEFAULT" and "REVIEW" made by the projectUser.

numberOfLabelsComputeInt

Technical field.

projectProject!

Project of projectUser

roleProjectRole!

Role of projectUser within the project. It can either be:

ADMIN
TEAM_MANAGER
REVIEWER
LABELER

starredBoolean!

Did user from projectUser star project in the list of projects on front page?

totalDurationInt

Total time (in seconds) spent labelling assets labeled with type DEFAULT or REVIEW by the projectUser.

This is a calculated field, so querying it may slow down the query.

totalDurationComputeInt

Technical field.

userUser!

User of projectUser

ProjectVersion

ProjectVersion is a snapshot of the list of labels of a project at a given time.

A projectVersion has a name and a download link to the snapshot.

FieldArgumentTypeDescription
_Boolean
idID!

ID of the project version.

nameString!

Name of the project version.

createdAtDateTime!

Date of which the project version was created.

contentString

Link to download the project version.

projectProject

Project from which the version was created.

projectIdString!

ProjectId from which the version was created.

Subscription

FieldArgumentTypeDescription
_Boolean
assetDeletedAssetDeletedOutput

Subscription allowing to receive updates on every action updating or creating a label.

projectIDID!
labelCreatedOrUpdatedLabel

Subscription allowing to receive updates on every action updating or creating a label.

projectIDID!
notificationCreatedOrUpdatedNotification

Subscription allowing to receive updates on every action updating or creating a notification.

userIDID!
projectUserCreatedProject

Subscription allowing to receive updates on every action updating or creating a projectUser.

emailString!
projectVersionCreatedOrUpdatedProjectVersion

Subscription allowing to receive updates on every action updating or creating a projectVersion.

projectIDID!

Token

FieldArgumentTypeDescription
tokenString!

UploadAssetsWarnings

FieldArgumentTypeDescription
numberOfUploadedAssetsInt
warnings[Warning]

User

Users belong to an organization. They can create projects within that organization.

FieldArgumentTypeDescription
_Boolean
idID!
acceptedTermsAndConditionsVersionString

The version of terms and conditions accepted by the user, null if no version accepted.

activatedBoolean!

Activated users can log in to Kili Technology. Deactivated users cannot log in to Kili Technology.

apiKeys[ApiKey!]
auth0IdString

User ID in Auth0 database

createdAtDateTime!
emailString!

Email works as a unique identifier for a user.

firstnameString

Firstname of the user

highestRoleInProjectString!

The highest role in a project of the user is the role with the most rights ('Admin' > 'Team Manager' > 'Reviewer' > 'Labeler' > 'NA' (not a member of any projects)) attained by the user as a project user.

highestRoleInProjectComputeString

Technical field.

hubspotSubscriptionStatusHubspotSubscriptionStatus

The user accepts to be contacted by Kili Technology.

lastnameString

Lastname of the user

organizationOrganization

Each user can belong to one organization.

organizationIdString!
organizationRoleOrganizationRole

Within an organization, a user can either be:

  • organization managers (ADMIN) can add/delete/update users within an organization

  • users (USER) have no role within the organization

passwordString!
projectUsers[ProjectUser!]!

The role of a User within a project are defined by a ProjectUser.

rights[Right!]!

The list of user rights.

updatedAtDateTime!

Warning

FieldArgumentTypeDescription
typeWarningTypes
externalIdString
lineNumberInt
detailsString

Inputs

AcceptOrDeclineInvitationData

FieldTypeDescription
isAcceptingBoolean!

ApiKeyWhere

FieldTypeDescription
idID
userUserWhere

AppendManyFramesToDatasetAsynchronouslyData

FieldTypeDescription
contentArray[String!]
externalIDArray[String!]
jsonMetadataArray[String!]
uploadTypeUploadType

AppendManyToDatasetData

FieldTypeDescription
contentArray[String!]
externalIDArray[String!]
isHoneypotArray[Boolean!]
statusArray[Status!]
jsonContentArray[String]
jsonMetadataArray[String!]

AppendToApiKeysData

FieldTypeDescription
nameString!
keyString!

AppendToCommentsData

FieldTypeDescription
inReviewBoolean!
textString!

AppendToIssuesData

FieldTypeDescription
issueNumberInt!
labelIDID
objectMidString
typeIssueType!

AppendToLabelsData

FieldTypeDescription
authorIDID!
jsonResponseString!
labelTypeLabelType!
secondsToLabelFloat
sendDateFloat
skippedBoolean!

AppendToRolesData

FieldTypeDescription
userEmailString!
roleProjectRole!

AssetData

FieldTypeDescription
consensusMarkFloat
contentString
externalIdString
honeypotMarkFloat
isHoneypotBoolean
isToReviewBoolean
isUsedForConsensusBoolean
jsonContentString
jsonMetadataString
priorityInt
sentBackTo[String]
shouldResetToBeLabeledByBoolean
statusStatus
toBeLabeledBy[String]

AssetWhere

FieldTypeDescription
consensusMarkGteFloat
consensusMarkLteFloat
createdAtGteString
createdAtLteString
externalIdString
externalIdStrictlyIn[String]
externalIdIn[String]
honeypotMarkGteFloat
honeypotMarkLteFloat
inferenceMarkGteFloat
inferenceMarkLteFloat
idID
idIn[ID]
idNotIn[ID]
issueIssueWhere
labelLabelWhere
latestLabelLabelWhere
metadataJSON
projectProjectWhere
skippedBoolean
sortString
statusIn[String]
updatedAtGteString
updatedAtLteString

AvailablePathWhere

FieldTypeDescription
currentTree[JSON]
dataIntegrationIdID!
rootString!

CommentData

FieldTypeDescription
textString!

CommentWhere

FieldTypeDescription
authorUserWhere
idID
issueIssueWhere

CommunicationSubscriptionWhere

FieldTypeDescription
userEmailString

CreateHoneypotData

FieldTypeDescription
jsonResponseString!

CreateOrganizationData

FieldTypeDescription
addressString!
cityString!
countryString!
licenseString
nameString!
zipCodeString!

CreatePredictionsData

FieldTypeDescription
jsonResponseArray[String!]!
modelNameArray[String!]!

CreateProjectData

Deprecation: "userID" field is unused in createProject. The field is deprecated from Sept 16th 2021. It will be removed on Oct 16th 2021.

FieldTypeDescription
descriptionString!
inputTypeInputType!
jsonInterfaceString!
projectTypeProjectType
titleString!

CreateUserData

FieldTypeDescription
emailString!
firstnameString
lastnameString
passwordString
organizationRoleOrganizationRole!

CreateUserFromEmailIfNotExists

FieldTypeDescription
emailString!
firstnameString
lastnameString
organizationRoleOrganizationRole!

DataIntegrationData

FieldTypeDescription
accessBoolean
allowedPaths[String]
dataIntegrationStatusDataIntegrationStatus
nameString
organizationIdString
platformDataIntegrationPlatform
typeDataIntegrationType

DataIntegrationWhere

FieldTypeDescription
accessBoolean
dataIntegrationStatusDataIntegrationStatus
idID
nameString
organizationIdString
platformDataIntegrationPlatform

DataProjectConnectionInput

FieldTypeDescription
isCheckingBoolean!

Checking status

lastCheckedDateTime!

Last time the project data connection was checked

nbAssetInt!

Number of assets in connection

selectedFolders[String]

List of selected folders in scope of connection

DataProjectConnectionsWhere

FieldTypeDescription
idID

FetchAndUpdateOCRJsonMetadataData

FieldTypeDescription
keyFilePathString

GraphWhere

FieldTypeDescription
endDateDateTime
projectIDID
projectUserProjectUserWhere
scaleGraphScale
startDateDateTime
typeGraphType

IssueData

FieldTypeDescription
assigneeIdString
hasBeenSeenBoolean
statusString

IssueWhere

FieldTypeDescription
assetAssetWhere
assetIn[String]
assigneeProjectUserWhere
assigneeIdsIn[String]
authorProjectUserWhere
idID
projectProjectWhere
statusString
typeIssueType

LabelData

FieldTypeDescription
isSentBackToQueueBoolean
jsonResponseString
modelNameString
secondsToLabelFloat

LabelWhere

FieldTypeDescription
assetAssetWhere
authorIn[String]
consensusMarkGteFloat
consensusMarkLteFloat
createdAtString
createdAtGteString
createdAtLteString
honeypotMarkGteFloat
honeypotMarkLteFloat
idID
idIn[ID]
jsonResponseContains[String]
labelerIn[String]
projectProjectWhere
reviewerIn[String]
searchString
skippedBoolean
typeIn[String]
userUserWhere

LockWhere

FieldTypeDescription
idID

NotificationData

FieldTypeDescription
hasBeenSeenBoolean
messageString
statusNotificationStatus
urlString
userIDString

NotificationWhere

FieldTypeDescription
hasBeenSeenBoolean
idID
userUserWhere

OrganizationData

FieldTypeDescription
addressString
cityString
countryString
licenseString
nameString
zipCodeString

OrganizationMetricsWhere

FieldTypeDescription
endDateDateTime
organizationIdString
startDateDateTime

OrganizationWhere

FieldTypeDescription
idID
userUserWhere

ProjectData

FieldTypeDescription
authorString
consensusMarkFloat
consensusTotCoverageInt
descriptionString
honeypotMarkFloat
inputTypeInputType
instructionsString
jsonInterfaceString
metadataTypesJSON
minConsensusSizeInt
numberOfAssetsInt
rulesString
numberOfAssetsWithSkippedLabelsInt
numberOfRemainingAssetsInt
numberOfReviewedAssetsInt
reviewCoverageInt
shouldRelaunchKpiComputationBoolean
titleString
useHoneyPotBoolean

ProjectUserData

FieldTypeDescription
consensusMarkFloat
honeypotMarkFloat
invitationStatusInvitationStatus
numberOfAnnotationsInt
numberOfLabeledAssetsInt
starredBoolean
totalDurationInt

ProjectUserWhere

FieldTypeDescription
activatedBoolean
idID
invitationStatusInvitationStatus
isAuthorBoolean
projectProjectWhere
userUserWhere
activeInProjectBoolean

ProjectVersionData

FieldTypeDescription
contentString

ProjectVersionWhere

FieldTypeDescription
idID
projectIdString

ProjectWhere

FieldTypeDescription
idID
idNotIn[ID]
assetAssetWhere
onlyAcceptedProjectsBoolean
searchQueryString
shouldRelaunchKpiComputationBoolean
updatedAtGteString
updatedAtLteString

RenewLockData

FieldTypeDescription
lockTypeLockType!

RoleData

FieldTypeDescription
projectIDID!
roleProjectRole!
userIDID!

SignUpData

FieldTypeDescription
emailString!

UpdateApiKeyPropertiesData

FieldTypeDescription
revokedBoolean!

UpdateCommunicationSubscriptionWhere

FieldTypeDescription
idID
subscribeBoolean
userEmailString

UpdatePasswordData

FieldTypeDescription
oldPasswordString!
newPassword1String!
newPassword2String!

UserData

FieldTypeDescription
acceptedTermsAndConditionsVersionString
activatedBoolean
apiKeyString
emailString
firstnameString
hubspotSubscriptionStatusHubspotSubscriptionStatus
lastnameString
organizationString
organizationIdString
organizationRoleOrganizationRole

UserWhere

FieldTypeDescription
activatedBoolean
apiKeyString
emailString
idID
idIn[ID!]
organizationOrganizationWhere

Enums

DataIntegrationPlatform

ValueDescription
AWS
AZURE
GCP

DataIntegrationStatus

ValueDescription
CONNECTED
DISCONNECTED
CHECKING

DataIntegrationType

ValueDescription
REMOTE_STORAGE

ExportType

ValueDescription
LATEST
NORMAL

GraphScale

ValueDescription
DAY
MONTH
WEEK

GraphType

ValueDescription
COUNT_BY_CATEGORIES
NUMBER_OF_LABELS

HighestRoleInProject

ValueDescription
NA
ADMIN
TEAM_MANAGER
REVIEWER
LABELER

HubspotSubscriptionStatus

ValueDescription
SUBSCRIBED
UNSUBSCRIBED

InputType

ValueDescription
AUDIO
FRAME
IMAGE
NA
PDF
TEXT
TIME_SERIES
VIDEO
URL

InvitationStatus

ValueDescription
ACCEPTED
DECLINED
PENDING

IssueStatus

ValueDescription
OPEN
SOLVED

IssueType

ValueDescription
ISSUE
QUESTION

LabelFormat

ValueDescription
RAW
SIMPLE
YOLO_V4
YOLO_V5

LabelType

ValueDescription
AUTOSAVE
DEFAULT
INFERENCE
PREDICTION
REVIEW

LicenseType

ValueDescription
DISCOVERY
FREEMIUM
PAID

LockType

ValueDescription
REVIEW
DEFAULT

NotificationStatus

ValueDescription
FAILURE
PENDING
SUCCESS

OrganizationRole

ValueDescription
ADMIN
USER

ProjectRole

ValueDescription
ADMIN
TEAM_MANAGER
REVIEWER
LABELER

ProjectType

ValueDescription
IMAGE_CLASSIFICATION_SINGLE
IMAGE_CLASSIFICATION_MULTI
IMAGE_OBJECT_DETECTION_RECTANGLE
IMAGE_OBJECT_DETECTION_POLYGON
IMAGE_OBJECT_DETECTION_SEMANTIC
IMAGE_POSE_ESTIMATION
OCR
PDF_CLASSIFICATION_SINGLE
PDF_CLASSIFICATION_MULTI
PDF_OBJECT_DETECTION_RECTANGLE
PDF_NAMED_ENTITY_RECOGNITION
SPEECH_TO_TEXT
TEXT_CLASSIFICATION_SINGLE
TEXT_CLASSIFICATION_MULTI
TEXT_TRANSCRIPTION
TEXT_NER
TIME_SERIES
VIDEO_CLASSIFICATION_SINGLE
VIDEO_OBJECT_DETECTION
VIDEO_FRAME_CLASSIFICATION
VIDEO_FRAME_OBJECT_TRACKING

Right

ValueDescription
CAN_ACCESS_SMART_TOOLS
CAN_LABEL
CREATE_AUDIO
CREATE_FRAME
CREATE_IMAGE
CREATE_PDF
CREATE_TEXT
CREATE_TIMESERIES
CREATE_VIDEO
MAKE_PUBLIC_PROJECT
SEE_LICENSE_BANNER
SEE_UPGRADE_BUTTON
UPLOAD_CLOUD_DATA
USE_API
USE_API_PRIORITY

SplitOption

ValueDescription
MERGED_FOLDER
SPLITTED_FOLDER

Status

ValueDescription
TODO
ONGOING
LABELED
REVIEWED
TO_REVIEW

UploadType

ValueDescription
VIDEO
GEO_SATELLITE

WarningTypes

ValueDescription
DUPLICATED_ID
EMPTY_ARRAY
FAILED_ASSET_CREATION
FFMPEG_NOT_INSTALLED
INPUT_UNDEFINED
MAX_INPUT_SIZE
MAX_PROJECT_SIZE
MISSING_ID
NON_INTEGER_FPS
UNSUPPORTED_TYPE
UNSPECIFIED_ERROR
WRONG_CSV_FORMAT

Scalars

Boolean

The Boolean scalar type represents true or false.

DateTime

A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

Email

Custom scalar enforcing a string to be an email

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

JSON

The JSON scalar type represents JSON values as specified by ECMA-404.

PageSize

Custom scalar enforcing a pagination of queries. Maximum value is 500

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.