GET /v2/models/{modelId}/output_info Get a the output info for a given model_id or model_id/version_id combo.

operationId: V2_GetModelOutputInfo2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
versionId	query	optional	string	This is included so that we can re-use this request for multiple rpcs with and without the version_id.
language	query	optional	string	—
trainedBefore	query	optional	boolean	—
additionalFields	query	optional	array	(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs, presets

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/models/{modelId}/output_info

POST /v2/models/{modelId}/outputs Get predicted outputs from the model.

operationId: V2_PostModelOutputs4

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—

Request Body

required

application/json

schema V2PostModelOutputs4Request

Property	Type	Required
model	object	optional
└ id	string	optional
└ name	string	optional
└ task	string	optional
└ appId	string	optional
└ image	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ imageInfo	object	optional
└ width	integer	optional
└ format	string	optional
└ height	integer	optional
└ colorMode	string	optional
└ allowDuplicateUrl	boolean	optional
└ notes	string	optional
└ userId	string	optional
└ presets	object	optional
└ metadata	object	optional
└ toolkits	array	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ languages	array	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ outputInfo	object	optional
└ data	object	optional
└ geo	object	optional
└ hits	array	optional
└ text	object	optional
└ audio	object	optional
└ image	object	optional
└ video	object	optional
└ colors	array	optional
└ frames	array	optional
└ tracks	array	optional
└ regions	array	optional
└ clusters	array	optional
└ concepts	array	optional
└ heatmaps	array	optional
└ metadata	object	optional
└ embeddings	array	optional
└ timeSegments	array	optional
└ params	object	optional
└ message	string	optional
└ fieldsMap	object	optional
└ paramsSpecs	array	optional
└ path	string	optional
└ required	boolean	optional
└ fieldType	string	optional
└ description	string	optional
└ placeholder	string	optional
└ defaultValue	object	optional
└ internalOnly	boolean	optional
└ modelTypeRangeInfo	object	optional
└ modelTypeEnumOptions	array	optional
└ outputConfig	object	optional
└ language	string	optional
└ minValue	number	optional
└ sampleMs	integer	optional
└ hyperParams	object	optional
└ maxConcepts	integer	optional
└ modelMetadata	object	optional
└ selectConcepts	array	optional
└ existingModelId	string	optional
└ hyperParameters	string	optional
└ trainingTimeout	integer	optional
└ embedModelVersionId	string	optional
└ conceptsMutuallyExclusive	boolean	optional
└ failOnMissingPositiveExamples	boolean	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ displayName	string	optional
└ …7 more	object	optional
inputs	array	optional
└ id	string	optional
└ data	object	optional
└ geo	object	optional
└ geoBox	array	optional
└ geoLimit	object	optional
└ geoPoint	object	optional
└ hits	array	optional
└ appId	string	optional
└ input	object	optional
└ score	number	optional
└ userId	string	optional
└ annotation	object	optional
└ text	object	optional
└ raw	string	optional
└ url	string	optional
└ hosted	object	optional
└ textInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ audio	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ audioInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ image	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ imageInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ video	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ videoInfo	object	optional
└ thumbnailUrl	string	optional
└ hostedThumbnail	object	optional
└ allowDuplicateUrl	boolean	optional
└ colors	array	optional
└ w3c	object	optional
└ value	number	optional
└ rawHex	string	optional
└ frames	array	optional
└ id	string	optional
└ data	object	optional
└ frameInfo	object	optional
└ tracks	array	optional
└ id	string	optional
└ data	object	optional
└ quality	number	optional
└ timeInfo	object	optional
└ regions	array	optional
└ id	string	optional
└ data	object	optional
└ value	number	optional
└ trackId	string	optional
└ regionInfo	object	optional
└ clusters	array	optional
└ id	string	optional
└ hits	array	optional
└ count	integer	optional
└ score	number	optional
└ projection	array	optional
└ concepts	array	optional
└ id	string	optional
└ name	string	optional
└ appId	string	optional
└ value	number	optional
└ userId	string	optional
└ vocabId	string	optional
└ language	string	optional
└ createdAt	string	optional
└ extraInfo	object	optional
└ definition	string	optional
└ visibility	object	optional
└ keypointInfo	object	optional
└ heatmaps	array	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ imageInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ metadata	object	optional
└ embeddings	array	optional
└ vector	array	optional
└ numDimensions	integer	optional
└ timeSegments	array	optional
└ id	string	optional
└ data	object	optional
└ timeInfo	object	optional
└ status	object	optional
└ code	string	optional
└ reqId	string	optional
└ details	string	optional
└ stackTrace	array	optional
└ description	string	optional
└ redirectInfo	object	optional
└ url	string	optional
└ resourceType	string	optional
└ newResourceId	string	optional
└ oldResourceId	string	optional
└ timeRemaining	integer	optional
└ developerNotes	string	optional
└ internalDetails	string	optional
└ percentCompleted	integer	optional
└ createdAt	string	optional
└ datasetIds	array	optional
└ modifiedAt	string	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
versionId	string	optional
runnerSelector	object	optional
└ runner	object	optional
└ id	string	optional
└ model	object	optional
└ id	string	optional
└ name	string	optional
└ task	string	optional
└ appId	string	optional
└ image	object	optional
└ notes	string	optional
└ userId	string	optional
└ presets	object	optional
└ metadata	object	optional
└ toolkits	array	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ languages	array	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ outputInfo	object	optional
└ visibility	object	optional
└ description	string	optional
└ displayName	string	optional
└ …7 more	object	optional
└ labels	array	optional
└ userId	string	optional
└ metadata	object	optional
└ nodepool	object	optional
└ id	string	optional
└ userId	string	optional
└ cloudRegion	object	optional
└ maxInstances	integer	optional
└ minInstances	integer	optional
└ capacityTypes	array	optional
└ instanceTypes	array	optional
└ workflow	object	optional
└ id	string	optional
└ appId	string	optional
└ image	object	optional
└ nodes	array	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ metadata	object	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ description	string	optional
└ checkConsents	array	optional
└ bookmarkOrigin	object	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ computeInfo	object	optional
└ numCpus	integer	optional
└ cpuMemory	string	optional
└ acceleratorType	array	optional
└ numAccelerators	integer	optional
└ acceleratorMemory	string	optional
└ description	string	optional
└ nodepool	object	optional
└ id	string	optional
└ userId	string	optional
└ cloudRegion	object	optional
└ id	string	optional
└ cloud	string	optional
└ region	string	optional
└ maxInstances	integer	optional
└ minInstances	integer	optional
└ capacityTypes	array	optional
└ instanceTypes	array	optional
└ deployment	object	optional
└ id	string	optional
└ model	object	optional
└ id	string	optional
└ name	string	optional
└ task	string	optional
└ appId	string	optional
└ image	object	optional
└ notes	string	optional
└ userId	string	optional
└ presets	object	optional
└ metadata	object	optional
└ toolkits	array	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ languages	array	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ outputInfo	object	optional
└ visibility	object	optional
└ description	string	optional
└ displayName	string	optional
└ …7 more	object	optional
└ userId	string	optional
└ workflow	object	optional
└ id	string	optional
└ appId	string	optional
└ image	object	optional
└ nodes	array	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ metadata	object	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ description	string	optional
└ checkConsents	array	optional
└ bookmarkOrigin	object	optional
└ nodepools	array	optional
└ id	string	optional
└ userId	string	optional
└ cloudRegion	object	optional
└ maxInstances	integer	optional
└ minInstances	integer	optional
└ capacityTypes	array	optional
└ instanceTypes	array	optional
└ autoscaleConfig	object	optional
└ maxReplicas	integer	optional
└ minReplicas	integer	optional
└ enablePacking	boolean	optional
└ scaleUpDelaySeconds	integer	optional
└ scaleDownDelaySeconds	integer	optional
└ trafficHistorySeconds	integer	optional
└ schedulingChoice	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/models/{modelId}/outputs

POST /v2/models/{modelId}/publish PostModelVersionsPublish

operationId: V2_PostModelVersionsPublish2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—

Request Body

required

application/json

schema V2PostModelVersionsPublish2Request

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
publications	array	optional
└ versionId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/models/{modelId}/publish

GET /v2/models/{modelId}/references Lists model references tied to a particular model id.

operationId: V2_ListModelReferences2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
page	query	optional	integer	Optional, defaults to 1.
perPage	query	optional	integer	Optional, defaults to 128 references per page.

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/models/{modelId}/references

PATCH /v2/models/{modelId}/toolkits Update model toolkits tags

operationId: V2_PatchModelToolkits2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—

Request Body

required

application/json

schema V2PatchModelToolkits2Request

Property	Type	Required
action	string	optional
toolkits	array	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/models/{modelId}/toolkits

POST /v2/models/{modelId}/unpublish PostModelVersionsUnPublish

operationId: V2_PostModelVersionsUnPublish2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—

Request Body

required

application/json

schema V2PostModelVersionsUnPublish2Request

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
publications	array	optional
└ versionId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/models/{modelId}/unpublish

PATCH /v2/models/{modelId}/usecases Update model use_cases tags

operationId: V2_PatchModelUseCases2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—

Request Body

required

application/json

schema V2PatchModelUseCases2Request

Property	Type	Required
action	string	optional
usecases	array	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/models/{modelId}/usecases

GET /v2/models/{modelId}/versions List all the models.

operationId: V2_ListModelVersions2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
page	query	optional	integer	(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.
perPage	query	optional	integer	(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.
conceptIds	query	optional	array	Filtering options: To list only the model versions that have these concept ids present in them.
trainedOnly	query	optional	boolean	To list only the model versions that have been trained.
sortAscending	query	optional	boolean	Sorting options: Whether to sort in ascending order. If false, will order in descending order.
sortByStatusCode	query	optional	boolean	Whether to order by the status code
sortByNumInputs	query	optional	boolean	Whether to order by the number of training inputs
sortByDescription	query	optional	boolean	Whether to sort by the description
sortByCreatedAt	query	optional	boolean	Whether to order by the created_at time If neither sort option is set to true, will sort by created_at.

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/models/{modelId}/versions

POST /v2/models/{modelId}/versions Create a new model version to trigger training of the model.

operationId: V2_PostModelVersions2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—

Request Body

required

application/json

schema V2PostModelVersions2Request

Property	Type	Required
evalInfo	object	optional
└ params	object	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
description	string	optional
modelVersions	array	optional
└ id	string	optional
└ appId	string	optional
└ status	object	optional
└ code	string	optional
└ reqId	string	optional
└ details	string	optional
└ stackTrace	array	optional
└ description	string	optional
└ redirectInfo	object	optional
└ url	string	optional
└ resourceType	string	optional
└ newResourceId	string	optional
└ oldResourceId	string	optional
└ timeRemaining	integer	optional
└ developerNotes	string	optional
└ internalDetails	string	optional
└ percentCompleted	integer	optional
└ userId	string	optional
└ license	string	optional
└ metrics	object	optional
└ id	string	optional
└ appId	string	optional
└ model	object	optional
└ id	string	optional
└ name	string	optional
└ task	string	optional
└ appId	string	optional
└ image	object	optional
└ notes	string	optional
└ userId	string	optional
└ presets	object	optional
└ metadata	object	optional
└ toolkits	array	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ languages	array	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ outputInfo	object	optional
└ visibility	object	optional
└ description	string	optional
└ displayName	string	optional
└ …7 more	object	optional
└ status	object	optional
└ code	string	optional
└ reqId	string	optional
└ details	string	optional
└ stackTrace	array	optional
└ description	string	optional
└ redirectInfo	object	optional
└ timeRemaining	integer	optional
└ developerNotes	string	optional
└ internalDetails	string	optional
└ percentCompleted	integer	optional
└ userId	string	optional
└ summary	object	optional
└ lopqMetrics	array	optional
└ top1Accuracy	number	optional
└ top5Accuracy	number	optional
└ macroAvgRecall	number	optional
└ macroAvgRocAuc	number	optional
└ macroStdRocAuc	number	optional
└ macroAvgF1Score	number	optional
└ macroStdF1Score	number	optional
└ macroAvgPrecision	number	optional
└ meanAvgPrecisionIou50	number	optional
└ meanAvgPrecisionIouRange	number	optional
└ testSet	array	optional
└ input	object	optional
└ annotation	object	optional
└ predictedConcepts	array	optional
└ groundTruthConcepts	array	optional
└ evalInfo	object	optional
└ params	object	optional
└ labelCounts	object	optional
└ positiveLabelCounts	array	optional
└ binaryMetrics	array	optional
└ f1	number	optional
└ iou	number	optional
└ numNeg	integer	optional
└ numPos	integer	optional
└ numTot	integer	optional
└ rocAuc	number	optional
└ areaMax	number	optional
└ areaMin	number	optional
└ concept	object	optional
└ areaName	string	optional
└ rocCurve	object	optional
└ avgPrecision	number	optional
└ precisionRecallCurve	object	optional
└ metricsByArea	array	optional
└ f1	number	optional
└ iou	number	optional
└ numNeg	integer	optional
└ numPos	integer	optional
└ numTot	integer	optional
└ rocAuc	number	optional
└ areaMax	number	optional
└ areaMin	number	optional
└ concept	object	optional
└ areaName	string	optional
└ rocCurve	object	optional
└ avgPrecision	number	optional
└ precisionRecallCurve	object	optional
└ metricsByClass	array	optional
└ f1	number	optional
└ iou	number	optional
└ numNeg	integer	optional
└ numPos	integer	optional
└ numTot	integer	optional
└ rocAuc	number	optional
└ areaMax	number	optional
└ areaMin	number	optional
└ concept	object	optional
└ areaName	string	optional
└ rocCurve	object	optional
└ avgPrecision	number	optional
└ precisionRecallCurve	object	optional
└ trackerMetrics	array	optional
└ aiid	string	optional
└ motMota	number	optional
└ morseFrag	number	optional
└ avgPrecision	number	optional
└ motNumSwitches	integer	optional
└ uniqueSwitchRate	number	optional
└ confusionMatrix	object	optional
└ matrix	array	optional
└ conceptIds	array	optional
└ extendedMetrics	object	optional
└ userMetrics	object	optional
└ cooccurrenceMatrix	object	optional
└ matrix	array	optional
└ conceptIds	array	optional
└ groundTruthDataset	object	optional
└ id	string	optional
└ appId	string	optional
└ image	object	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ description	string	optional
└ bookmarkOrigin	object	optional
└ defaultProcessingInfo	object	optional
└ defaultAnnotationFilter	object	optional
└ predictionsDataset	object	optional
└ id	string	optional
└ appId	string	optional
└ image	object	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ description	string	optional
└ bookmarkOrigin	object	optional
└ defaultProcessingInfo	object	optional
└ defaultAnnotationFilter	object	optional
└ metadata	object	optional
└ trainLog	string	optional
└ buildInfo	object	optional
└ dockerImageTag	string	optional
└ dockerImageName	string	optional
└ dockerImageDigest	string	optional
└ createdAt	string	optional
└ inputInfo	object	optional
└ params	object	optional
└ fieldsMap	object	optional
└ baseEmbedModel	object	optional
└ id	string	optional
└ name	string	optional
└ task	string	optional
└ appId	string	optional
└ image	object	optional
└ notes	string	optional
└ userId	string	optional
└ presets	object	optional
└ metadata	object	optional
└ toolkits	array	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ languages	array	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ outputInfo	object	optional
└ visibility	object	optional
└ description	string	optional
└ displayName	string	optional
└ …7 more	object	optional
└ trainInfo	object	optional
└ params	object	optional
└ dataset	object	optional
└ id	string	optional
└ appId	string	optional
└ image	object	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ description	string	optional
└ bookmarkOrigin	object	optional
└ defaultProcessingInfo	object	optional
└ defaultAnnotationFilter	object	optional
└ resumeFromModel	object	optional
└ id	string	optional
└ name	string	optional
└ task	string	optional
└ appId	string	optional
└ image	object	optional
└ notes	string	optional
└ userId	string	optional
└ presets	object	optional
└ metadata	object	optional
└ toolkits	array	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ languages	array	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ outputInfo	object	optional
└ visibility	object	optional
└ description	string	optional
└ displayName	string	optional
└ …7 more	object	optional
└ importInfo	object	optional
└ params	object	optional
└ modifiedAt	string	optional
└ outputInfo	object	optional
└ data	object	optional
└ geo	object	optional
└ hits	array	optional
└ text	object	optional
└ audio	object	optional
└ image	object	optional
└ video	object	optional
└ colors	array	optional
└ frames	array	optional
└ tracks	array	optional
└ regions	array	optional
└ clusters	array	optional
└ concepts	array	optional
└ heatmaps	array	optional
└ metadata	object	optional
└ embeddings	array	optional
└ timeSegments	array	optional
└ params	object	optional
└ message	string	optional
└ fieldsMap	object	optional
└ paramsSpecs	array	optional
└ path	string	optional
└ required	boolean	optional
└ fieldType	string	optional
└ description	string	optional
└ placeholder	string	optional
└ defaultValue	object	optional
└ internalOnly	boolean	optional
└ modelTypeRangeInfo	object	optional
└ modelTypeEnumOptions	array	optional
└ outputConfig	object	optional
└ language	string	optional
└ minValue	number	optional
└ sampleMs	integer	optional
└ hyperParams	object	optional
└ maxConcepts	integer	optional
└ modelMetadata	object	optional
└ selectConcepts	array	optional
└ existingModelId	string	optional
└ hyperParameters	string	optional
└ trainingTimeout	integer	optional
└ embedModelVersionId	string	optional
└ conceptsMutuallyExclusive	boolean	optional
└ failOnMissingPositiveExamples	boolean	optional
└ visibility	object	optional
└ gettable	string	optional
└ completedAt	string	optional
└ description	string	optional
└ totalInputCount	integer	optional
└ activeConceptCount	integer	optional
└ …2 more	object	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/models/{modelId}/versions

POST /v2/models/{modelId}/versions/time_estimate Get the training time estimate based off train request and estimated input count.

operationId: V2_PostModelVersionsTrainingTimeEstimate2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—

Request Body

required

application/json

schema V2PostModelVersionsTrainingTimeEstimate2Request

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
modelVersions	array	optional
└ id	string	optional
└ appId	string	optional
└ status	object	optional
└ code	string	optional
└ reqId	string	optional
└ details	string	optional
└ stackTrace	array	optional
└ description	string	optional
└ redirectInfo	object	optional
└ url	string	optional
└ resourceType	string	optional
└ newResourceId	string	optional
└ oldResourceId	string	optional
└ timeRemaining	integer	optional
└ developerNotes	string	optional
└ internalDetails	string	optional
└ percentCompleted	integer	optional
└ userId	string	optional
└ license	string	optional
└ metrics	object	optional
└ id	string	optional
└ appId	string	optional
└ model	object	optional
└ id	string	optional
└ name	string	optional
└ task	string	optional
└ appId	string	optional
└ image	object	optional
└ notes	string	optional
└ userId	string	optional
└ presets	object	optional
└ metadata	object	optional
└ toolkits	array	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ languages	array	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ outputInfo	object	optional
└ visibility	object	optional
└ description	string	optional
└ displayName	string	optional
└ …7 more	object	optional
└ status	object	optional
└ code	string	optional
└ reqId	string	optional
└ details	string	optional
└ stackTrace	array	optional
└ description	string	optional
└ redirectInfo	object	optional
└ timeRemaining	integer	optional
└ developerNotes	string	optional
└ internalDetails	string	optional
└ percentCompleted	integer	optional
└ userId	string	optional
└ summary	object	optional
└ lopqMetrics	array	optional
└ top1Accuracy	number	optional
└ top5Accuracy	number	optional
└ macroAvgRecall	number	optional
└ macroAvgRocAuc	number	optional
└ macroStdRocAuc	number	optional
└ macroAvgF1Score	number	optional
└ macroStdF1Score	number	optional
└ macroAvgPrecision	number	optional
└ meanAvgPrecisionIou50	number	optional
└ meanAvgPrecisionIouRange	number	optional
└ testSet	array	optional
└ input	object	optional
└ annotation	object	optional
└ predictedConcepts	array	optional
└ groundTruthConcepts	array	optional
└ evalInfo	object	optional
└ params	object	optional
└ labelCounts	object	optional
└ positiveLabelCounts	array	optional
└ binaryMetrics	array	optional
└ f1	number	optional
└ iou	number	optional
└ numNeg	integer	optional
└ numPos	integer	optional
└ numTot	integer	optional
└ rocAuc	number	optional
└ areaMax	number	optional
└ areaMin	number	optional
└ concept	object	optional
└ areaName	string	optional
└ rocCurve	object	optional
└ avgPrecision	number	optional
└ precisionRecallCurve	object	optional
└ metricsByArea	array	optional
└ f1	number	optional
└ iou	number	optional
└ numNeg	integer	optional
└ numPos	integer	optional
└ numTot	integer	optional
└ rocAuc	number	optional
└ areaMax	number	optional
└ areaMin	number	optional
└ concept	object	optional
└ areaName	string	optional
└ rocCurve	object	optional
└ avgPrecision	number	optional
└ precisionRecallCurve	object	optional
└ metricsByClass	array	optional
└ f1	number	optional
└ iou	number	optional
└ numNeg	integer	optional
└ numPos	integer	optional
└ numTot	integer	optional
└ rocAuc	number	optional
└ areaMax	number	optional
└ areaMin	number	optional
└ concept	object	optional
└ areaName	string	optional
└ rocCurve	object	optional
└ avgPrecision	number	optional
└ precisionRecallCurve	object	optional
└ trackerMetrics	array	optional
└ aiid	string	optional
└ motMota	number	optional
└ morseFrag	number	optional
└ avgPrecision	number	optional
└ motNumSwitches	integer	optional
└ uniqueSwitchRate	number	optional
└ confusionMatrix	object	optional
└ matrix	array	optional
└ conceptIds	array	optional
└ extendedMetrics	object	optional
└ userMetrics	object	optional
└ cooccurrenceMatrix	object	optional
└ matrix	array	optional
└ conceptIds	array	optional
└ groundTruthDataset	object	optional
└ id	string	optional
└ appId	string	optional
└ image	object	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ description	string	optional
└ bookmarkOrigin	object	optional
└ defaultProcessingInfo	object	optional
└ defaultAnnotationFilter	object	optional
└ predictionsDataset	object	optional
└ id	string	optional
└ appId	string	optional
└ image	object	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ description	string	optional
└ bookmarkOrigin	object	optional
└ defaultProcessingInfo	object	optional
└ defaultAnnotationFilter	object	optional
└ metadata	object	optional
└ trainLog	string	optional
└ buildInfo	object	optional
└ dockerImageTag	string	optional
└ dockerImageName	string	optional
└ dockerImageDigest	string	optional
└ createdAt	string	optional
└ inputInfo	object	optional
└ params	object	optional
└ fieldsMap	object	optional
└ baseEmbedModel	object	optional
└ id	string	optional
└ name	string	optional
└ task	string	optional
└ appId	string	optional
└ image	object	optional
└ notes	string	optional
└ userId	string	optional
└ presets	object	optional
└ metadata	object	optional
└ toolkits	array	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ languages	array	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ outputInfo	object	optional
└ visibility	object	optional
└ description	string	optional
└ displayName	string	optional
└ …7 more	object	optional
└ trainInfo	object	optional
└ params	object	optional
└ dataset	object	optional
└ id	string	optional
└ appId	string	optional
└ image	object	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ description	string	optional
└ bookmarkOrigin	object	optional
└ defaultProcessingInfo	object	optional
└ defaultAnnotationFilter	object	optional
└ resumeFromModel	object	optional
└ id	string	optional
└ name	string	optional
└ task	string	optional
└ appId	string	optional
└ image	object	optional
└ notes	string	optional
└ userId	string	optional
└ presets	object	optional
└ metadata	object	optional
└ toolkits	array	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ languages	array	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ outputInfo	object	optional
└ visibility	object	optional
└ description	string	optional
└ displayName	string	optional
└ …7 more	object	optional
└ importInfo	object	optional
└ params	object	optional
└ modifiedAt	string	optional
└ outputInfo	object	optional
└ data	object	optional
└ geo	object	optional
└ hits	array	optional
└ text	object	optional
└ audio	object	optional
└ image	object	optional
└ video	object	optional
└ colors	array	optional
└ frames	array	optional
└ tracks	array	optional
└ regions	array	optional
└ clusters	array	optional
└ concepts	array	optional
└ heatmaps	array	optional
└ metadata	object	optional
└ embeddings	array	optional
└ timeSegments	array	optional
└ params	object	optional
└ message	string	optional
└ fieldsMap	object	optional
└ paramsSpecs	array	optional
└ path	string	optional
└ required	boolean	optional
└ fieldType	string	optional
└ description	string	optional
└ placeholder	string	optional
└ defaultValue	object	optional
└ internalOnly	boolean	optional
└ modelTypeRangeInfo	object	optional
└ modelTypeEnumOptions	array	optional
└ outputConfig	object	optional
└ language	string	optional
└ minValue	number	optional
└ sampleMs	integer	optional
└ hyperParams	object	optional
└ maxConcepts	integer	optional
└ modelMetadata	object	optional
└ selectConcepts	array	optional
└ existingModelId	string	optional
└ hyperParameters	string	optional
└ trainingTimeout	integer	optional
└ embedModelVersionId	string	optional
└ conceptsMutuallyExclusive	boolean	optional
└ failOnMissingPositiveExamples	boolean	optional
└ visibility	object	optional
└ gettable	string	optional
└ completedAt	string	optional
└ description	string	optional
└ totalInputCount	integer	optional
└ activeConceptCount	integer	optional
└ …2 more	object	optional
estimatedInputCount	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/models/{modelId}/versions/time_estimate

GET /v2/models/{modelId}/versions/{modelVersionId}/evaluations Deprecated, use GetEvaluation instead List the evaluation metrics for a model version.

operationId: V2_ListModelVersionEvaluations2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—
modelVersionId	path	required	string	—
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
page	query	optional	integer	(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.
perPage	query	optional	integer	(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/models/{modelId}/versions/{modelVersionId}/evaluations

POST /v2/models/{modelId}/versions/{modelVersionId}/evaluations Deprecated, use PostEvaluations instead

operationId: V2_PostModelVersionEvaluations2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—
modelVersionId	path	required	string	—

Request Body

required

application/json

schema V2PostModelVersionEvaluations2Request

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
evalMetrics	array	optional
└ id	string	optional
└ appId	string	optional
└ model	object	optional
└ id	string	optional
└ name	string	optional
└ task	string	optional
└ appId	string	optional
└ image	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ imageInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ notes	string	optional
└ userId	string	optional
└ presets	object	optional
└ metadata	object	optional
└ toolkits	array	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ languages	array	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ outputInfo	object	optional
└ data	object	optional
└ params	object	optional
└ message	string	optional
└ fieldsMap	object	optional
└ paramsSpecs	array	optional
└ outputConfig	object	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ displayName	string	optional
└ …7 more	object	optional
└ status	object	optional
└ code	string	optional
└ reqId	string	optional
└ details	string	optional
└ stackTrace	array	optional
└ description	string	optional
└ redirectInfo	object	optional
└ url	string	optional
└ resourceType	string	optional
└ newResourceId	string	optional
└ oldResourceId	string	optional
└ timeRemaining	integer	optional
└ developerNotes	string	optional
└ internalDetails	string	optional
└ percentCompleted	integer	optional
└ userId	string	optional
└ summary	object	optional
└ lopqMetrics	array	optional
└ k	integer	optional
└ lopqNdcg	number	optional
└ bruteForceNdcg	number	optional
└ recallVsBruteForce	number	optional
└ kendallTauVsBruteForce	number	optional
└ mostFrequentCodePercent	number	optional
└ top1Accuracy	number	optional
└ top5Accuracy	number	optional
└ macroAvgRecall	number	optional
└ macroAvgRocAuc	number	optional
└ macroStdRocAuc	number	optional
└ macroAvgF1Score	number	optional
└ macroStdF1Score	number	optional
└ macroAvgPrecision	number	optional
└ meanAvgPrecisionIou50	number	optional
└ meanAvgPrecisionIouRange	number	optional
└ testSet	array	optional
└ input	object	optional
└ id	string	optional
└ data	object	optional
└ status	object	optional
└ createdAt	string	optional
└ datasetIds	array	optional
└ modifiedAt	string	optional
└ annotation	object	optional
└ id	string	optional
└ data	object	optional
└ status	object	optional
└ taskId	string	optional
└ userId	string	optional
└ inputId	string	optional
└ trusted	boolean	optional
└ createdAt	string	optional
└ inputLevel	boolean	optional
└ modifiedAt	string	optional
└ consensusInfo	object	optional
└ annotationInfo	object	optional
└ modelVersionId	string	optional
└ workflowVersionId	string	optional
└ embedModelVersionId	string	optional
└ predictedConcepts	array	optional
└ id	string	optional
└ name	string	optional
└ appId	string	optional
└ value	number	optional
└ userId	string	optional
└ vocabId	string	optional
└ language	string	optional
└ createdAt	string	optional
└ extraInfo	object	optional
└ definition	string	optional
└ visibility	object	optional
└ keypointInfo	object	optional
└ groundTruthConcepts	array	optional
└ id	string	optional
└ name	string	optional
└ appId	string	optional
└ value	number	optional
└ userId	string	optional
└ vocabId	string	optional
└ language	string	optional
└ createdAt	string	optional
└ extraInfo	object	optional
└ definition	string	optional
└ visibility	object	optional
└ keypointInfo	object	optional
└ evalInfo	object	optional
└ params	object	optional
└ labelCounts	object	optional
└ positiveLabelCounts	array	optional
└ count	integer	optional
└ concept	object	optional
└ conceptName	string	optional
└ binaryMetrics	array	optional
└ f1	number	optional
└ iou	number	optional
└ numNeg	integer	optional
└ numPos	integer	optional
└ numTot	integer	optional
└ rocAuc	number	optional
└ areaMax	number	optional
└ areaMin	number	optional
└ concept	object	optional
└ id	string	optional
└ name	string	optional
└ appId	string	optional
└ value	number	optional
└ userId	string	optional
└ vocabId	string	optional
└ language	string	optional
└ createdAt	string	optional
└ extraInfo	object	optional
└ definition	string	optional
└ visibility	object	optional
└ keypointInfo	object	optional
└ areaName	string	optional
└ rocCurve	object	optional
└ fpr	array	optional
└ tpr	array	optional
└ thresholds	array	optional
└ fprPerImage	array	optional
└ fprPerObject	array	optional
└ avgPrecision	number	optional
└ precisionRecallCurve	object	optional
└ recall	array	optional
└ precision	array	optional
└ thresholds	array	optional
└ metricsByArea	array	optional
└ f1	number	optional
└ iou	number	optional
└ numNeg	integer	optional
└ numPos	integer	optional
└ numTot	integer	optional
└ rocAuc	number	optional
└ areaMax	number	optional
└ areaMin	number	optional
└ concept	object	optional
└ id	string	optional
└ name	string	optional
└ appId	string	optional
└ value	number	optional
└ userId	string	optional
└ vocabId	string	optional
└ language	string	optional
└ createdAt	string	optional
└ extraInfo	object	optional
└ definition	string	optional
└ visibility	object	optional
└ keypointInfo	object	optional
└ areaName	string	optional
└ rocCurve	object	optional
└ fpr	array	optional
└ tpr	array	optional
└ thresholds	array	optional
└ fprPerImage	array	optional
└ fprPerObject	array	optional
└ avgPrecision	number	optional
└ precisionRecallCurve	object	optional
└ recall	array	optional
└ precision	array	optional
└ thresholds	array	optional
└ metricsByClass	array	optional
└ f1	number	optional
└ iou	number	optional
└ numNeg	integer	optional
└ numPos	integer	optional
└ numTot	integer	optional
└ rocAuc	number	optional
└ areaMax	number	optional
└ areaMin	number	optional
└ concept	object	optional
└ id	string	optional
└ name	string	optional
└ appId	string	optional
└ value	number	optional
└ userId	string	optional
└ vocabId	string	optional
└ language	string	optional
└ createdAt	string	optional
└ extraInfo	object	optional
└ definition	string	optional
└ visibility	object	optional
└ keypointInfo	object	optional
└ areaName	string	optional
└ rocCurve	object	optional
└ fpr	array	optional
└ tpr	array	optional
└ thresholds	array	optional
└ fprPerImage	array	optional
└ fprPerObject	array	optional
└ avgPrecision	number	optional
└ precisionRecallCurve	object	optional
└ recall	array	optional
└ precision	array	optional
└ thresholds	array	optional
└ trackerMetrics	array	optional
└ aiid	string	optional
└ motMota	number	optional
└ morseFrag	number	optional
└ avgPrecision	number	optional
└ motNumSwitches	integer	optional
└ uniqueSwitchRate	number	optional
└ confusionMatrix	object	optional
└ matrix	array	optional
└ value	number	optional
└ actual	string	optional
└ predicted	string	optional
└ actualConcept	object	optional
└ predictedConcept	object	optional
└ conceptIds	array	optional
└ extendedMetrics	object	optional
└ userMetrics	object	optional
└ cooccurrenceMatrix	object	optional
└ matrix	array	optional
└ col	string	optional
└ row	string	optional
└ count	integer	optional
└ conceptIds	array	optional
└ groundTruthDataset	object	optional
└ id	string	optional
└ appId	string	optional
└ image	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ imageInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ id	string	optional
└ appId	string	optional
└ status	object	optional
└ userId	string	optional
└ metrics	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ datasetId	string	optional
└ exportInfo	object	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ description	string	optional
└ processingInfo	object	optional
└ modelPredictConfig	object	optional
└ embedModelVersionIds	array	optional
└ annotationFilterConfig	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ bookmarkOrigin	object	optional
└ id	string	optional
└ appId	string	optional
└ userId	string	optional
└ resourceType	string	optional
└ defaultProcessingInfo	object	optional
└ frameInterpolationInfo	object	optional
└ defaultAnnotationFilter	object	optional
└ id	string	optional
└ appId	string	optional
└ search	object	optional
└ userId	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ predictionsDataset	object	optional
└ id	string	optional
└ appId	string	optional
└ image	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ imageInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ id	string	optional
└ appId	string	optional
└ status	object	optional
└ userId	string	optional
└ metrics	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ datasetId	string	optional
└ exportInfo	object	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ description	string	optional
└ processingInfo	object	optional
└ modelPredictConfig	object	optional
└ embedModelVersionIds	array	optional
└ annotationFilterConfig	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ bookmarkOrigin	object	optional
└ id	string	optional
└ appId	string	optional
└ userId	string	optional
└ resourceType	string	optional
└ defaultProcessingInfo	object	optional
└ frameInterpolationInfo	object	optional
└ defaultAnnotationFilter	object	optional
└ id	string	optional
└ appId	string	optional
└ search	object	optional
└ userId	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/models/{modelId}/versions/{modelVersionId}/evaluations

GET /v2/models/{modelId}/versions/{modelVersionId}/evaluations/{evaluationId} Deprecated, use GetEvaluation instead Get an evaluation metrics for a model version.

operationId: V2_GetModelVersionEvaluation2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—
modelVersionId	path	required	string	—
evaluationId	path	required	string	—
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
fields.confusionMatrix	query	optional	boolean	—
fields.cooccurrenceMatrix	query	optional	boolean	—
fields.labelCounts	query	optional	boolean	—
fields.binaryMetrics	query	optional	boolean	—
fields.testSet	query	optional	boolean	—
fields.metricsByArea	query	optional	boolean	—
fields.metricsByClass	query	optional	boolean	—

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/models/{modelId}/versions/{modelVersionId}/evaluations/{evaluationId}

GET /v2/models/{modelId}/versions/{modelVersionId}/input_examples ListModelVersionInputExamples

operationId: V2_ListModelVersionInputExamples2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	id of model the example belongs to
modelVersionId	path	required	string	specific version the example belongs to
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
page	query	optional	integer	Optional, defaults to 1.
perPage	query	optional	integer	Optional, defaults to 128 references per page.

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/models/{modelId}/versions/{modelVersionId}/input_examples

GET /v2/models/{modelId}/versions/{modelVersionId}/input_examples/{exampleId} GetModelVersionInputExample

operationId: V2_GetModelVersionInputExample2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	id of model the example belongs to
modelVersionId	path	required	string	specific version the example belongs to
exampleId	path	required	string	Id of example to fetch
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/models/{modelId}/versions/{modelVersionId}/input_examples/{exampleId}

DELETE /v2/models/{modelId}/versions/{versionId} Delete a single model.

operationId: V2_DeleteModelVersion2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—
versionId	path	required	string	—
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—

Responses

default

An unexpected error response.

200

A successful response.

DELETE /v2/models/{modelId}/versions/{versionId}

GET /v2/models/{modelId}/versions/{versionId} Get a specific model from an app.

operationId: V2_GetModelVersion2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—
versionId	path	required	string	—
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/models/{modelId}/versions/{versionId}

GET /v2/models/{modelId}/versions/{versionId}/exports GetModelVersionExport

operationId: V2_GetModelVersionExport2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—
versionId	path	required	string	—
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/models/{modelId}/versions/{versionId}/exports

PUT /v2/models/{modelId}/versions/{versionId}/exports Export a model

operationId: V2_PutModelVersionExports2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—
versionId	path	required	string	—
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—

Responses

default

An unexpected error response.

200

A successful response.

PUT /v2/models/{modelId}/versions/{versionId}/exports

GET /v2/models/{modelId}/versions/{versionId}/inputs Deprecated: Unmaintained and ideally replaced with usage of datasets

operationId: V2_ListModelInputs4

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—
versionId	path	required	string	—
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
page	query	optional	integer	(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.
perPage	query	optional	integer	(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/models/{modelId}/versions/{versionId}/inputs

GET /v2/models/{modelId}/versions/{versionId}/metrics Deprecated: Use GetEvaluation instead Get the evaluation metrics for a model version.

operationId: V2_GetModelVersionMetrics2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—
versionId	path	required	string	—
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
fields.confusionMatrix	query	optional	boolean	—
fields.cooccurrenceMatrix	query	optional	boolean	—
fields.labelCounts	query	optional	boolean	—
fields.binaryMetrics	query	optional	boolean	—
fields.testSet	query	optional	boolean	—
fields.metricsByArea	query	optional	boolean	—
fields.metricsByClass	query	optional	boolean	—

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/models/{modelId}/versions/{versionId}/metrics

POST /v2/models/{modelId}/versions/{versionId}/metrics Deprecated, use PostEvaluations instead Run the evaluation metrics for a model version.

operationId: V2_PostModelVersionMetrics2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—
versionId	path	required	string	—

Request Body

required

application/json

schema V2PostModelVersionMetrics2Request

Property	Type	Required
evalInfo	object	optional
└ params	object	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
testSearch	object	optional
└ id	string	optional
└ asOf	string	optional
└ name	string	optional
└ save	boolean	optional
└ query	object	optional
└ ands	array	optional
└ input	object	optional
└ negate	boolean	optional
└ output	object	optional
└ annotation	object	optional
└ ranks	array	optional
└ negate	boolean	optional
└ annotation	object	optional
└ filters	array	optional
└ input	object	optional
└ negate	boolean	optional
└ annotation	object	optional
└ lastUpdatedTimeRange	object	optional
└ language	string	optional
└ metric	string	optional
└ gitHash	string	optional
└ minValue	number	optional
└ algorithm	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ applicationId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/models/{modelId}/versions/{versionId}/metrics

GET /v2/models/{modelId}/versions/{versionId}/output_info Get a the output info for a given model_id or model_id/version_id combo.

operationId: V2_GetModelOutputInfo4

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—
versionId	path	required	string	This is included so that we can re-use this request for multiple rpcs with and without the version_id.
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
language	query	optional	string	—
trainedBefore	query	optional	boolean	—
additionalFields	query	optional	array	(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars, outputs, presets

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/models/{modelId}/versions/{versionId}/output_info

POST /v2/models/{modelId}/versions/{versionId}/outputs Get predicted outputs from the model.

operationId: V2_PostModelOutputs2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—
versionId	path	required	string	—

Request Body

required

application/json

schema V2PostModelOutputs2Request

Property	Type	Required
model	object	optional
└ id	string	optional
└ name	string	optional
└ task	string	optional
└ appId	string	optional
└ image	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ imageInfo	object	optional
└ width	integer	optional
└ format	string	optional
└ height	integer	optional
└ colorMode	string	optional
└ allowDuplicateUrl	boolean	optional
└ notes	string	optional
└ userId	string	optional
└ presets	object	optional
└ metadata	object	optional
└ toolkits	array	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ languages	array	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ outputInfo	object	optional
└ data	object	optional
└ geo	object	optional
└ hits	array	optional
└ text	object	optional
└ audio	object	optional
└ image	object	optional
└ video	object	optional
└ colors	array	optional
└ frames	array	optional
└ tracks	array	optional
└ regions	array	optional
└ clusters	array	optional
└ concepts	array	optional
└ heatmaps	array	optional
└ metadata	object	optional
└ embeddings	array	optional
└ timeSegments	array	optional
└ params	object	optional
└ message	string	optional
└ fieldsMap	object	optional
└ paramsSpecs	array	optional
└ path	string	optional
└ required	boolean	optional
└ fieldType	string	optional
└ description	string	optional
└ placeholder	string	optional
└ defaultValue	object	optional
└ internalOnly	boolean	optional
└ modelTypeRangeInfo	object	optional
└ modelTypeEnumOptions	array	optional
└ outputConfig	object	optional
└ language	string	optional
└ minValue	number	optional
└ sampleMs	integer	optional
└ hyperParams	object	optional
└ maxConcepts	integer	optional
└ modelMetadata	object	optional
└ selectConcepts	array	optional
└ existingModelId	string	optional
└ hyperParameters	string	optional
└ trainingTimeout	integer	optional
└ embedModelVersionId	string	optional
└ conceptsMutuallyExclusive	boolean	optional
└ failOnMissingPositiveExamples	boolean	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ displayName	string	optional
└ …7 more	object	optional
inputs	array	optional
└ id	string	optional
└ data	object	optional
└ geo	object	optional
└ geoBox	array	optional
└ geoLimit	object	optional
└ geoPoint	object	optional
└ hits	array	optional
└ appId	string	optional
└ input	object	optional
└ score	number	optional
└ userId	string	optional
└ annotation	object	optional
└ text	object	optional
└ raw	string	optional
└ url	string	optional
└ hosted	object	optional
└ textInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ audio	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ audioInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ image	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ imageInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ video	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ videoInfo	object	optional
└ thumbnailUrl	string	optional
└ hostedThumbnail	object	optional
└ allowDuplicateUrl	boolean	optional
└ colors	array	optional
└ w3c	object	optional
└ value	number	optional
└ rawHex	string	optional
└ frames	array	optional
└ id	string	optional
└ data	object	optional
└ frameInfo	object	optional
└ tracks	array	optional
└ id	string	optional
└ data	object	optional
└ quality	number	optional
└ timeInfo	object	optional
└ regions	array	optional
└ id	string	optional
└ data	object	optional
└ value	number	optional
└ trackId	string	optional
└ regionInfo	object	optional
└ clusters	array	optional
└ id	string	optional
└ hits	array	optional
└ count	integer	optional
└ score	number	optional
└ projection	array	optional
└ concepts	array	optional
└ id	string	optional
└ name	string	optional
└ appId	string	optional
└ value	number	optional
└ userId	string	optional
└ vocabId	string	optional
└ language	string	optional
└ createdAt	string	optional
└ extraInfo	object	optional
└ definition	string	optional
└ visibility	object	optional
└ keypointInfo	object	optional
└ heatmaps	array	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ imageInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ metadata	object	optional
└ embeddings	array	optional
└ vector	array	optional
└ numDimensions	integer	optional
└ timeSegments	array	optional
└ id	string	optional
└ data	object	optional
└ timeInfo	object	optional
└ status	object	optional
└ code	string	optional
└ reqId	string	optional
└ details	string	optional
└ stackTrace	array	optional
└ description	string	optional
└ redirectInfo	object	optional
└ url	string	optional
└ resourceType	string	optional
└ newResourceId	string	optional
└ oldResourceId	string	optional
└ timeRemaining	integer	optional
└ developerNotes	string	optional
└ internalDetails	string	optional
└ percentCompleted	integer	optional
└ createdAt	string	optional
└ datasetIds	array	optional
└ modifiedAt	string	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
runnerSelector	object	optional
└ runner	object	optional
└ id	string	optional
└ model	object	optional
└ id	string	optional
└ name	string	optional
└ task	string	optional
└ appId	string	optional
└ image	object	optional
└ notes	string	optional
└ userId	string	optional
└ presets	object	optional
└ metadata	object	optional
└ toolkits	array	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ languages	array	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ outputInfo	object	optional
└ visibility	object	optional
└ description	string	optional
└ displayName	string	optional
└ …7 more	object	optional
└ labels	array	optional
└ userId	string	optional
└ metadata	object	optional
└ nodepool	object	optional
└ id	string	optional
└ userId	string	optional
└ cloudRegion	object	optional
└ maxInstances	integer	optional
└ minInstances	integer	optional
└ capacityTypes	array	optional
└ instanceTypes	array	optional
└ workflow	object	optional
└ id	string	optional
└ appId	string	optional
└ image	object	optional
└ nodes	array	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ metadata	object	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ description	string	optional
└ checkConsents	array	optional
└ bookmarkOrigin	object	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ computeInfo	object	optional
└ numCpus	integer	optional
└ cpuMemory	string	optional
└ acceleratorType	array	optional
└ numAccelerators	integer	optional
└ acceleratorMemory	string	optional
└ description	string	optional
└ nodepool	object	optional
└ id	string	optional
└ userId	string	optional
└ cloudRegion	object	optional
└ id	string	optional
└ cloud	string	optional
└ region	string	optional
└ maxInstances	integer	optional
└ minInstances	integer	optional
└ capacityTypes	array	optional
└ instanceTypes	array	optional
└ deployment	object	optional
└ id	string	optional
└ model	object	optional
└ id	string	optional
└ name	string	optional
└ task	string	optional
└ appId	string	optional
└ image	object	optional
└ notes	string	optional
└ userId	string	optional
└ presets	object	optional
└ metadata	object	optional
└ toolkits	array	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ languages	array	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ outputInfo	object	optional
└ visibility	object	optional
└ description	string	optional
└ displayName	string	optional
└ …7 more	object	optional
└ userId	string	optional
└ workflow	object	optional
└ id	string	optional
└ appId	string	optional
└ image	object	optional
└ nodes	array	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ metadata	object	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ description	string	optional
└ checkConsents	array	optional
└ bookmarkOrigin	object	optional
└ nodepools	array	optional
└ id	string	optional
└ userId	string	optional
└ cloudRegion	object	optional
└ maxInstances	integer	optional
└ minInstances	integer	optional
└ capacityTypes	array	optional
└ instanceTypes	array	optional
└ autoscaleConfig	object	optional
└ maxReplicas	integer	optional
└ minReplicas	integer	optional
└ enablePacking	boolean	optional
└ scaleUpDelaySeconds	integer	optional
└ scaleDownDelaySeconds	integer	optional
└ trafficHistorySeconds	integer	optional
└ schedulingChoice	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/models/{modelId}/versions/{versionId}/outputs

GET /v2/modules List all the modules in community, by user or by app.

operationId: V2_ListModules3

Parameters

Name	In	Required	Type	Description
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
page	query	optional	integer	(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.
perPage	query	optional	integer	(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.
additionalFields	query	optional	array	—
sortAscending	query	optional	boolean	Sorting options: Whether to sort in ascending order. If false, will order in descending order.
sortByCreatedAt	query	optional	boolean	Whether to order by the created_at time.
sortByStarCount	query	optional	boolean	Whether to order by the number of users stared the app
sortByModifiedAt	query	optional	boolean	If neither sort option is set to true, will sort by modified_at.
sortById	query	optional	boolean	Whether to order by the external id
starredOnly	query	optional	boolean	Filtering options:
bookmark	query	optional	boolean	Filter modules by bookmark. If set, only return bookmarked modules. Otherwise none bookmarked modules only.
search	query	optional	string	Searching options: Specify a search parameter in order to perform keyword search on the following fields of the module: id description user_id (unless user_app_id.user_id is already set) Keywords are both normalized for search (so searching for “satisfy” matches “satisfied”) and used for partial prefix-matching (so searching for “clari” matches “clarifai”). NOTE: Both the list of fields searched and the exact keyword matching rules are subject to change and not guaranteed to be backwards-compatible.
name	query	optional	string	Filter by the id and description of the module. This supports wildcard queries like “gen*” to match “general” as an example. Deprecated: use search instead.
filterByUserId	query	optional	boolean	Filter by the application owner whose this module belongs to Deprecated: use search instead of name.

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/modules

GET /v2/my_scopes API Keys in the public API -- request is itself Key authorized, and will tell the user the scopes/access of the key/credential they're providing, as computed by our authorizer:

operationId: V2_MyScopes3

Parameters

Name	In	Required	Type	Description
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/my_scopes

GET /v2/myscopes API Keys in the public API -- request is itself Key authorized, and will tell the user the scopes/access of the key/credential they're providing, as computed by our authorizer:

operationId: V2_MyScopes2

Parameters

Name	In	Required	Type	Description
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/myscopes

GET /v2/myscopesroot

operationId: V2_MyScopesRoot

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/myscopesroot

GET /v2/open_source_licenses List all the supported open source licenses in the platform.

operationId: V2_ListOpenSourceLicenses

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/open_source_licenses

GET /v2/resource_counts List the resource counts for the app.

operationId: V2_GetResourceCounts2

Parameters

Name	In	Required	Type	Description
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/resource_counts

GET /v2/searches List all saved legacy searches.

operationId: V2_ListSearches2

Parameters

Name	In	Required	Type	Description
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
page	query	optional	integer	(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.
perPage	query	optional	integer	(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/searches

PATCH /v2/searches Patch saved legacy searches by ids.

operationId: V2_PatchSearches2

Request Body

required

application/json

schema apiPatchSearchesRequest

Property	Type	Required
action	string	optional
searches	array	optional
└ id	string	optional
└ asOf	string	optional
└ name	string	optional
└ save	boolean	optional
└ query	object	optional
└ ands	array	optional
└ input	object	optional
└ negate	boolean	optional
└ output	object	optional
└ annotation	object	optional
└ ranks	array	optional
└ negate	boolean	optional
└ annotation	object	optional
└ filters	array	optional
└ input	object	optional
└ negate	boolean	optional
└ annotation	object	optional
└ lastUpdatedTimeRange	object	optional
└ language	string	optional
└ metric	string	optional
└ gitHash	string	optional
└ minValue	number	optional
└ algorithm	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ applicationId	string	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/searches

POST /v2/searches Execute a new search and optionally save it.

Deprecated: Use PostInputsSearches or PostAnnotationsSearches instead.

operationId: V2_PostSearches2

Request Body

required

application/json

schema apiPostSearchesRequest

Property	Type	Required
query	object	optional
└ ands	array	optional
└ input	object	optional
└ id	string	optional
└ data	object	optional
└ status	object	optional
└ createdAt	string	optional
└ datasetIds	array	optional
└ modifiedAt	string	optional
└ negate	boolean	optional
└ output	object	optional
└ id	string	optional
└ data	object	optional
└ input	object	optional
└ model	object	optional
└ status	object	optional
└ createdAt	string	optional
└ annotation	object	optional
└ id	string	optional
└ data	object	optional
└ status	object	optional
└ taskId	string	optional
└ userId	string	optional
└ inputId	string	optional
└ trusted	boolean	optional
└ createdAt	string	optional
└ inputLevel	boolean	optional
└ modifiedAt	string	optional
└ consensusInfo	object	optional
└ annotationInfo	object	optional
└ modelVersionId	string	optional
└ workflowVersionId	string	optional
└ embedModelVersionId	string	optional
└ ranks	array	optional
└ negate	boolean	optional
└ annotation	object	optional
└ id	string	optional
└ data	object	optional
└ status	object	optional
└ taskId	string	optional
└ userId	string	optional
└ inputId	string	optional
└ trusted	boolean	optional
└ createdAt	string	optional
└ inputLevel	boolean	optional
└ modifiedAt	string	optional
└ consensusInfo	object	optional
└ annotationInfo	object	optional
└ modelVersionId	string	optional
└ workflowVersionId	string	optional
└ embedModelVersionId	string	optional
└ filters	array	optional
└ input	object	optional
└ id	string	optional
└ data	object	optional
└ status	object	optional
└ createdAt	string	optional
└ datasetIds	array	optional
└ modifiedAt	string	optional
└ negate	boolean	optional
└ annotation	object	optional
└ id	string	optional
└ data	object	optional
└ status	object	optional
└ taskId	string	optional
└ userId	string	optional
└ inputId	string	optional
└ trusted	boolean	optional
└ createdAt	string	optional
└ inputLevel	boolean	optional
└ modifiedAt	string	optional
└ consensusInfo	object	optional
└ annotationInfo	object	optional
└ modelVersionId	string	optional
└ workflowVersionId	string	optional
└ embedModelVersionId	string	optional
└ lastUpdatedTimeRange	object	optional
└ endTime	string	optional
└ startTime	string	optional
└ language	string	optional
searches	array	optional
└ id	string	optional
└ asOf	string	optional
└ name	string	optional
└ save	boolean	optional
└ query	object	optional
└ ands	array	optional
└ input	object	optional
└ negate	boolean	optional
└ output	object	optional
└ annotation	object	optional
└ ranks	array	optional
└ negate	boolean	optional
└ annotation	object	optional
└ filters	array	optional
└ input	object	optional
└ negate	boolean	optional
└ annotation	object	optional
└ lastUpdatedTimeRange	object	optional
└ language	string	optional
└ metric	string	optional
└ gitHash	string	optional
└ minValue	number	optional
└ algorithm	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ applicationId	string	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
pagination	object	optional
└ page	integer	optional
└ perPage	integer	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/searches

DELETE /v2/searches/{id} Delete a saved search.

operationId: V2_DeleteSearch2

Parameters

Name	In	Required	Type	Description
id	path	required	string	—
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—

Responses

default

An unexpected error response.

200

A successful response.

DELETE /v2/searches/{id}

GET /v2/searches/{id} Get a saved legacy search.

operationId: V2_GetSearch2

Parameters

Name	In	Required	Type	Description
id	path	required	string	—
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/searches/{id}

POST /v2/searches/{id} Execute a previously saved legacy search.

operationId: V2_PostSearchesByID2

Parameters

Name	In	Required	Type	Description
id	path	required	string	ID for saves search to be executed

Request Body

required

application/json

schema V2PostSearchesById2Request

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
pagination	object	optional
└ page	integer	optional
└ perPage	integer	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/searches/{id}

POST /v2/stats/values PostStatValues

operationId: V2_PostStatValues2

Request Body

required

application/json

schema apiPostStatValuesRequest

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
statValues	array	optional
└ tags	array	optional
└ time	string	optional
└ value	number	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/stats/values

POST /v2/stats/values/aggregate PostStatValuesAggregate

operationId: V2_PostStatValuesAggregate2

Request Body

required

application/json

schema apiPostStatValuesAggregateRequest

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
statValueAggregateQueries	array	optional
└ tags	array	optional
└ endTime	string	optional
└ startTime	string	optional
└ tagGroups	array	optional
└ statTimeAggType	string	optional
└ statValueAggType	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/stats/values/aggregate

GET /v2/status_codes List all status codes.

operationId: V2_ListStatusCodes

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/status_codes

GET /v2/status_codes/{statusCodeId} Get more details for a status code.

operationId: V2_GetStatusCode

Parameters

Name	In	Required	Type	Description
statusCodeId	path	required	string	—

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/status_codes/{statusCodeId}

DELETE /v2/tasks Delete multiple tasks in one request.

operationId: V2_DeleteTasks2

Request Body

required

Request to delete a list of tasks.

application/json

schema apiDeleteTasksRequest

Property	Type	Required
ids	array	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

DELETE /v2/tasks

GET /v2/tasks List tasks from an app.

operationId: V2_ListTasks2

Parameters

Name	In	Required	Type	Description
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
page	query	optional	integer	(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.
perPage	query	optional	integer	(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.
workerUserIds	query	optional	array	Get tasks that have ANY user from this list assigned as worker.
reviewUserIds	query	optional	array	Get tasks that have ANY user from this list assigned as reviewer.
labelOrderIds	query	optional	array	Get tasks that are associated to ANY label order from this list.
includingLabelOrderTasks	query	optional	boolean	Get label order tasks as well It is automatically set to true if label_order_ids is set.
additionalFields	query	optional	array	(optional URL parameter) List of additional fields to be included in the response. Currently supported additional fields: all worker.users review.users metrics.work.inputs_count_estimated metrics.work.inputs_percent_estimated
ids	query	optional	array	(optional) task IDs to filter on

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/tasks

PATCH /v2/tasks Patch one or more tasks.

operationId: V2_PatchTasks2

Request Body

required

Request to patch a list of tasks.

application/json

schema apiPatchTasksRequest

Property	Type	Required
tasks	array	optional
└ id	string	optional
└ name	string	optional
└ type	string	optional
└ appId	string	optional
└ review	object	optional
└ users	array	optional
└ id	string	optional
└ jobRole	string	optional
└ billType	string	optional
└ jobTitle	string	optional
└ lastName	string	optional
└ metadata	object	optional
└ createdAt	string	optional
└ firstName	string	optional
└ intention	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ teamsCount	integer	optional
└ userDetail	object	optional
└ visibility	object	optional
└ companyName	string	optional
└ primaryEmail	string	optional
└ datePiiConsent	string	optional
└ dateTosConsent	string	optional
└ emailAddresses	array	optional
└ dateGdprConsent	string	optional
└ …2 more	object	optional
└ userIds	array	optional
└ strategy	string	optional
└ manualStrategyInfo	object	optional
└ samplePercentage	number	optional
└ consensusStrategyInfo	object	optional
└ approvalThreshold	integer	optional
└ status	object	optional
└ code	string	optional
└ reqId	string	optional
└ details	string	optional
└ stackTrace	array	optional
└ description	string	optional
└ redirectInfo	object	optional
└ url	string	optional
└ resourceType	string	optional
└ newResourceId	string	optional
└ oldResourceId	string	optional
└ timeRemaining	integer	optional
└ developerNotes	string	optional
└ internalDetails	string	optional
└ percentCompleted	integer	optional
└ userId	string	optional
└ worker	object	optional
└ users	array	optional
└ id	string	optional
└ jobRole	string	optional
└ billType	string	optional
└ jobTitle	string	optional
└ lastName	string	optional
└ metadata	object	optional
└ createdAt	string	optional
└ firstName	string	optional
└ intention	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ teamsCount	integer	optional
└ userDetail	object	optional
└ visibility	object	optional
└ companyName	string	optional
└ primaryEmail	string	optional
└ datePiiConsent	string	optional
└ dateTosConsent	string	optional
└ emailAddresses	array	optional
└ dateGdprConsent	string	optional
└ …2 more	object	optional
└ userIds	array	optional
└ workers	array	optional
└ user	object	optional
└ model	object	optional
└ workflow	object	optional
└ strategy	string	optional
└ partitionedStrategyInfo	object	optional
└ type	string	optional
└ weights	object	optional
└ workersPerInput	integer	optional
└ metrics	object	optional
└ work	object	optional
└ inputsCountEstimated	string	optional
└ inputsPercentEstimated	integer	optional
└ concepts	array	optional
└ concept	object	optional
└ id	string	optional
└ name	string	optional
└ appId	string	optional
└ value	number	optional
└ userId	string	optional
└ vocabId	string	optional
└ language	string	optional
└ createdAt	string	optional
└ extraInfo	object	optional
└ definition	string	optional
└ visibility	object	optional
└ keypointInfo	object	optional
└ autoAnnotationConfig	object	optional
└ statusCode	string	optional
└ thresholdRange	object	optional
└ annotationDataTypes	integer	optional
└ sampleMs	integer	optional
└ createdAt	string	optional
└ conceptIds	array	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ aiAssistant	object	optional
└ workflowId	string	optional
└ description	string	optional
└ inputSource	object	optional
└ id	string	optional
└ type	string	optional
└ labelOrderId	string	optional
└ aiAssistParams	object	optional
└ maxThreshold	number	optional
└ minThreshold	number	optional
└ conceptRelationIds	array	optional
└ …1 more	object	optional
action	string	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/tasks

POST /v2/tasks Add tasks to an app.

operationId: V2_PostTasks2

Request Body

required

Request to create Tasks.

application/json

schema apiPostTasksRequest

Property	Type	Required
tasks	array	optional
└ id	string	optional
└ name	string	optional
└ type	string	optional
└ appId	string	optional
└ review	object	optional
└ users	array	optional
└ id	string	optional
└ jobRole	string	optional
└ billType	string	optional
└ jobTitle	string	optional
└ lastName	string	optional
└ metadata	object	optional
└ createdAt	string	optional
└ firstName	string	optional
└ intention	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ teamsCount	integer	optional
└ userDetail	object	optional
└ visibility	object	optional
└ companyName	string	optional
└ primaryEmail	string	optional
└ datePiiConsent	string	optional
└ dateTosConsent	string	optional
└ emailAddresses	array	optional
└ dateGdprConsent	string	optional
└ …2 more	object	optional
└ userIds	array	optional
└ strategy	string	optional
└ manualStrategyInfo	object	optional
└ samplePercentage	number	optional
└ consensusStrategyInfo	object	optional
└ approvalThreshold	integer	optional
└ status	object	optional
└ code	string	optional
└ reqId	string	optional
└ details	string	optional
└ stackTrace	array	optional
└ description	string	optional
└ redirectInfo	object	optional
└ url	string	optional
└ resourceType	string	optional
└ newResourceId	string	optional
└ oldResourceId	string	optional
└ timeRemaining	integer	optional
└ developerNotes	string	optional
└ internalDetails	string	optional
└ percentCompleted	integer	optional
└ userId	string	optional
└ worker	object	optional
└ users	array	optional
└ id	string	optional
└ jobRole	string	optional
└ billType	string	optional
└ jobTitle	string	optional
└ lastName	string	optional
└ metadata	object	optional
└ createdAt	string	optional
└ firstName	string	optional
└ intention	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ teamsCount	integer	optional
└ userDetail	object	optional
└ visibility	object	optional
└ companyName	string	optional
└ primaryEmail	string	optional
└ datePiiConsent	string	optional
└ dateTosConsent	string	optional
└ emailAddresses	array	optional
└ dateGdprConsent	string	optional
└ …2 more	object	optional
└ userIds	array	optional
└ workers	array	optional
└ user	object	optional
└ model	object	optional
└ workflow	object	optional
└ strategy	string	optional
└ partitionedStrategyInfo	object	optional
└ type	string	optional
└ weights	object	optional
└ workersPerInput	integer	optional
└ metrics	object	optional
└ work	object	optional
└ inputsCountEstimated	string	optional
└ inputsPercentEstimated	integer	optional
└ concepts	array	optional
└ concept	object	optional
└ id	string	optional
└ name	string	optional
└ appId	string	optional
└ value	number	optional
└ userId	string	optional
└ vocabId	string	optional
└ language	string	optional
└ createdAt	string	optional
└ extraInfo	object	optional
└ definition	string	optional
└ visibility	object	optional
└ keypointInfo	object	optional
└ autoAnnotationConfig	object	optional
└ statusCode	string	optional
└ thresholdRange	object	optional
└ annotationDataTypes	integer	optional
└ sampleMs	integer	optional
└ createdAt	string	optional
└ conceptIds	array	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ aiAssistant	object	optional
└ workflowId	string	optional
└ description	string	optional
└ inputSource	object	optional
└ id	string	optional
└ type	string	optional
└ labelOrderId	string	optional
└ aiAssistParams	object	optional
└ maxThreshold	number	optional
└ minThreshold	number	optional
└ conceptRelationIds	array	optional
└ …1 more	object	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/tasks

GET /v2/tasks/{taskId} Get a specific task from an app.

operationId: V2_GetTask2

Parameters

Name	In	Required	Type	Description
taskId	path	required	string	—
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
additionalFields	query	optional	array	(optional URL parameter) List of additional fields to be included in the response. Currently supported additional fields: all worker.users review.users metrics.work.inputs_count_estimated metrics.work.inputs_percent_estimated

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/tasks/{taskId}

GET /v2/tasks/{taskId}/annotations/count Task annotation count

operationId: V2_GetTaskAnnotationCount2

Parameters

Name	In	Required	Type	Description
taskId	path	required	string	task_id for which count per user per status is needed
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
userIds	query	optional	array	for given task_id, user_ids to filter on (optional)

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/tasks/{taskId}/annotations/count

GET /v2/tasks/{taskId}/assignments List next non-labeled and unassigned inputs from task's dataset

operationId: V2_ListNextTaskAssignments2

Parameters

Name	In	Required	Type	Description
taskId	path	required	string	—
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/tasks/{taskId}/assignments

GET /v2/tasks/{taskId}/inputs/count Task Input count

operationId: V2_GetTaskInputCount2

Parameters

Name	In	Required	Type	Description
taskId	path	required	string	task_id for which count per user per status is needed
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
userIds	query	optional	array	for given task_id, user_ids to filter on (optional)

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/tasks/{taskId}/inputs/count

GET /v2/tasks/{taskId}/inputs/samples Get a specific input from an app.

operationId: V2_GetInputSamples2

Parameters

Name	In	Required	Type	Description
taskId	path	required	string	—
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
userIds	query	optional	array	URL param. If zero ids provided, returns for all task labelers

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/tasks/{taskId}/inputs/samples

GET /v2/trending_metrics/views/{viewType} List the view metrics for a detail view

operationId: V2_ListTrendingMetricsViews2

Parameters

Name	In	Required	Type	Description
viewType	path	required	string	For now view types ‘apps’, ‘workflows’, and ‘models’ are supported.
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
page	query	optional	integer	(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.
perPage	query	optional	integer	(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/trending_metrics/views/{viewType}

V2 50 endpoints

Parameters

Responses

Parameters

Request Body

Responses

Parameters

Request Body

Responses

Parameters

Responses

Parameters

Request Body

Responses

Parameters

Request Body

Responses

Parameters

Request Body

Responses

Parameters

Responses

Parameters

Request Body

Responses

Parameters

Request Body

Responses

Parameters

Responses

Parameters

Request Body

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Parameters

Request Body

Responses

Parameters

Responses

Parameters

Request Body

Responses

Parameters

Responses

Parameters

Responses

Parameters

Responses

Responses

Responses

Parameters

Responses

Parameters

Responses

Request Body

Responses

Request Body

Responses

Parameters

Responses

Parameters

Responses

Parameters