GraphQL API reference

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

Table of Contents

Query
Mutation
Objects
Inputs
Enums
Scalars
- Boolean
- DateTime
- Email
- Float
- ID
- Int
- JSON
- PageSize
- String

Query

Field	Type	Description
_	Boolean
apiKeys	[ApiKey!]	Retrieves page by page all api keys who verify where input parameters.
where	ApiKeyWhere!
first	PageSize!
skip	Int!
countApiKeys	Int!	Count all api keys who verify where input parameters.
where	ApiKeyWhere!
assets	[Asset!]	Retrieves page by page all assets who verify where input parameters.
where	AssetWhere!
first	PageSize!
skip	Int!
countAssets	Int!	Count all assets who verify where input parameters.
where	AssetWhere!
getAssetsMetadataValues	[String!]	Get all values associated to a given metadata key
projectID	ID!
metadataKey	String!
getNextAssetFromLabel	Asset	Return the next asset
labelAssetIDs	[ID!]
getNextAssetForReviewFromLabel	Asset	Return the next asset
labelAssetIDs	[ID!]
getNextAssetFromProject	Asset	Return the next asset available to label.
projectID	ID!
getNextAssetForReviewFromProject	Asset	Return the next asset available to label.
projectID	ID!
getUploadAssetsToken	String!	Get the encrypted token needed to upload data to the router
projectID	ID!
comments	[Comment!]	Retrieves page by page all comments who verify where input parameters.
where	CommentWhere!
first	PageSize!
skip	Int!
countComments	Int!	Count all comments who verify where input parameters.
where	CommentWhere!
dataIntegrations	[DataIntegration!]	Retrieves page by page all dataIntegrations who verify where input parameters.
where	DataIntegrationWhere!
first	PageSize!
skip	Int!
countDataIntegrations	Int!	Count all dataIntegrations who verify where input parameters.
where	DataIntegrationWhere!
getAvailablePathDataIntegration	[JSON]!	Get available paths of the current data Integration
where	AvailablePathWhere!
dataProjectConnections	[DataProjectConnection!]	Get data connections related with specific project
where	DataProjectConnectionsWhere!
first	PageSize!
skip	Int!
graphData	[Graph!]	Retrieves specific metrics on a specific period of time.
where	GraphWhere!
graphDataByLabeler	[GraphByLabeler!]
where	GraphWhere!
graphDataConsensusRepartition	[Graph!]
where	GraphWhere!
graphs	[Graph!]
where	GraphWhere!
graphAggregatedNumberOfAssetsLabeledByLabeler	[GraphAggregatedNumberOfAssetsLabeledByLabeler!]
where	GraphWhere!
communicationSubscriptions	[CommunicationSubscription!]	Retrieves subscriptions for a specific user
where	CommunicationSubscriptionWhere!
issues	[Issue!]	Retrieves page by page all issues who verify where input parameters.
where	IssueWhere!
first	PageSize!
skip	Int!
countIssues	Int!	Count all issues who verify where input parameters.
where	IssueWhere!
labels	[Label!]	Retrieves page by page all labels who verify where input parameters.
where	LabelWhere!
first	PageSize!
skip	Int!
countLabels	Int!	Count all labels who verify where input parameters.
where	LabelWhere!
getLabelsOrPredictionsForUser	[Label!]
assetID	ID!
userID	ID!
labelID	ID
getLabelsToBeReviewed	[Label!]
assetID	ID!
labelID	ID
locks	[Lock!]	Retrieves page by page all locks who verify where input parameters.
where	LockWhere!
first	PageSize!
skip	Int!
countLocks	Int!	Count all labels who verify where input parameters.
where	LockWhere!
notifications	[Notification!]	Retrieves page by page all notifications that verify input parameters.
where	NotificationWhere!
first	PageSize!
skip	Int!
countNotifications	Int!	Count notifications that verify input parameters.
where	NotificationWhere!
organizations	[Organization!]	Retrieves page by page all organizations who verify where input parameters.
where	OrganizationWhere!
first	PageSize!
skip	Int!
countOrganizations	Int!	Count all organizations who verify where input parameters.
where	OrganizationWhere!
organizationMetrics	OrganizationMetrics!	Count number of labeled assets, annotations and hours on a specific period of time
where	OrganizationMetricsWhere!
listEmailsInOrganization	[String!]	List emails of users in an organization in alphabetical order.
where	OrganizationWhere!
exportData	String!	Export data from project.
where	ProjectWhere!
exportType	ExportType
labelFormat	LabelFormat
splitOption	SplitOption
versionName	String
projects	[Project!]	Retrieves page by page all projects ordered by createdAt for the current user (starred projects come first then unstarred projects)
where	ProjectWhere!
first	PageSize!
skip	Int!
latestUpdatedProjects	[Project!]	Retrieves page by page all projects ordered by updatedAt for the current user
where	ProjectWhere!
first	PageSize!
skip	Int!
countProjects	Int!	Count all projects for a specific userID,
where	ProjectWhere!
projectUsers	[ProjectUser!]	Retrieves page by page all projectUsers who verify where input parameters.
where	ProjectUserWhere!
first	PageSize!
skip	Int!
countProjectUsers	Int!	Count all project users who verify where input parameters.
where	ProjectUserWhere!
projectVersions	[ProjectVersion!]	Retrieves project versions depending on the where object
where	ProjectVersionWhere!
first	PageSize!
skip	Int!
countProjectVersions	Int!	Count all projects versions depending on the where object
where	ProjectVersionWhere!
user	User
id	ID!
me	User
users	[User!]	Retrieves page by page all users who verify where input parameters.
where	UserWhere!
first	PageSize!
skip	Int!
countUsers	Int!	Count all users who verify where input parameters.
where	UserWhere!
adminOfUser	String!	Technical query, used to request the email of an admin of a user

Mutation

Field	Type	Description
_	Boolean
appendToApiKeys	ApiKey	Add an api key to a user
data	AppendToApiKeysData!
where	UserWhere!
updatePropertiesInApiKey	ApiKey
data	UpdateApiKeyPropertiesData!
where	ApiKeyWhere!
addAllLabeledAssetsToReview	Project	Add all labeled assets specified, or if None, all in the project to the review queue
where	AssetWhere!
assignAssetsToLabelers	Project	Assign assets to be labeled by given users
userWhere	UserWhere!
where	AssetWhere!
appendManyToDataset	Project	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.
data	AppendManyToDatasetData!
where	ProjectWhere!
appendManyToDatasetFrontend	UploadAssetsWarnings	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.
data	AppendManyToDatasetData!
where	ProjectWhere!
appendManyFramesToDatasetAsynchronously	Project	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.
data	AppendManyFramesToDatasetAsynchronouslyData!
where	ProjectWhere!
deleteManyFromDataset	Project	Delete one or more assets to the project specified, provided their IDs or the project ID
where	AssetWhere!
updatePropertiesInAsset	Asset	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.
where	AssetWhere!
data	AssetData!
updatePropertiesInAssets	[Asset]	Update the properties of one or more assets.
where	[AssetWhere!]!
data	[AssetData!]!
fetchAndUpdateOCRJsonMetadata	Asset	Fetch OCR metadata using Vision API and put it in the asset metadata.
data	FetchAndUpdateOCRJsonMetadataData!
where	AssetWhere!
fetchAndUpdateOCRJsonMetadataForAssetsInProject	[Asset]	Fetch OCR metadata using Vision API and put it in the asset metadata for all assets in a project.
data	FetchAndUpdateOCRJsonMetadataData!
where	AssetWhere!
sendBackAssetsToQueue	Project	Add all reviewed assets specified, or if None, all in the project to the to do queue
where	AssetWhere!
prioritizeAssets	Project	Prioritize assets to specified priority
where	AssetWhere!
priority	Int!
signUp	User	The request to sign up a new email to the Kili app. If authorized, the email will receive informations to sign in.
data	SignUpData!
resetPassword	User	The request to reset a forgotten password
where	UserWhere!
appendToComments	Comment	Add a new comment
data	AppendToCommentsData!
where	IssueWhere!
updatePropertiesInComment	Comment	Update an existing comment
data	CommentData!
where	CommentWhere!
dataIntegrationTest	DataIntegrationTestData	Test a DataIntegration and return the dataIntegration
dataIntegrationId	ID!
updatePropertiesInDataIntegration	DataIntegration	Update the dataIntegration's data
data	DataIntegrationData!
where	DataIntegrationWhere!
createDataIntegration	DataIntegration	Create a DataIntegration and return the dataIntegration
data	DataIntegrationData!
deleteDataIntegration	DataIntegration	Permanently delete a DataIntegration
where	DataIntegrationWhere!
addDataConnection	DataProjectConnection!	Add project data connection
data	DataProjectConnectionInput!
updateCommunicationSubscription	Boolean	Update a communication (subscribe or unsubscribe) for a specific user to a mailing list
where	UpdateCommunicationSubscriptionWhere!
appendToIssues	Issue	Add a new issue
data	AppendToIssuesData!
where	AssetWhere!
updatePropertiesInIssue	Issue	Update an existing issue
data	IssueData!
where	IssueWhere!
appendToLabels	Label	Add a new annotation
data	AppendToLabelsData!
where	AssetWhere!
frontendAppendToLabels	Label	Add a new annotation from the app
data	AppendToLabelsData!
where	AssetWhere!
updatePropertiesInLabel	Label	Change the annotations in a label.
data	LabelData!
where	LabelWhere!
createHoneypot	Label	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.
data	CreateHoneypotData!
where	AssetWhere!
createPredictions	Project	Upload labels, considered as predictions by a model, aiming at speeding annotation by helping the labeler.
data	CreatePredictionsData!
where	AssetWhere!
renewLock	Lock	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.
data	RenewLockData!
where	AssetWhere!
createNotification	Notification	Create a new notification.
data	NotificationData!
updatePropertiesInNotification	Notification	Update properties of the notification.
data	NotificationData!
where	NotificationWhere!
createOrganization	Organization	Create a new organization
data	CreateOrganizationData!
updatePropertiesInOrganization	Organization	Update properties of the organization
data	OrganizationData!
where	OrganizationWhere!
anonymizeOrganization	Organization	Permanently delete an organization and all its relative data
where	OrganizationWhere!
changeProjectAuthor	Project	Change the author of a project
where	ProjectWhere!
createProject	Project	Create a new project
data	CreateProjectData!
deleteProject	Project	Permanently delete a project
where	ProjectWhere!
deleteProjectAsynchronously	String!	Permanently delete a project's assets using Airflow
where	ProjectWhere!
hardDeleteProject	Project	Permanently hard delete a project
where	ProjectWhere!
makeProjectPublic	Project	Make a project public. Warning: This action is permanent and irreversible.
where	ProjectWhere!
updatePropertiesInProject	Project	Update the project's name and tasks.
data	ProjectData!
where	ProjectWhere!
appendToRoles	Project	Add a new user in the specified project.
data	AppendToRolesData!
where	ProjectWhere!
frontendAppendToRoles	Project	Add a new projectUser in the specified project and send an invite.
data	AppendToRolesData!
where	ProjectWhere!
updatePropertiesInRole	ProjectUser	Change the role of a projectUser
data	RoleData!
where	ProjectUserWhere!
updatePropertiesInProjectUser	ProjectUser	Change properties of a projectUser
data	ProjectUserData!
where	ProjectUserWhere!
deleteFromRoles	Project	Delete a projectUser from the project.
where	ProjectUserWhere!
acceptOrDeclineInvitation	ProjectUser	Accept/decline an invitation to joining a new project.
data	AcceptOrDeclineInvitationData!
where	ProjectWhere!
updatePropertiesInProjectVersion	ProjectVersion
data	ProjectVersionData!
where	ProjectVersionWhere!
deleteUser	Boolean!
where	UserWhere!
createUser	User	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
data	CreateUserData!
createUserFromEmailIfNotExists	User	Create a new user for a specific project inside the organization
data	CreateUserFromEmailIfNotExists!
where	ProjectWhere!
updatePropertiesInUser	User	An admin of an organization can modify every user's information.
data	UserData!
where	UserWhere!
updatePassword	User	Update password of a user.
data	UpdatePasswordData!
where	UserWhere!
resetAndReturnPassword	String	Reset password of a user.
where	UserWhere!

Objects

ApiKey

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

Field	Type	Description
_	Boolean
id	ID!	ID of the api key.
name	String!	Name of the api key.
key	String!	Api key
createdAt	DateTime!	Date at which the api key was created
revoked	Boolean!	If true, the api key cannot be used
user	User	User who owns the api key
userId	ID!	ID of the user who owns the api key

ApiUsage

API usage keeps track of all API calls by user.

Field	Type	Description
_	Boolean
id	ID!
user	String	API key of user.
createdAt	DateTime!	Date of last API call made by user with API key "apiKey".

AppendManyToDatasetWarnings

Field	Argument	Type	Description
duplicatedIds		[String]
linesWithNoId		[Int]

Asset

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

Field	Type	Description
_	Boolean
id	ID!
consensusMark	Float	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.
consensusMarkCompute	JSON	Technical field.
consensusMarkPerCategory	JSON	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.
content	String!	Content of the Asset or URL to the Asset.
contentJson	JSON	Used the same way as content, for upcoming video classification. Duplicate of jsonContent formatted as as JSON instead of a string.
contentJsonCompute	JSON	Technical field.
createdAt	DateTime!
duration	Int	Sum of durations along all labels of the asset (in seconds)
durationCompute	Int	Technical field.
externalId	String	Name of the Asset, visible on the top of the screen on the labelling page, and defined when uploading the image.
honeypotMark	Float	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.
honeypotMarkCompute	Float	Technical field.
inferenceMark	Float	Inference mark at asset level is the inference mark on the very last label by creation date.
inferenceMarkCompute	Float	Technical field.
isHoneypot	Boolean	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.
isToBeLabeledBy	Boolean	Indicates whether one or more user were attributed the asset to label
isUsedForConsensus	Boolean	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.
isToReview	Boolean	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).
jsonContent	String	Used the same way as content, for upcoming video classification
jsonMetadata	String	Asset metadata, i.e. additionnal information shown during the labeling process
issues	[Issue!]!	The issues created for this asset.
latestLabel	Label	Latest label I can trust for my model.
latestLabelCompute	Label	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
metadata	JSON	Asset metadata, i.e. additionnal information shown during the labeling process. Duplicate of jsonMetadata formatted as as JSON instead of a string.
metadataCompute	JSON	Technical field.
numberOfValidLocks	Int!	Number of currently valid locks on this asset.
numberOfValidLocksForReview	Int!	Number of currently valid review locks on this asset.
numberOfValidLocksCompute	Int	Technical field.
ocrMetadata	String	Ocr metadata, i.e. hidden layer of text informations used for OCR tasks
priority	Int!	Assets can be ordered in the labeling process, the minimum value being 0
project	Project	Assets are always related to one project.
projectId	String!
projectIdCompute	String	Technical field.
readPermissionsFromLabels	String!	Technical field.
readPermissionsFromProject	String!	Technical field.
labelVersion	Int!	Lastest version of the label.
sentBackTo	[ProjectUser!]	Technical field
skipped	Boolean!	A boolean indicating whether the asset was skipped or not
skippedCompute	Boolean	Technical field.
status	Status!	Current annotation status of the asset. Can take the values: TODO, ONGOING, LABELED, REVIEWED, TO_REVIEW, AUTOSAVE.
statusCompute	Status	Technical field.
thumbnail	String	Thumbnail of the asset to display in the frontend NB : only available for on-premise and SaaS users
thumbnailCompute	String	Technical field
toBeLabeledBy	[ProjectUser!]	One or more user that were attributed the asset to label
updatedAt	DateTime!
labels	[Label!]!	The labels created for this asset.

AssetDeletedOutput

Field	Argument	Type	Description
assetId		String!
success		Boolean!

AuthPayload

The authentification object to create a token for a user.

Field	Argument	Type	Description
_		Boolean
id		ID!
token		String!
user		User!

Comment

Comment contains comments associated to an issue.

Field	Type	Description
id	ID!
author	ProjectUser!	ProjectUser that created this comment.
authorId	ID!
createdAt	DateTime!
issue	Issue!	ID of the issued this comment is attached to.
issueId	ID!
text	String!	Content of the comment.
updatedAt	DateTime!

CommunicationSubscription

Communication subscription preference of a specific user in Hubspot.

Field	Type	Description
_	Boolean
id	ID!
name	String!	Name of the subscription
description	String!	Description of the subscription
subscribed	Boolean!	Status of the subscription

DataIntegration

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

Field	Type	Description
_	Boolean
id	ID!
access	Boolean!	The integration can be acceded
allowedPaths	[String]!	The list of allowed paths for the dataIntegration if empty all paths are allowed
createdAt	DateTime!
inProject	Boolean!	The integration is in a project
lastCheck	DateTime!	Last time the integration's data was checked
name	String!	The name of the integration
platform	DataIntegrationPlatform!	Third party plateform used by the integration to share data
status	DataIntegrationStatus!	Status of the integration.
type	DataIntegrationType!	Type of the storage of the integration
updatedAt	DateTime!

DataIntegrationTestData

Field	Argument	Type	Description
connected		Boolean
error		String

DataProjectConnection

DataProjectConnection is related with specific project.

Field	Type	Description
_	Boolean
id	ID!	Unique id
isChecking	Boolean!	Checking status
lastChecked	DateTime!	Last time the project data connection was checked
nbAsset	Int!	Number of assets in connection
selectedFolders	[String]	List of selected folders in scope of connection

Graph

Technical field.

Field	Type	Description
_	Boolean
id	ID!
x	String!	Technical field.
y	Float!	Technical field.
job	String	Technical field.

GraphAggregatedNumberOfAssetsLabeledByLabeler

Technical field.

Field	Type	Description
_	Boolean
id	ID!
labelerName	String!	Technical field.
data	Graph!	Technical field.

GraphByLabeler

Technical field.

Field	Type	Description
_	Boolean
id	ID!
labelerName	String!	Technical field.
data	[Graph!]!	Technical field.

Issue

Issue contains issues associated to a User and an Asset.

Field	Type	Description
id	ID!
asset	Asset	ID of the asset related to the issue.
assetId	ID!
assignee	ProjectUser	ID of the projectUser assigned to the issue.
assigneeId	ID
author	ProjectUser	ID of the projectUser author of the issue.
authorId	ID!
comments	[Comment!]	All the comments related to this issue
createdAt	DateTime!
hasBeenSeen	Boolean!	Whether the last activity on the issue has been seen by the author of the issue.
issueNumber	Int!	Numeric ID of the issue
objectMid	String	Object MID of the issue
project	Project	ID of the project of the issue.
projectId	ID!
status	IssueStatus!	Current annotation status of the issue. Can take the values: OPENED, SOLVED.
type	IssueType!
updatedAt	DateTime!

Label

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

Field	Type	Description
_	Boolean
id	ID!
assetId	String!
assetIdCompute	String	Technical field.
author	User!	User that created this label.
authorId	String!
authorIdCompute	String	Technical field.
createdAt	DateTime!
honeypotMark	Float	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.
honeypotMarkCompute	Float	Technical field.
inferenceMark	Float	Inference mark is a quality parameter to measure the agreement between an inference run (from a model) and the annotation made by an annotator.
inferenceMarkCompute	Float	Technical field.
isLatestLabelForUser	Boolean!	Boolean flagging whether the label is the latest submitted label for this asset for the user
isLatestLabelForUserCompute	Boolean	Technical field.
isLatestDefaultLabelForUser	Boolean!	Boolean flagging whether the label is the latest submitted DEFAULT label for this asset for the user.
isLatestDefaultLabelForUserCompute	Boolean	Technical field.
isLatestReviewLabelForUser	Boolean!	Boolean flagging whether the label is the latest submitted REVIEW label for this asset for the user.
isLatestReviewLabelForUserCompute	Boolean	Technical field.
isSentBackToQueue	Boolean	Technical field.
jsonResponse	String!	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.
labelOf	Asset	Asset related to this label.
labelType	LabelType!	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
modelName	String	In case the label was uploaded (and is of type PREDICTION), name (chosen during the upload) of the model used to create the label.
numberOfAnnotations	Int	Total number of annotation elements on the asset.
numberOfAnnotationsCompute	Int	Technical field.
projectId	String!
projectIdCompute	String	Technical field.
readPermissionsFromProject	String!	Technical field.
response	JSON!	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.
responseCompute	JSON	Technical field.
secondsToLabel	Float	Amount of time (in seconds) spent by the labeller on the interface before submitting the label.
search	JSON!	Technical field.
searchCompute	JSON	Technical field.
skipped	Boolean!	A boolean indicating whether the asset was skipped or not
totalSecondsToLabel	Int	Total cumulated amount of time (in seconds) spent by the user on all other labels of the same asset on the interface.
totalSecondsToLabelCompute	Int	Technical field.
version	Int!	Version of the label.

License

Field	Argument	Type	Description
_		Boolean
api		Boolean
apiPriority		Boolean
enableSmartTools		Boolean
expiryDate		String
inputType		[InputType]
maxNumberOfLabeledAssets		Int
organizationId		String
publicProject		Boolean
seats		Int
startDate		String
type		LicenseType
uploadCloudData		Boolean

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

Field	Type	Description
_	Boolean
id	ID!
author	User!	The user that created this lock
authorId	String
authorIdCompute	String	Technical field
createdAt	DateTime!
lockOf	Asset!	The asset this lock is protecting.
lockOfId	String
lockOfIdCompute	String	Technical field
lockType	LockType!	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.

Field	Argument	Type	Description
_		Boolean
id		ID!
createdAt		DateTime!
hasBeenSeen		Boolean!
message		String!
status		NotificationStatus!
url		String!
userID		String!

Organization

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

Field	Argument	Type	Description
_		Boolean
id		ID!
address		String!
city		String!
country		String!
dataIntegrations		[DataIntegration]
license		License
name		String!
numberOfAnnotations		Int!
numberOfLabeledAssets		Int!
numberOfHours		Float!
users		[User]
zipCode		String!

OrganizationMetrics

Technical field

Field	Type	Description
_	Boolean
maxNumberOfLabeledAssets	Int!	Technical field
numberOfAnnotations	Int!	Technical field
numberOfHours	Float!	Technical field
numberOfLabeledAssets	Int!	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.

Field	Type	Description
_	Boolean
id	ID!
assetMetadata	JSON!	Technical field AssetMetadata groups all different metadata keys present in the assets of the project
assetMetadataCompute	JSON	Technical field AssetMetadata groups all different metadata keys present in the assets of the project
author	User
consensusMark	Float	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
consensusMarkPerCategory	JSON	Consensus mark per category, averaged over all assets labeled on the project
consensusTotCoverage	Int	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.
createdAt	DateTime!
dataConnections	[DataProjectConnection]
dataset	[Asset!]	The Dataset is all the assets related to this project
description	String
deletedAt	DateTime!
honeypotMark	Float	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.
inputType	InputType!	The type of asset for the project : AUDIO IMAGE PDF TEXT URL VIDEO NA
instructions	String
interface	JSON!	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.
interfaceCompute	JSON	Technical field.
jsonInterface	String	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.
metadataTypes	JSON	Custom types for metadata
minConsensusSize	Int	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.
mlTasks	String	Technical field, the unique types of tasks found in the project interface.
mlTasksCompute	String	Technical field.
numberOfAssets	Int
numberOfAssetsWithSkippedLabels	Int	The number of assets one annotator at least skipped in the project.
numberOfOpenIssues	Int	The total number of open issues in the project.
numberOfOpenQuestions	Int	The total number of open questions in the project.
numberOfRemainingAssets	Int	The number of unlabeled assets in the project
numberOfSolvedIssues	Int	The total number of solved issues in the project.
numberOfSolvedQuestions	Int	The total number of solved questions in the project.
numberOfReviewedAssets	Int	The number of assets reviewed in the project
versions	[ProjectVersion!]	List of project versions.
publicToken	String!	Token to identify when the project has been made public.
readPermissionsForAssetsAndLabels	String!	Technical field.
reviewCoverage	Int	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
shouldRelaunchKpiComputation	Boolean	Technical field.
title	String
updatedAt	DateTime!
useHoneyPot	Boolean	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.
myRole	ProjectUser

ProjectMutex

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

Field	Type	Description
_	Boolean
id	ID!
projectId	ID!	The user that created this lock
createdAtUtc	DateTime!

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.

Field	Type	Description
_	Boolean
id	ID!
activated	Boolean!	Activated projectUsers can access their project. Deactivated projectUsers cannot access their project.
consensusMark	Float	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.
consensusMarkPerCategory	JSON	Consensus mark per category, averaged over all assets labeled with type DEFAULT by the projectUser
consensusMarkCompute	Float	Technical field.
honeypotMark	Float	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.
honeypotMarkCompute	Float	Technical field.
invitationStatus	InvitationStatus!	invitationStatus indicates whether the invitation to a project as been accepted or not.
isAuthor	Boolean	isAuthor indicates whether a project user is author of its project or not.
lastLabelingAt	String
lastLabelingAtCompute	String	Technical field.
numberOfAnnotations	Int	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.
numberOfAnnotationsCompute	Int	Technical field.
numberOfLabeledAssets	Int	Number of labeled assets of a projectUser is the number of assets labeled with type DEFAULT by the projectUser.
numberOfLabeledAssetsCompute	Int	Technical field.
numberOfLabels	Int	Number of labels of type "DEFAULT" and "REVIEW" made by the projectUser.
numberOfLabelsCompute	Int	Technical field.
project	Project!	Project of projectUser
role	ProjectRole!	Role of projectUser within the project. It can either be: ADMIN TEAM_MANAGER REVIEWER LABELER
starred	Boolean!	Did user from projectUser star project in the list of projects on front page?
totalDuration	Int	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.
totalDurationCompute	Int	Technical field.
user	User!	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.

Field	Type	Description
_	Boolean
id	ID!	ID of the project version.
name	String!	Name of the project version.
createdAt	DateTime!	Date of which the project version was created.
content	String	Link to download the project version.
project	Project	Project from which the version was created.
projectId	String!	ProjectId from which the version was created.

Subscription

Field	Type	Description
_	Boolean
assetDeleted	AssetDeletedOutput	Subscription allowing to receive updates on every action updating or creating a label.
projectID	ID!
labelCreatedOrUpdated	Label	Subscription allowing to receive updates on every action updating or creating a label.
projectID	ID!
notificationCreatedOrUpdated	Notification	Subscription allowing to receive updates on every action updating or creating a notification.
userID	ID!
projectUserCreated	Project	Subscription allowing to receive updates on every action updating or creating a projectUser.
email	String!
projectVersionCreatedOrUpdated	ProjectVersion	Subscription allowing to receive updates on every action updating or creating a projectVersion.
projectID	ID!

Token

Field	Argument	Type	Description
token		String!

UploadAssetsWarnings

Field	Argument	Type	Description
numberOfUploadedAssets		Int
warnings		[Warning]

User

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

Field	Type	Description
_	Boolean
id	ID!
acceptedTermsAndConditionsVersion	String	The version of terms and conditions accepted by the user, null if no version accepted.
activated	Boolean!	Activated users can log in to Kili Technology. Deactivated users cannot log in to Kili Technology.
apiKeys	[ApiKey!]
auth0Id	String	User ID in Auth0 database
createdAt	DateTime!
email	String!	Email works as a unique identifier for a user.
firstname	String	Firstname of the user
highestRoleInProject	String!	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.
highestRoleInProjectCompute	String	Technical field.
hubspotSubscriptionStatus	HubspotSubscriptionStatus	The user accepts to be contacted by Kili Technology.
lastname	String	Lastname of the user
organization	Organization	Each user can belong to one organization.
organizationId	String!
organizationRole	OrganizationRole	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
password	String!
projectUsers	[ProjectUser!]!	The role of a User within a project are defined by a ProjectUser.
rights	[Right!]!	The list of user rights.
updatedAt	DateTime!

Warning

Field	Argument	Type	Description
type		WarningTypes
externalId		String
lineNumber		Int
details		String

Inputs

AcceptOrDeclineInvitationData

Field		Type	Description
isAccepting		Boolean!

ApiKeyWhere

Field		Type	Description
id		ID
user		UserWhere

AppendManyFramesToDatasetAsynchronouslyData

Field		Type	Description
contentArray		[String!]
externalIDArray		[String!]
jsonMetadataArray		[String!]
uploadType		UploadType

AppendManyToDatasetData

Field		Type	Description
contentArray		[String!]
externalIDArray		[String!]
isHoneypotArray		[Boolean!]
statusArray		[Status!]
jsonContentArray		[String]
jsonMetadataArray		[String!]

AppendToApiKeysData

Field		Type	Description
name		String!
key		String!

AppendToCommentsData

Field		Type	Description
inReview		Boolean!
text		String!

AppendToIssuesData

Field		Type	Description
issueNumber		Int!
labelID		ID
objectMid		String
type		IssueType!

AppendToLabelsData

Field		Type	Description
authorID		ID!
jsonResponse		String!
labelType		LabelType!
secondsToLabel		Float
sendDate		Float
skipped		Boolean!

AppendToRolesData

Field		Type	Description
userEmail		String!
role		ProjectRole!

AssetData

Field		Type	Description
consensusMark		Float
content		String
externalId		String
honeypotMark		Float
isHoneypot		Boolean
isToReview		Boolean
isUsedForConsensus		Boolean
jsonContent		String
jsonMetadata		String
priority		Int
sentBackTo		[String]
shouldResetToBeLabeledBy		Boolean
status		Status
toBeLabeledBy		[String]

AssetWhere

Field		Type	Description
consensusMarkGte		Float
consensusMarkLte		Float
createdAtGte		String
createdAtLte		String
externalId		String
externalIdStrictlyIn		[String]
externalIdIn		[String]
honeypotMarkGte		Float
honeypotMarkLte		Float
inferenceMarkGte		Float
inferenceMarkLte		Float
id		ID
idIn		[ID]
idNotIn		[ID]
issue		IssueWhere
label		LabelWhere
latestLabel		LabelWhere
metadata		JSON
project		ProjectWhere
skipped		Boolean
sort		String
statusIn		[String]
updatedAtGte		String
updatedAtLte		String

AvailablePathWhere

Field		Type	Description
currentTree		[JSON]
dataIntegrationId		ID!
root		String!

CommentData

Field		Type	Description
text		String!

CommentWhere

Field		Type	Description
author		UserWhere
id		ID
issue		IssueWhere

CommunicationSubscriptionWhere

Field		Type	Description
userEmail		String

CreateHoneypotData

Field		Type	Description
jsonResponse		String!

CreateOrganizationData

Field		Type	Description
address		String!
city		String!
country		String!
license		String
name		String!
zipCode		String!

CreatePredictionsData

Field		Type	Description
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.

Field		Type	Description
description		String!
inputType		InputType!
jsonInterface		String!
projectType		ProjectType
title		String!

CreateUserData

Field		Type	Description
email		String!
firstname		String
lastname		String
password		String
organizationRole		OrganizationRole!

CreateUserFromEmailIfNotExists

Field		Type	Description
email		String!
firstname		String
lastname		String
organizationRole		OrganizationRole!

DataIntegrationData

Field		Type	Description
access		Boolean
allowedPaths		[String]
dataIntegrationStatus		DataIntegrationStatus
name		String
organizationId		String
platform		DataIntegrationPlatform
type		DataIntegrationType

DataIntegrationWhere

Field		Type	Description
access		Boolean
dataIntegrationStatus		DataIntegrationStatus
id		ID
name		String
organizationId		String
platform		DataIntegrationPlatform

DataProjectConnectionInput

Field	Type	Description
isChecking	Boolean!	Checking status
lastChecked	DateTime!	Last time the project data connection was checked
nbAsset	Int!	Number of assets in connection
selectedFolders	[String]	List of selected folders in scope of connection

DataProjectConnectionsWhere

Field		Type	Description
id		ID

FetchAndUpdateOCRJsonMetadataData

Field		Type	Description
keyFilePath		String

GraphWhere

Field		Type	Description
endDate		DateTime
projectID		ID
projectUser		ProjectUserWhere
scale		GraphScale
startDate		DateTime
type		GraphType

IssueData

Field		Type	Description
assigneeId		String
hasBeenSeen		Boolean
status		String

IssueWhere

Field		Type	Description
asset		AssetWhere
assetIn		[String]
assignee		ProjectUserWhere
assigneeIdsIn		[String]
author		ProjectUserWhere
id		ID
project		ProjectWhere
status		String
type		IssueType

LabelData

Field		Type	Description
isSentBackToQueue		Boolean
jsonResponse		String
modelName		String
secondsToLabel		Float

LabelWhere

Field		Type	Description
asset		AssetWhere
authorIn		[String]
consensusMarkGte		Float
consensusMarkLte		Float
createdAt		String
createdAtGte		String
createdAtLte		String
honeypotMarkGte		Float
honeypotMarkLte		Float
id		ID
idIn		[ID]
jsonResponseContains		[String]
labelerIn		[String]
project		ProjectWhere
reviewerIn		[String]
search		String
skipped		Boolean
typeIn		[String]
user		UserWhere

LockWhere

Field		Type	Description
id		ID

NotificationData

Field		Type	Description
hasBeenSeen		Boolean
message		String
status		NotificationStatus
url		String
userID		String

NotificationWhere

Field		Type	Description
hasBeenSeen		Boolean
id		ID
user		UserWhere

OrganizationData

Field		Type	Description
address		String
city		String
country		String
license		String
name		String
zipCode		String

OrganizationMetricsWhere

Field		Type	Description
endDate		DateTime
organizationId		String
startDate		DateTime

OrganizationWhere

Field		Type	Description
id		ID
user		UserWhere

ProjectData

Field		Type	Description
author		String
consensusMark		Float
consensusTotCoverage		Int
description		String
honeypotMark		Float
inputType		InputType
instructions		String
jsonInterface		String
metadataTypes		JSON
minConsensusSize		Int
numberOfAssets		Int
rules		String
numberOfAssetsWithSkippedLabels		Int
numberOfRemainingAssets		Int
numberOfReviewedAssets		Int
reviewCoverage		Int
shouldRelaunchKpiComputation		Boolean
title		String
useHoneyPot		Boolean

ProjectUserData

Field		Type	Description
consensusMark		Float
honeypotMark		Float
invitationStatus		InvitationStatus
numberOfAnnotations		Int
numberOfLabeledAssets		Int
starred		Boolean
totalDuration		Int

ProjectUserWhere

Field		Type	Description
activated		Boolean
id		ID
invitationStatus		InvitationStatus
isAuthor		Boolean
project		ProjectWhere
user		UserWhere
activeInProject		Boolean

ProjectVersionData

Field		Type	Description
content		String

ProjectVersionWhere

Field		Type	Description
id		ID
projectId		String

ProjectWhere

Field		Type	Description
id		ID
idNotIn		[ID]
asset		AssetWhere
onlyAcceptedProjects		Boolean
searchQuery		String
shouldRelaunchKpiComputation		Boolean
updatedAtGte		String
updatedAtLte		String

RenewLockData

Field		Type	Description
lockType		LockType!

RoleData

Field		Type	Description
projectID		ID!
role		ProjectRole!
userID		ID!

SignUpData

Field		Type	Description
email		String!

UpdateApiKeyPropertiesData

Field		Type	Description
revoked		Boolean!

UpdateCommunicationSubscriptionWhere

Field		Type	Description
id		ID
subscribe		Boolean
userEmail		String

UpdatePasswordData

Field		Type	Description
oldPassword		String!
newPassword1		String!
newPassword2		String!

UserData

Field		Type	Description
acceptedTermsAndConditionsVersion		String
activated		Boolean
apiKey		String
email		String
firstname		String
hubspotSubscriptionStatus		HubspotSubscriptionStatus
lastname		String
organization		String
organizationId		String
organizationRole		OrganizationRole

UserWhere

Field		Type	Description
activated		Boolean
apiKey		String
email		String
id		ID
idIn		[ID!]
organization		OrganizationWhere

Enums

DataIntegrationPlatform

Value	Description
AWS
AZURE
GCP

DataIntegrationStatus

Value	Description
CONNECTED
DISCONNECTED
CHECKING

DataIntegrationType

Value	Description
REMOTE_STORAGE

ExportType

Value	Description
LATEST
NORMAL

GraphScale

Value	Description
DAY
MONTH
WEEK

GraphType

Value	Description
COUNT_BY_CATEGORIES
NUMBER_OF_LABELS

HighestRoleInProject

Value	Description
NA
ADMIN
TEAM_MANAGER
REVIEWER
LABELER

HubspotSubscriptionStatus

Value	Description
SUBSCRIBED
UNSUBSCRIBED

InputType

Value	Description
AUDIO
FRAME
IMAGE
NA
PDF
TEXT
TIME_SERIES
VIDEO
URL

InvitationStatus

Value	Description
ACCEPTED
DECLINED
PENDING

IssueStatus

Value	Description
OPEN
SOLVED

IssueType

Value	Description
ISSUE
QUESTION

LabelFormat

Value	Description
RAW
SIMPLE
YOLO_V4
YOLO_V5

LabelType

Value	Description
AUTOSAVE
DEFAULT
INFERENCE
PREDICTION
REVIEW

LicenseType

Value	Description
DISCOVERY
FREEMIUM
PAID

LockType

Value	Description
REVIEW
DEFAULT

NotificationStatus

Value	Description
FAILURE
PENDING
SUCCESS

OrganizationRole

Value	Description
ADMIN
USER

ProjectRole

Value	Description
ADMIN
TEAM_MANAGER
REVIEWER
LABELER

ProjectType

Value	Description
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

Value	Description
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

Value	Description
MERGED_FOLDER
SPLITTED_FOLDER

Status

Value	Description
TODO
ONGOING
LABELED
REVIEWED
TO_REVIEW

UploadType

Value	Description
VIDEO
GEO_SATELLITE

WarningTypes

Value	Description
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.