proto/clarifai/api/service.proto

AI computer vision platform

docs.clarifai.com ↗

Version

version not set

OpenAPI

3.0.0

Endpoints

400

Schemas

543

73

Quality

Updated

3 days ago

Ai ai computer-vision machine-learning

Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

api.clarifia.com

Endpoints

Clear filters

GET POST PUT PATCH DELETE

V2 103 endpoints

POST /v2/annotation_filters Add annotation filters.

operationId: V2_PostAnnotationFilters2

Request Body

required

Request to add one or more annotation filters.

application/json

schema apiPostAnnotationFiltersRequest

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
annotationFilters	array	optional
└ id	string	optional
└ appId	string	optional
└ search	object	optional
└ id	string	optional
└ asOf	string	optional
└ name	string	optional
└ save	boolean	optional
└ query	object	optional
└ ands	array	optional
└ ranks	array	optional
└ filters	array	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
└ userId	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/annotation_filters

POST /v2/annotations Post annotations.

operationId: V2_PostAnnotations2

Request Body

required

application/json

schema apiPostAnnotationsRequest

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
annotations	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
└ 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

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/annotations

POST /v2/annotations/searches Execute a search over annotations

operationId: V2_PostAnnotationsSearches2

Request Body

required

application/json

schema apiPostAnnotationsSearchesRequest

Property	Type	Required
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/annotations/searches

POST /v2/annotations/searches/metrics Evaluate the results of two search requests

operationId: V2_PostAnnotationSearchMetrics2

Request Body

required

application/json

schema apiPostAnnotationSearchMetricsRequest

Property	Type	Required
id	string	optional
data	object	optional
└ geo	object	optional
└ geoBox	array	optional
└ geoPoint	object	optional
└ geoLimit	object	optional
└ type	string	optional
└ value	number	optional
└ geoPoint	object	optional
└ latitude	number	optional
└ longitude	number	optional
└ hits	array	optional
└ appId	string	optional
└ input	object	optional
└ id	string	optional
└ data	object	optional
└ status	object	optional
└ createdAt	string	optional
└ datasetIds	array	optional
└ modifiedAt	string	optional
└ score	number	optional
└ userId	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
└ text	object	optional
└ raw	string	optional
└ url	string	optional
└ hosted	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ textInfo	object	optional
└ encoding	string	optional
└ charCount	integer	optional
└ allowDuplicateUrl	boolean	optional
└ audio	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ audioInfo	object	optional
└ bitRate	integer	optional
└ sampleRate	integer	optional
└ audioFormat	string	optional
└ durationSeconds	number	optional
└ allowDuplicateUrl	boolean	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
└ video	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ videoInfo	object	optional
└ fps	number	optional
└ width	integer	optional
└ height	integer	optional
└ bitRate	integer	optional
└ frameCount	integer	optional
└ videoFormat	string	optional
└ durationSeconds	number	optional
└ thumbnailUrl	string	optional
└ hostedThumbnail	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ allowDuplicateUrl	boolean	optional
└ colors	array	optional
└ w3c	object	optional
└ hex	string	optional
└ name	string	optional
└ value	number	optional
└ rawHex	string	optional
└ frames	array	optional
└ id	string	optional
└ data	object	optional
└ frameInfo	object	optional
└ time	integer	optional
└ index	integer	optional
└ tracks	array	optional
└ id	string	optional
└ data	object	optional
└ quality	number	optional
└ timeInfo	object	optional
└ endTime	number	optional
└ beginTime	number	optional
└ numFrames	integer	optional
└ regions	array	optional
└ id	string	optional
└ data	object	optional
└ value	number	optional
└ trackId	string	optional
└ regionInfo	object	optional
└ mask	object	optional
└ span	object	optional
└ point	object	optional
└ token	object	optional
└ polygon	object	optional
└ boundingBox	object	optional
└ keypointLocations	array	optional
└ clusters	array	optional
└ id	string	optional
└ hits	array	optional
└ appId	string	optional
└ input	object	optional
└ score	number	optional
└ userId	string	optional
└ annotation	object	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
└ isRankable	boolean	optional
└ definition	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ keypointInfo	object	optional
└ skeleton	array	optional
└ keypointNames	array	optional
└ heatmaps	array	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
└ metadata	object	optional
└ embeddings	array	optional
└ vector	array	optional
└ numDimensions	integer	optional
└ timeSegments	array	optional
└ id	string	optional
└ data	object	optional
└ timeInfo	object	optional
└ endTime	number	optional
└ beginTime	number	optional
└ numFrames	integer	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
groundTruth	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
searchToEval	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
evaluationType	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/annotations/searches/metrics

POST /v2/bulk_operations Perform bulk operations on a list of inputs based on input source. Operation include add, update, delete of concepts, metadata and geo data. This is an Asynchronous process. Use ListBulkOperations or GetBulkOperation to check the status.

operationId: V2_PostBulkOperations2

Request Body

required

Request to perform bulk operations on a list of inputs based on input source.

application/json

schema apiPostBulkOperationsRequest

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
bulkOperations	array	optional
└ id	string	optional
└ appId	string	optional
└ search	object	optional
└ id	string	optional
└ asOf	string	optional
└ name	string	optional
└ save	boolean	optional
└ query	object	optional
└ ands	array	optional
└ ranks	array	optional
└ filters	array	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
└ 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
└ dataset	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
└ inputIds	object	optional
└ inputIds	array	optional
└ progress	object	optional
└ processed	integer	optional
└ lastProcessedId	string	optional
└ createdAt	string	optional
└ createdBy	string	optional
└ operation	object	optional
└ deleteGeo	object	optional
└ addConcepts	object	optional
└ concepts	array	optional
└ addMetadata	object	optional
└ metadata	object	optional
└ addToDataset	object	optional
└ datasetId	string	optional
└ overwriteGeo	object	optional
└ geo	object	optional
└ deleteConcepts	object	optional
└ userIds	array	optional
└ concepts	array	optional
└ deleteMetadata	object	optional
└ metadata	object	optional
└ deleteFromDataset	object	optional
└ datasetId	string	optional
└ splitIntoDatasets	object	optional
└ method	string	optional
└ datasetSplits	array	optional
└ lastModifiedAt	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/bulk_operations

POST /v2/collectors Add a list of Collectors to an app. In the handler of this endpoint we also check for all the scopes of the POST /inputs endpoint. Those current scopes are listed here as a hard requirement. They are needed when adding the collectors just so we now that you have permission with that key at least to do the writing to this app with POST /inputs.

operationId: V2_PostCollectors2

Request Body

required

Request to create Collectors.

application/json

schema apiPostCollectorsRequest

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
collectors	array	optional
└ id	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
└ createdAt	string	optional
└ description	string	optional
└ collectOutputs	boolean	optional
└ collectorSource	object	optional
└ apiPostModelOutputsCollectorSource	object	optional
└ modelId	string	optional
└ modelAppId	string	optional
└ modelUserId	string	optional
└ callerUserId	string	optional
└ modelVersionId	string	optional
└ postInputsKeyId	string	optional
└ preQueueWorkflowId	string	optional
└ postQueueWorkflowId	string	optional
└ preQueueRandomSample	number	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/collectors

POST /v2/concepts Add a concept to an app.

operationId: V2_PostConcepts2

Request Body

required

application/json

schema apiPostConceptsRequest

Property	Type	Required
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
└ isRankable	boolean	optional
└ definition	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ keypointInfo	object	optional
└ skeleton	array	optional
└ k1	integer	optional
└ k2	integer	optional
└ keypointNames	array	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/concepts

POST /v2/concepts/knowledge_graphs Post domain graphs.

operationId: V2_PostKnowledgeGraphs2

Request Body

required

application/json

schema apiPostKnowledgeGraphsRequest

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
knowledgeGraphs	array	optional
└ id	string	optional
└ name	string	optional
└ description	string	optional
└ examplesAppId	string	optional
└ sampledExamplesAppId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/concepts/knowledge_graphs

POST /v2/concepts/mappings/jobs Start concept mapping jobs.

operationId: V2_PostConceptMappingJobs2

Request Body

required

application/json

schema apiPostConceptMappingJobsRequest

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
conceptMappingJobs	array	optional
└ conceptIds	array	optional
└ knowledgeGraphId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/concepts/mappings/jobs

POST /v2/concepts/searches Search over the concepts to find one or more you're looking for. This leverage the "body" parameter because we also have page and per_page as url query param variables in this request.

operationId: V2_PostConceptsSearches2

Request Body

required

application/json

schema apiPostConceptsSearchesRequest

Property	Type	Required
extraInfo	object	optional
└ rankableModel	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
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
pagination	object	optional
└ page	integer	optional
└ perPage	integer	optional
conceptQuery	object	optional
└ name	string	optional
└ language	string	optional
└ useCases	array	optional
└ workflowId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/concepts/searches

POST /v2/concepts/{conceptId}/languages Add a new translation for this concept.

operationId: V2_PostConceptLanguages2

Parameters

Name	In	Required	Type	Description
conceptId	path	required	string	—

Request Body

required

application/json

schema V2PostConceptLanguages2Request

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
conceptLanguages	array	optional
└ id	string	optional
└ name	string	optional
└ definition	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/concepts/{conceptId}/languages

POST /v2/datasets Add datasets to an app. The process is atomic, i.e. either all or no datasets are added. If there is an error for one dataset, the process will stop, revert the transaction and return the error.

operationId: V2_PostDatasets2

Request Body

required

Request to add one or more datasets.

application/json

schema apiPostDatasetsRequest

Property	Type	Required
datasets	array	optional
└ id	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
└ version	object	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
└ timeRemaining	integer	optional
└ developerNotes	string	optional
└ internalDetails	string	optional
└ percentCompleted	integer	optional
└ userId	string	optional
└ metrics	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ datasetId	string	optional
└ exportInfo	object	optional
└ coco	object	optional
└ clarifaiDataJson	object	optional
└ clarifaiDataProtobuf	object	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ processingInfo	object	optional
└ frameInterpolationInfo	object	optional
└ modelPredictConfig	object	optional
└ model	object	optional
└ embedModelVersionIds	array	optional
└ annotationFilterConfig	object	optional
└ annotationFilter	object	optional
└ ignoreEmptyInputs	boolean	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
└ sampleMs	integer	optional
└ defaultAnnotationFilter	object	optional
└ id	string	optional
└ appId	string	optional
└ search	object	optional
└ id	string	optional
└ asOf	string	optional
└ name	string	optional
└ save	boolean	optional
└ query	object	optional
└ metric	string	optional
└ gitHash	string	optional
└ minValue	number	optional
└ algorithm	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ applicationId	string	optional
└ userId	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/datasets

POST /v2/datasets/{datasetId}/inputs Add dataset inputs to a dataset. The process is not atomic, i.e. if there are errors with some dataset inputs, others might still be added. The response reports - SUCCESS if all dataset inputs were added, - MIXED_STATUS if only some dataset inputs were added, and - FAILURE if no dataset inputs were added. Each individual dataset input in the response has the status set to indicate if it was successful or if there was an error.

operationId: V2_PostDatasetInputs2

Parameters

Name	In	Required	Type	Description
datasetId	path	required	string	Identify dataset by id.

Request Body

required

application/json

schema V2PostDatasetInputs2Request

Property	Type	Required
search	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
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
datasetInputs	array	optional
└ input	object	optional
└ id	string	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
└ 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
└ createdAt	string	optional
└ datasetIds	array	optional
└ modifiedAt	string	optional
└ createdAt	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/datasets/{datasetId}/inputs

POST /v2/datasets/{datasetId}/versions Add dataset versions to a dataset.

operationId: V2_PostDatasetVersions2

Parameters

Name	In	Required	Type	Description
datasetId	path	required	string	Identify dataset by id.

Request Body

required

application/json

schema V2PostDatasetVersions2Request

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
datasetVersions	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
└ metrics	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ datasetId	string	optional
└ exportInfo	object	optional
└ coco	object	optional
└ url	string	optional
└ size	string	optional
└ format	string	optional
└ status	object	optional
└ includeEmbeddings	boolean	optional
└ clarifaiDataJson	object	optional
└ url	string	optional
└ size	string	optional
└ format	string	optional
└ status	object	optional
└ includeEmbeddings	boolean	optional
└ clarifaiDataProtobuf	object	optional
└ url	string	optional
└ size	string	optional
└ format	string	optional
└ status	object	optional
└ includeEmbeddings	boolean	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ processingInfo	object	optional
└ frameInterpolationInfo	object	optional
└ sampleMs	integer	optional
└ modelPredictConfig	object	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
└ embedModelVersionIds	array	optional
└ annotationFilterConfig	object	optional
└ annotationFilter	object	optional
└ id	string	optional
└ appId	string	optional
└ search	object	optional
└ userId	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ ignoreEmptyInputs	boolean	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/datasets/{datasetId}/versions

POST /v2/evaluations

operationId: V2_PostEvaluations2

Request Body

required

application/json

schema apiPostEvaluationsRequest

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/evaluations

POST /v2/inputs Add 1 or more input to an app. The actual inputs processing is asynchronous.

operationId: V2_PostInputs2

Request Body

required

application/json

schema apiPostInputsRequest

Property	Type	Required
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
inputsAddJobId	string	optional
inputIdConflictResolution	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/inputs

POST /v2/inputs/data_sources Initiates retrieval of inputs from cloud storage from a user provided data source. Will create and return an inputs-add-job for tracking progress. Archives will be extracted and their contents will be processed as inputs.

The cloud URL will be treated as a filter prefix. For example s3:/bucket/images_folder/abc will process
files in the images_folder beginning with abc or in a subfolder beginning with abc.
For example:
bucket/images_folder/abcImage.png
bucket/images_folder/abc-1/Data.zip

If given URL is for a private bucket or file, then credentials should be provided to access the bucket.
Credentials should include rights to list the objects in the bucket, except when pointed directly at a file archive,
in which case it only requires rights to access that particular file.

operationId: V2_PostInputsDataSources2

Request Body

required

Initiates retrieval of inputs from cloud storage from a user provided data source.
Will create and return an inputs-add-job for tracking progress.
Archives will be extracted and their contents will be processed as inputs.

application/json

schema apiPostInputsDataSourcesRequest

Property	Type	Required
appPat	string	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
callBackUrl	string	optional
dataSources	array	optional
└ url	object	optional
└ url	string	optional
└ credentials	object	optional
└ s3Creds	object	optional
└ gcpCreds	string	optional
└ azureBlobCreds	object	optional
└ inputTemplate	object	optional
└ id	string	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
└ 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
└ createdAt	string	optional
└ datasetIds	array	optional
└ modifiedAt	string	optional
└ inputsAddJobId	string	optional
└ inputIdConflictResolution	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/inputs/data_sources

POST /v2/inputs/searches Execute a search over inputs

operationId: V2_PostInputsSearches2

Request Body

required

application/json

schema apiPostInputsSearchesRequest

Property	Type	Required
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
onlyCount	boolean	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/inputs/searches

POST /v2/inputs/uploads Start uploading a file archive containing inputs. Will create and return an inputs-add-job for tracking progress.

Associated inputs-add-job contains an upload id which should be completed through PutUploadContentParts endpoint.
Completing the upload will automatically begin unpacking the archive and uploading the contents as inputs.

operationId: V2_PostInputsUploads2

Request Body

required

Start uploading a file archive containing inputs.
Will create and return an inputs-add-job for tracking progress.

application/json

schema apiPostInputsUploadsRequest

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
inputsUploads	array	optional
└ appPat	string	optional
└ upload	object	optional
└ id	string	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
└ createdAt	string	optional
└ expiresAt	string	optional
└ contentUrl	string	optional
└ modifiedAt	string	optional
└ contentName	string	optional
└ contentLength	string	optional
└ inputTemplate	object	optional
└ id	string	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
└ 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
└ createdAt	string	optional
└ datasetIds	array	optional
└ modifiedAt	string	optional
└ inputsAddJobId	string	optional
└ inputIdConflictResolution	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/inputs/uploads

POST /v2/label_orders Add Label orders.

operationId: V2_PostLabelOrders2

Request Body

required

Request to create label orders.

application/json

schema apiPostLabelOrdersRequest

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
labelOrders	array	optional
└ id	string	optional
└ name	string	optional
└ task	object	optional
└ id	string	optional
└ name	string	optional
└ type	string	optional
└ appId	string	optional
└ review	object	optional
└ users	array	optional
└ userIds	array	optional
└ strategy	string	optional
└ manualStrategyInfo	object	optional
└ consensusStrategyInfo	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
└ worker	object	optional
└ users	array	optional
└ userIds	array	optional
└ workers	array	optional
└ strategy	string	optional
└ partitionedStrategyInfo	object	optional
└ metrics	object	optional
└ work	object	optional
└ concepts	array	optional
└ concept	object	optional
└ autoAnnotationConfig	object	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
└ 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
└ modifiedAt	string	optional
└ autoRelease	boolean	optional
└ allowEmptyTag	boolean	optional
└ desiredFulfillTime	string	optional
└ estimateFulfillTime	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/label_orders

POST /v2/models Add a models to an app.

operationId: V2_PostModels2

Request Body

required

application/json

schema apiPostModelsRequest

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
models	array	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
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/models

POST /v2/models/searches Search over the models to find one or more you're looking for. This leverage the "body" parameter because we also have page and per_page as url query param variables in this request.

operationId: V2_PostModelsSearches2

Request Body

required

Search over the available models.

application/json

schema apiPostModelsSearchesRequest

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

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/models/searches

POST /v2/models/versions/upload This is a streaming endpoint, the request has a field, upload_data, which can either be the config for the upload or the actual data to upload. The config must be sent first before the model_bytes can be uploaded. Once the config has been sent, the server will respond with a confirmation containing the model_version_id. This is so that if your upload is interrupted, you can resume the upload by sending the config again with the model_version_id specified for your model_version. The actual upload will be done via a multipart upload, the latest successful part_id will be sent from the server in the response to the model_bytes.

operationId: V2_PostModelVersionsUpload

Request Body

required

(streaming inputs)

application/json

schema apiPostModelVersionsUploadRequest

Property	Type	Required
contentPart	object	optional
└ data	string	optional
└ partNumber	string	optional
└ rangeStart	string	optional
uploadConfig	object	optional
└ modelId	string	optional
└ totalSize	string	optional
└ userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
└ modelVersion	object	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
└ 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
└ status	object	optional
└ userId	string	optional
└ summary	object	optional
└ testSet	array	optional
└ evalInfo	object	optional
└ labelCounts	object	optional
└ binaryMetrics	array	optional
└ metricsByArea	array	optional
└ metricsByClass	array	optional
└ trackerMetrics	array	optional
└ confusionMatrix	object	optional
└ extendedMetrics	object	optional
└ cooccurrenceMatrix	object	optional
└ groundTruthDataset	object	optional
└ predictionsDataset	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
└ trainInfo	object	optional
└ params	object	optional
└ dataset	object	optional
└ resumeFromModel	object	optional
└ importInfo	object	optional
└ params	object	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
└ 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.(streaming responses)

POST /v2/models/versions/upload

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

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

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

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

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

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

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

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

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

POST /v2/uploads

operationId: V2_PostUploads2

Request Body

required

application/json

schema apiPostUploadsRequest

Property	Type	Required
uploads	array	optional
└ id	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
└ createdAt	string	optional
└ expiresAt	string	optional
└ contentUrl	string	optional
└ modifiedAt	string	optional
└ contentName	string	optional
└ contentLength	string	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/uploads

POST /v2/users/{runnerSelector.deployment.userId}/deployments/{runnerSelector.deployment.id}/outputs Get predicted outputs from the model.

operationId: V2_PostModelOutputs5

Parameters

Name	In	Required	Type	Description
runnerSelector.deployment.userId	path	required	string	The user who owns the deployment. These live in the user/org account.
runnerSelector.deployment.id	path	required	string	An id for this configured deployment.

Request Body

required

application/json

schema V2PostModelOutputs5Request

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
modelId	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
└ 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
└ 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/users/{runnerSelector.deployment.userId}/deployments/{runnerSelector.deployment.id}/outputs

POST /v2/users/{userAppId.userId}/apps Add a app to an app. This needs to load the default workflow to make a copy, validating all the models in it, and then writing the new workflow back to this new app.

operationId: V2_PostApps

Parameters

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

Request Body

required

application/json

schema V2PostAppsRequest

Property	Type	Required
apps	array	optional
└ id	string	optional
└ name	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
└ metadata	object	optional
└ sampleMs	integer	optional
└ createdAt	string	optional
└ extraInfo	object	optional
└ searchRevisionMarker	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ dataTierId	string	optional
└ isTemplate	boolean	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ defaultLanguage	string	optional
└ defaultWorkflow	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
└ nodes	array	optional
└ id	string	optional
└ model	object	optional
└ nodeInputs	array	optional
└ suppressOutput	boolean	optional
└ outputInfoOverride	object	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ id	string	optional
└ appId	string	optional
└ nodes	array	optional
└ userId	string	optional
└ license	string	optional
└ metadata	object	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ workflowId	string	optional
└ description	string	optional
└ metadata	object	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ checkConsents	array	optional
└ bookmarkOrigin	object	optional
└ id	string	optional
└ appId	string	optional
└ userId	string	optional
└ resourceType	string	optional
└ defaultWorkflowId	string	optional
└ legalConsentStatus	integer	optional
userAppId	object	optional
└ appId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps

POST /v2/users/{userAppId.userId}/apps/searches Search over the applications to find one or more you're looking for.

operationId: V2_PostAppsSearches

Parameters

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

Request Body

required

application/json

schema V2PostAppsSearchesRequest

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

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/searches

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/annotation_filters Add annotation filters.

operationId: V2_PostAnnotationFilters

Parameters

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

Request Body

required

application/json

schema V2PostAnnotationFiltersRequest

Property	Type	Required
userAppId	object	optional
annotationFilters	array	optional
└ id	string	optional
└ appId	string	optional
└ search	object	optional
└ id	string	optional
└ asOf	string	optional
└ name	string	optional
└ save	boolean	optional
└ query	object	optional
└ ands	array	optional
└ ranks	array	optional
└ filters	array	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
└ userId	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/annotation_filters

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/annotations Post annotations.

operationId: V2_PostAnnotations

Parameters

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

Request Body

required

application/json

schema V2PostAnnotationsRequest

Property	Type	Required
userAppId	object	optional
annotations	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
└ 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

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/annotations

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/annotations/searches Execute a search over annotations

operationId: V2_PostAnnotationsSearches

Parameters

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

Request Body

required

application/json

schema V2PostAnnotationsSearchesRequest

Property	Type	Required
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
pagination	object	optional
└ page	integer	optional
└ perPage	integer	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/annotations/searches

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/annotations/searches/metrics Evaluate the results of two search requests

operationId: V2_PostAnnotationSearchMetrics

Parameters

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

Request Body

required

application/json

schema V2PostAnnotationSearchMetricsRequest

Property	Type	Required
id	string	optional
data	object	optional
└ geo	object	optional
└ geoBox	array	optional
└ geoPoint	object	optional
└ geoLimit	object	optional
└ type	string	optional
└ value	number	optional
└ geoPoint	object	optional
└ latitude	number	optional
└ longitude	number	optional
└ hits	array	optional
└ appId	string	optional
└ input	object	optional
└ id	string	optional
└ data	object	optional
└ status	object	optional
└ createdAt	string	optional
└ datasetIds	array	optional
└ modifiedAt	string	optional
└ score	number	optional
└ userId	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
└ text	object	optional
└ raw	string	optional
└ url	string	optional
└ hosted	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ textInfo	object	optional
└ encoding	string	optional
└ charCount	integer	optional
└ allowDuplicateUrl	boolean	optional
└ audio	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ audioInfo	object	optional
└ bitRate	integer	optional
└ sampleRate	integer	optional
└ audioFormat	string	optional
└ durationSeconds	number	optional
└ allowDuplicateUrl	boolean	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
└ video	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ videoInfo	object	optional
└ fps	number	optional
└ width	integer	optional
└ height	integer	optional
└ bitRate	integer	optional
└ frameCount	integer	optional
└ videoFormat	string	optional
└ durationSeconds	number	optional
└ thumbnailUrl	string	optional
└ hostedThumbnail	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ allowDuplicateUrl	boolean	optional
└ colors	array	optional
└ w3c	object	optional
└ hex	string	optional
└ name	string	optional
└ value	number	optional
└ rawHex	string	optional
└ frames	array	optional
└ id	string	optional
└ data	object	optional
└ frameInfo	object	optional
└ time	integer	optional
└ index	integer	optional
└ tracks	array	optional
└ id	string	optional
└ data	object	optional
└ quality	number	optional
└ timeInfo	object	optional
└ endTime	number	optional
└ beginTime	number	optional
└ numFrames	integer	optional
└ regions	array	optional
└ id	string	optional
└ data	object	optional
└ value	number	optional
└ trackId	string	optional
└ regionInfo	object	optional
└ mask	object	optional
└ span	object	optional
└ point	object	optional
└ token	object	optional
└ polygon	object	optional
└ boundingBox	object	optional
└ keypointLocations	array	optional
└ clusters	array	optional
└ id	string	optional
└ hits	array	optional
└ appId	string	optional
└ input	object	optional
└ score	number	optional
└ userId	string	optional
└ annotation	object	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
└ isRankable	boolean	optional
└ definition	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ keypointInfo	object	optional
└ skeleton	array	optional
└ keypointNames	array	optional
└ heatmaps	array	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
└ metadata	object	optional
└ embeddings	array	optional
└ vector	array	optional
└ numDimensions	integer	optional
└ timeSegments	array	optional
└ id	string	optional
└ data	object	optional
└ timeInfo	object	optional
└ endTime	number	optional
└ beginTime	number	optional
└ numFrames	integer	optional
userAppId	object	optional
groundTruth	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
searchToEval	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
evaluationType	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/annotations/searches/metrics

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/bulk_operations Perform bulk operations on a list of inputs based on input source. Operation include add, update, delete of concepts, metadata and geo data. This is an Asynchronous process. Use ListBulkOperations or GetBulkOperation to check the status.

operationId: V2_PostBulkOperations

Parameters

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

Request Body

required

application/json

schema V2PostBulkOperationsRequest

Property	Type	Required
userAppId	object	optional
bulkOperations	array	optional
└ id	string	optional
└ appId	string	optional
└ search	object	optional
└ id	string	optional
└ asOf	string	optional
└ name	string	optional
└ save	boolean	optional
└ query	object	optional
└ ands	array	optional
└ ranks	array	optional
└ filters	array	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
└ 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
└ dataset	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
└ inputIds	object	optional
└ inputIds	array	optional
└ progress	object	optional
└ processed	integer	optional
└ lastProcessedId	string	optional
└ createdAt	string	optional
└ createdBy	string	optional
└ operation	object	optional
└ deleteGeo	object	optional
└ addConcepts	object	optional
└ concepts	array	optional
└ addMetadata	object	optional
└ metadata	object	optional
└ addToDataset	object	optional
└ datasetId	string	optional
└ overwriteGeo	object	optional
└ geo	object	optional
└ deleteConcepts	object	optional
└ userIds	array	optional
└ concepts	array	optional
└ deleteMetadata	object	optional
└ metadata	object	optional
└ deleteFromDataset	object	optional
└ datasetId	string	optional
└ splitIntoDatasets	object	optional
└ method	string	optional
└ datasetSplits	array	optional
└ lastModifiedAt	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/bulk_operations

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/collaborators add collaborators to an app.

operationId: V2_PostCollaborators

Parameters

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

Request Body

required

application/json

schema V2PostCollaboratorsRequest

Property	Type	Required
userAppId	object	optional
collaborators	array	optional
└ id	string	optional
└ app	object	optional
└ id	string	optional
└ name	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
└ metadata	object	optional
└ sampleMs	integer	optional
└ createdAt	string	optional
└ extraInfo	object	optional
└ searchRevisionMarker	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ dataTierId	string	optional
└ isTemplate	boolean	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ defaultLanguage	string	optional
└ defaultWorkflow	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
└ defaultWorkflowId	string	optional
└ legalConsentStatus	integer	optional
└ user	object	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
└ state	string	optional
└ country	string	optional
└ billType	string	optional
└ metadata	object	optional
└ teamsCount	integer	optional
└ primaryEmail	string	optional
└ datePiiConsent	string	optional
└ dateTosConsent	string	optional
└ emailAddresses	array	optional
└ dateGdprConsent	string	optional
└ dateMarketingConsent	string	optional
└ twoFactorAuthEnabled	boolean	optional
└ visibility	object	optional
└ gettable	string	optional
└ companyName	string	optional
└ primaryEmail	string	optional
└ datePiiConsent	string	optional
└ dateTosConsent	string	optional
└ emailAddresses	array	optional
└ email	string	optional
└ primary	boolean	optional
└ verified	boolean	optional
└ dateGdprConsent	string	optional
└ …2 more	object	optional
└ scopes	array	optional
└ createdAt	string	optional
└ deletedAt	string	optional
└ endpoints	array	optional
└ modifiedAt	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/collaborators

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/collectors Add a list of Collectors to an app. In the handler of this endpoint we also check for all the scopes of the POST /inputs endpoint. Those current scopes are listed here as a hard requirement. They are needed when adding the collectors just so we now that you have permission with that key at least to do the writing to this app with POST /inputs.

operationId: V2_PostCollectors

Parameters

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

Request Body

required

application/json

schema V2PostCollectorsRequest

Property	Type	Required
userAppId	object	optional
collectors	array	optional
└ id	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
└ createdAt	string	optional
└ description	string	optional
└ collectOutputs	boolean	optional
└ collectorSource	object	optional
└ apiPostModelOutputsCollectorSource	object	optional
└ modelId	string	optional
└ modelAppId	string	optional
└ modelUserId	string	optional
└ callerUserId	string	optional
└ modelVersionId	string	optional
└ postInputsKeyId	string	optional
└ preQueueWorkflowId	string	optional
└ postQueueWorkflowId	string	optional
└ preQueueRandomSample	number	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/collectors

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/concepts Add a concept to an app.

operationId: V2_PostConcepts

Parameters

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

Request Body

required

application/json

schema V2PostConceptsRequest

Property	Type	Required
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
└ isRankable	boolean	optional
└ definition	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ keypointInfo	object	optional
└ skeleton	array	optional
└ k1	integer	optional
└ k2	integer	optional
└ keypointNames	array	optional
userAppId	object	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/concepts

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/concepts/knowledge_graphs Post domain graphs.

operationId: V2_PostKnowledgeGraphs

Parameters

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

Request Body

required

application/json

schema V2PostKnowledgeGraphsRequest

Property	Type	Required
userAppId	object	optional
knowledgeGraphs	array	optional
└ id	string	optional
└ name	string	optional
└ description	string	optional
└ examplesAppId	string	optional
└ sampledExamplesAppId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/concepts/knowledge_graphs

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/concepts/mappings/jobs Start concept mapping jobs.

operationId: V2_PostConceptMappingJobs

Parameters

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

Request Body

required

application/json

schema V2PostConceptMappingJobsRequest

Property	Type	Required
userAppId	object	optional
conceptMappingJobs	array	optional
└ conceptIds	array	optional
└ knowledgeGraphId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/concepts/mappings/jobs

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/concepts/searches Search over the concepts to find one or more you're looking for. This leverage the "body" parameter because we also have page and per_page as url query param variables in this request.

operationId: V2_PostConceptsSearches

Parameters

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

Request Body

required

application/json

schema V2PostConceptsSearchesRequest

Property	Type	Required
extraInfo	object	optional
└ rankableModel	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
userAppId	object	optional
pagination	object	optional
└ page	integer	optional
└ perPage	integer	optional
conceptQuery	object	optional
└ name	string	optional
└ language	string	optional
└ useCases	array	optional
└ workflowId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/concepts/searches

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/concepts/{conceptId}/languages Add a new translation for this concept.

operationId: V2_PostConceptLanguages

Parameters

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

Request Body

required

application/json

schema V2PostConceptLanguagesRequest

Property	Type	Required
userAppId	object	optional
conceptLanguages	array	optional
└ id	string	optional
└ name	string	optional
└ definition	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/concepts/{conceptId}/languages

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/concepts/{conceptId}/relations Post concept relations to create relations between concepts in the platform.

operationId: V2_PostConceptRelations

Parameters

Name	In	Required	Type	Description
userAppId.userId	path	required	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	path	required	string	—
conceptId	path	required	string	The subject concept id you’re going to add relations for.

Request Body

required

application/json

schema V2PostConceptRelationsRequest

Property	Type	Required
userAppId	object	optional
conceptRelations	array	optional
└ id	string	optional
└ predicate	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ objectConcept	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
└ isRankable	boolean	optional
└ definition	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ keypointInfo	object	optional
└ skeleton	array	optional
└ keypointNames	array	optional
└ subjectConcept	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
└ isRankable	boolean	optional
└ definition	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ keypointInfo	object	optional
└ skeleton	array	optional
└ keypointNames	array	optional
└ knowledgeGraphId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/concepts/{conceptId}/relations

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/datasets Add datasets to an app. The process is atomic, i.e. either all or no datasets are added. If there is an error for one dataset, the process will stop, revert the transaction and return the error.

operationId: V2_PostDatasets

Parameters

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

Request Body

required

application/json

schema V2PostDatasetsRequest

Property	Type	Required
datasets	array	optional
└ id	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
└ version	object	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
└ timeRemaining	integer	optional
└ developerNotes	string	optional
└ internalDetails	string	optional
└ percentCompleted	integer	optional
└ userId	string	optional
└ metrics	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ datasetId	string	optional
└ exportInfo	object	optional
└ coco	object	optional
└ clarifaiDataJson	object	optional
└ clarifaiDataProtobuf	object	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ processingInfo	object	optional
└ frameInterpolationInfo	object	optional
└ modelPredictConfig	object	optional
└ model	object	optional
└ embedModelVersionIds	array	optional
└ annotationFilterConfig	object	optional
└ annotationFilter	object	optional
└ ignoreEmptyInputs	boolean	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
└ sampleMs	integer	optional
└ defaultAnnotationFilter	object	optional
└ id	string	optional
└ appId	string	optional
└ search	object	optional
└ id	string	optional
└ asOf	string	optional
└ name	string	optional
└ save	boolean	optional
└ query	object	optional
└ metric	string	optional
└ gitHash	string	optional
└ minValue	number	optional
└ algorithm	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ applicationId	string	optional
└ userId	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
userAppId	object	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/datasets

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/datasets/{datasetId}/inputs Add dataset inputs to a dataset. The process is not atomic, i.e. if there are errors with some dataset inputs, others might still be added. The response reports - SUCCESS if all dataset inputs were added, - MIXED_STATUS if only some dataset inputs were added, and - FAILURE if no dataset inputs were added. Each individual dataset input in the response has the status set to indicate if it was successful or if there was an error.

operationId: V2_PostDatasetInputs

Parameters

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

Request Body

required

application/json

schema V2PostDatasetInputsRequest

Property	Type	Required
search	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
userAppId	object	optional
datasetInputs	array	optional
└ input	object	optional
└ id	string	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
└ 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
└ createdAt	string	optional
└ datasetIds	array	optional
└ modifiedAt	string	optional
└ createdAt	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/datasets/{datasetId}/inputs

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/datasets/{datasetId}/versions Add dataset versions to a dataset.

operationId: V2_PostDatasetVersions

Parameters

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

Request Body

required

application/json

schema V2PostDatasetVersionsRequest

Property	Type	Required
userAppId	object	optional
datasetVersions	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
└ metrics	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ datasetId	string	optional
└ exportInfo	object	optional
└ coco	object	optional
└ url	string	optional
└ size	string	optional
└ format	string	optional
└ status	object	optional
└ includeEmbeddings	boolean	optional
└ clarifaiDataJson	object	optional
└ url	string	optional
└ size	string	optional
└ format	string	optional
└ status	object	optional
└ includeEmbeddings	boolean	optional
└ clarifaiDataProtobuf	object	optional
└ url	string	optional
└ size	string	optional
└ format	string	optional
└ status	object	optional
└ includeEmbeddings	boolean	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ processingInfo	object	optional
└ frameInterpolationInfo	object	optional
└ sampleMs	integer	optional
└ modelPredictConfig	object	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
└ embedModelVersionIds	array	optional
└ annotationFilterConfig	object	optional
└ annotationFilter	object	optional
└ id	string	optional
└ appId	string	optional
└ search	object	optional
└ userId	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ ignoreEmptyInputs	boolean	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/datasets/{datasetId}/versions

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/duplications PostAppDuplications starts async app duplication jobs which copy resources (inputs, annotations, models etc) from one application to another. It can also create the destination application if it does not exist, with fields (description, metadata etc) copied from the source application.

A duplication job can be started by any user that can read from the source
application (the target of this call) and can create and write to the
destination application. The duplication is associated with the user that
created it, so in order to read the status and progress of the job, that
user’s ID has to be used in the call to GetAppDuplication, which might be
different to the source application owner ID in this call.

operationId: V2_PostAppDuplications

Parameters

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

Request Body

required

application/json

schema V2PostAppDuplicationsRequest

Property	Type	Required
userAppId	object	optional
appDuplications	array	optional
└ id	string	optional
└ filter	object	optional
└ copyInputs	boolean	optional
└ copyModels	boolean	optional
└ copyConcepts	boolean	optional
└ copyWorkflows	boolean	optional
└ copyAnnotations	boolean	optional
└ copyInstalledModuleVersions	boolean	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
└ newAppId	string	optional
└ progress	array	optional
└ field	string	optional
└ value	integer	optional
└ createdAt	string	optional
└ newAppName	string	optional
└ existingAppId	string	optional
└ destinationApp	object	optional
└ id	string	optional
└ name	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
└ metadata	object	optional
└ sampleMs	integer	optional
└ createdAt	string	optional
└ extraInfo	object	optional
└ searchRevisionMarker	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ dataTierId	string	optional
└ isTemplate	boolean	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ defaultLanguage	string	optional
└ defaultWorkflow	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
└ defaultWorkflowId	string	optional
└ legalConsentStatus	integer	optional
└ lastModifiedAt	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/duplications

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/evaluations

operationId: V2_PostEvaluations

Parameters

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

Request Body

required

application/json

schema V2PostEvaluationsRequest

Property	Type	Required
userAppId	object	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/users/{userAppId.userId}/apps/{userAppId.appId}/evaluations

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/inputs Add 1 or more input to an app. The actual inputs processing is asynchronous.

operationId: V2_PostInputs

Parameters

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

Request Body

required

application/json

schema V2PostInputsRequest

Property	Type	Required
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
inputsAddJobId	string	optional
inputIdConflictResolution	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/inputs

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/inputs/data_sources Initiates retrieval of inputs from cloud storage from a user provided data source. Will create and return an inputs-add-job for tracking progress. Archives will be extracted and their contents will be processed as inputs.

operationId: V2_PostInputsDataSources

Parameters

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

Request Body

required

application/json

schema V2PostInputsDataSourcesRequest

Property	Type	Required
appPat	string	optional
userAppId	object	optional
callBackUrl	string	optional
dataSources	array	optional
└ url	object	optional
└ url	string	optional
└ credentials	object	optional
└ s3Creds	object	optional
└ gcpCreds	string	optional
└ azureBlobCreds	object	optional
└ inputTemplate	object	optional
└ id	string	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
└ 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
└ createdAt	string	optional
└ datasetIds	array	optional
└ modifiedAt	string	optional
└ inputsAddJobId	string	optional
└ inputIdConflictResolution	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/inputs/data_sources

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/inputs/searches Execute a search over inputs

operationId: V2_PostInputsSearches

Parameters

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

Request Body

required

application/json

schema V2PostInputsSearchesRequest

Property	Type	Required
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
onlyCount	boolean	optional
userAppId	object	optional
pagination	object	optional
└ page	integer	optional
└ perPage	integer	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/inputs/searches

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/inputs/uploads Start uploading a file archive containing inputs. Will create and return an inputs-add-job for tracking progress.

operationId: V2_PostInputsUploads

Parameters

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

Request Body

required

application/json

schema V2PostInputsUploadsRequest

Property	Type	Required
userAppId	object	optional
inputsUploads	array	optional
└ appPat	string	optional
└ upload	object	optional
└ id	string	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
└ createdAt	string	optional
└ expiresAt	string	optional
└ contentUrl	string	optional
└ modifiedAt	string	optional
└ contentName	string	optional
└ contentLength	string	optional
└ inputTemplate	object	optional
└ id	string	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
└ 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
└ createdAt	string	optional
└ datasetIds	array	optional
└ modifiedAt	string	optional
└ inputsAddJobId	string	optional
└ inputIdConflictResolution	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/inputs/uploads

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/installed_module_versions Install a new module version which will deploy the specific ModuleVersion to the app in the url.

operationId: V2_PostInstalledModuleVersions

Parameters

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

Request Body

required

application/json

schema V2PostInstalledModuleVersionsRequest

Property	Type	Required
userAppId	object	optional
installedModuleVersions	array	optional
└ id	string	optional
└ appId	string	optional
└ keyId	string	optional
└ userId	string	optional
└ createdAt	string	optional
└ deployUrl	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ moduleVersion	object	optional
└ id	string	optional
└ appId	string	optional
└ notes	string	optional
└ userId	string	optional
└ approved	boolean	optional
└ metadata	object	optional
└ moduleId	string	optional
└ createdAt	string	optional
└ moduleNav	object	optional
└ title	string	optional
└ moduleSubNavs	array	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ gitCommitUrl	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/installed_module_versions

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/installed_module_versions/{installedModuleVersionId}/key Assign a key that the caller owns to be used when accessing this installed module version If this endpoint is called with a different key then it overwrites what is there.

operationId: V2_PostInstalledModuleVersionsKey

Parameters

Name

Required

Type

Description

userAppId.userId

path

required

string

Note user_id ‘me’ is reserved - it is the alias for the id of authorized user

userAppId.appId

path

required

string

—

installedModuleVersionId

path

required

string

the ID to get of the install module version.

Note(zeiler): we don’t provide a key to create since it’s always deterministic.
we’ll create a PAT, owned by the caller with the scopes that the module requests.
in the future if we want we can pass in a Key key = 3; field so that the caller
can adjust the scopes, but for now that doesn’t seem necessary.

Request Body

required

application/json

schema V2PostInstalledModuleVersionsKeyRequest

Property	Type	Required
userAppId	object	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/installed_module_versions/{installedModuleVersionId}/key

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/label_orders Add Label orders.

operationId: V2_PostLabelOrders

Parameters

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

Request Body

required

application/json

schema V2PostLabelOrdersRequest

Property	Type	Required
userAppId	object	optional
labelOrders	array	optional
└ id	string	optional
└ name	string	optional
└ task	object	optional
└ id	string	optional
└ name	string	optional
└ type	string	optional
└ appId	string	optional
└ review	object	optional
└ users	array	optional
└ userIds	array	optional
└ strategy	string	optional
└ manualStrategyInfo	object	optional
└ consensusStrategyInfo	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
└ worker	object	optional
└ users	array	optional
└ userIds	array	optional
└ workers	array	optional
└ strategy	string	optional
└ partitionedStrategyInfo	object	optional
└ metrics	object	optional
└ work	object	optional
└ concepts	array	optional
└ concept	object	optional
└ autoAnnotationConfig	object	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
└ 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
└ modifiedAt	string	optional
└ autoRelease	boolean	optional
└ allowEmptyTag	boolean	optional
└ desiredFulfillTime	string	optional
└ estimateFulfillTime	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/label_orders

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models Add a models to an app.

operationId: V2_PostModels

Parameters

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

Request Body

required

application/json

schema V2PostModelsRequest

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
models	array	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
userAppId	object	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/searches Search over the models to find one or more you're looking for. This leverage the "body" parameter because we also have page and per_page as url query param variables in this request.

operationId: V2_PostModelsSearches

Parameters

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

Request Body

required

application/json

schema V2PostModelsSearchesRequest

Property	Type	Required
userAppId	object	optional
modelQuery	object	optional
└ name	string	optional
└ modelTypeId	string	optional
pagination	object	optional
└ page	integer	optional
└ perPage	integer	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/searches

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/outputs Get predicted outputs from the model.

operationId: V2_PostModelOutputs3

Parameters

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

Request Body

application/json

schema V2PostModelOutputs3Request

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
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/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/outputs

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/outputs/generate TODO(zeiler): will need to Single request but streaming resopnses.

operationId: V2_GenerateModelOutputs2

Parameters

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

Request Body

application/json

schema V2PostModelOutputs3Request

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
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.(streaming responses)

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/outputs/generate

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/publish PostModelVersionsPublish

operationId: V2_PostModelVersionsPublish

Parameters

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

Request Body

required

application/json

schema V2PostModelVersionsPublishRequest

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

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/publish

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/unpublish PostModelVersionsUnPublish

operationId: V2_PostModelVersionsUnPublish

Parameters

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

Request Body

required

application/json

schema V2PostModelVersionsUnPublishRequest

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

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/unpublish

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/versions Create a new model version to trigger training of the model.

operationId: V2_PostModelVersions

Parameters

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

Request Body

required

application/json

schema V2PostModelVersionsRequest

Property	Type	Required
evalInfo	object	optional
└ params	object	optional
userAppId	object	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/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/versions

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

operationId: V2_PostModelVersionsTrainingTimeEstimate

Parameters

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

Request Body

required

application/json

schema V2PostModelVersionsTrainingTimeEstimateRequest

Property	Type	Required
userAppId	object	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/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/versions/time_estimate

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/versions/{modelVersionId}/evaluations Deprecated, use PostEvaluations instead

operationId: V2_PostModelVersionEvaluations

Parameters

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

Request Body

required

application/json

schema V2PostModelVersionEvaluationsRequest

Property	Type	Required
userAppId	object	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/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/versions/{modelVersionId}/evaluations

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

operationId: V2_PostModelVersionMetrics

Parameters

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

Request Body

required

application/json

schema V2PostModelVersionMetricsRequest

Property	Type	Required
evalInfo	object	optional
└ params	object	optional
userAppId	object	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/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/versions/{versionId}/metrics

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/versions/{versionId}/outputs Get predicted outputs from the model.

operationId: V2_PostModelOutputs

Parameters

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

Request Body

application/json

schema V2PostModelOutputsRequest

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
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/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/versions/{versionId}/outputs

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/versions/{versionId}/outputs/generate TODO(zeiler): will need to Single request but streaming resopnses.

operationId: V2_GenerateModelOutputs

Parameters

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

Request Body

application/json

schema V2PostModelOutputsRequest

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
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.(streaming responses)

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/versions/{versionId}/outputs/generate

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/modules Add a modules to an app.

operationId: V2_PostModules

Parameters

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

Request Body

required

application/json

schema V2PostModulesRequest

Property	Type	Required
modules	array	optional
└ id	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
└ userId	string	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
└ moduleVersion	object	optional
└ id	string	optional
└ appId	string	optional
└ notes	string	optional
└ userId	string	optional
└ approved	boolean	optional
└ metadata	object	optional
└ moduleId	string	optional
└ createdAt	string	optional
└ moduleNav	object	optional
└ title	string	optional
└ moduleSubNavs	array	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ gitCommitUrl	string	optional
└ bookmarkOrigin	object	optional
└ id	string	optional
└ appId	string	optional
└ userId	string	optional
└ resourceType	string	optional
userAppId	object	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/modules

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/modules/{moduleId}/versions Create a new module version to trigger training of the module.

operationId: V2_PostModuleVersions

Parameters

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

Request Body

required

application/json

schema V2PostModuleVersionsRequest

Property	Type	Required
userAppId	object	optional
moduleVersions	array	optional
└ id	string	optional
└ appId	string	optional
└ notes	string	optional
└ userId	string	optional
└ approved	boolean	optional
└ metadata	object	optional
└ moduleId	string	optional
└ createdAt	string	optional
└ moduleNav	object	optional
└ title	string	optional
└ moduleSubNavs	array	optional
└ title	string	optional
└ queryKey	string	optional
└ queryValue	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ gitCommitUrl	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/modules/{moduleId}/versions

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/searches Execute a new search and optionally save it.

Deprecated: Use PostInputsSearches or PostAnnotationsSearches instead.

operationId: V2_PostSearches

Parameters

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

Request Body

required

application/json

schema V2PostSearchesRequest

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
pagination	object	optional
└ page	integer	optional
└ perPage	integer	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/searches

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/searches/{id} Execute a previously saved legacy search.

operationId: V2_PostSearchesByID

Parameters

Name	In	Required	Type	Description
userAppId.userId	path	required	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	path	required	string	—
id	path	required	string	ID for saves search to be executed

Request Body

required

application/json

schema V2PostSearchesByIdRequest

Property	Type	Required
userAppId	object	optional
pagination	object	optional
└ page	integer	optional
└ perPage	integer	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/searches/{id}

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/stats/values PostStatValues

operationId: V2_PostStatValues

Parameters

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

Request Body

required

application/json

schema V2PostStatValuesRequest

Property	Type	Required
userAppId	object	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/users/{userAppId.userId}/apps/{userAppId.appId}/stats/values

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/stats/values/aggregate PostStatValuesAggregate

operationId: V2_PostStatValuesAggregate

Parameters

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

Request Body

required

application/json

schema V2PostStatValuesAggregateRequest

Property	Type	Required
userAppId	object	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/users/{userAppId.userId}/apps/{userAppId.appId}/stats/values/aggregate

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/tasks Add tasks to an app.

operationId: V2_PostTasks

Parameters

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

Request Body

required

application/json

schema V2PostTasksRequest

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

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/tasks

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/trending_metrics/views/{viewType}/{objectId} Increase the view metric for a detail view

operationId: V2_PostTrendingMetricsView

Parameters

Name	In	Required	Type	Description
userAppId.userId	path	required	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	path	required	string	—
viewType	path	required	string	For now view types ‘apps’, ‘workflows’, and ‘models’ are supported.
objectId	path	required	string	ID of the views object.

Request Body

required

application/json

schema V2PostTrendingMetricsViewRequest

Property	Type	Required
userAppId	object	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/trending_metrics/views/{viewType}/{objectId}

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/uploads

operationId: V2_PostUploads

Parameters

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

Request Body

required

application/json

schema V2PostUploadsRequest

Property	Type	Required
uploads	array	optional
└ id	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
└ createdAt	string	optional
└ expiresAt	string	optional
└ contentUrl	string	optional
└ modifiedAt	string	optional
└ contentName	string	optional
└ contentLength	string	optional
userAppId	object	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/uploads

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows Add a workflow to an app. Note(zeiler): the order of the workflows that are returned from this endpoint may be different than the order in which the user provides them. This is because we reorder by a sort that optimizes for performance of the graph and its dependencies. When using the workflow in any future call the order returned by this endpoint will be used.

operationId: V2_PostWorkflows

Parameters

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

Request Body

required

application/json

schema V2PostWorkflowsRequest

Property	Type	Required
userAppId	object	optional
workflows	array	optional
└ id	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
└ nodes	array	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
└ nodeInputs	array	optional
└ nodeId	string	optional
└ suppressOutput	boolean	optional
└ outputInfoOverride	object	optional
└ data	object	optional
└ params	object	optional
└ message	string	optional
└ fieldsMap	object	optional
└ paramsSpecs	array	optional
└ outputConfig	object	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ id	string	optional
└ appId	string	optional
└ nodes	array	optional
└ id	string	optional
└ model	object	optional
└ nodeInputs	array	optional
└ suppressOutput	boolean	optional
└ outputInfoOverride	object	optional
└ userId	string	optional
└ license	string	optional
└ metadata	object	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ workflowId	string	optional
└ description	string	optional
└ metadata	object	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ checkConsents	array	optional
└ bookmarkOrigin	object	optional
└ id	string	optional
└ appId	string	optional
└ userId	string	optional
└ resourceType	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows/{workflowId}/publish

operationId: V2_PostWorkflowVersionsPublish

Parameters

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

Request Body

required

application/json

schema V2PostWorkflowVersionsPublishRequest

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

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows/{workflowId}/publish

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows/{workflowId}/results Predict using a workflow.

operationId: V2_PostWorkflowResults2

Parameters

Name	In	Required	Type	Description
userAppId.userId	path	required	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	path	required	string	—
workflowId	path	required	string	Workflow ID to retrieve If no ID is specified we return default workflow of the application If an ID is specified by default we first looks into Clarifai workflows for a Workflow ID

Request Body

required

application/json

schema V2PostWorkflowResults2Request

Property	Type	Required
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
versionId	string	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
└ 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
└ isRankable	boolean	optional
└ definition	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ keypointInfo	object	optional
└ skeleton	array	optional
└ keypointNames	array	optional
└ existingModelId	string	optional
└ hyperParameters	string	optional
└ trainingTimeout	integer	optional
└ embedModelVersionId	string	optional
└ conceptsMutuallyExclusive	boolean	optional
└ failOnMissingPositiveExamples	boolean	optional
workflowState	object	optional
└ id	string	optional
favorClarifaiWorkflows	boolean	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows/{workflowId}/results

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows/{workflowId}/results/similarity Compare embeddings distances using a workflow

operationId: V2_PostWorkflowResultsSimilarity2

Parameters

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

Request Body

required

application/json

schema V2PostWorkflowResultsSimilarity2Request

Property	Type	Required
userAppId	object	optional
versionId	string	optional
poolInputs	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
probeInputs	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
modelVersionId	string	optional
favorClarifaiWorkflows	boolean	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows/{workflowId}/results/similarity

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows/{workflowId}/unpublish

operationId: V2_PostWorkflowVersionsUnPublish

Parameters

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

Request Body

required

application/json

schema V2PostWorkflowVersionsUnPublishRequest

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

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows/{workflowId}/unpublish

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows/{workflowId}/versions/{versionId}/results Predict using a workflow.

operationId: V2_PostWorkflowResults

Parameters

Name	In	Required	Type	Description
userAppId.userId	path	required	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	path	required	string	—
workflowId	path	required	string	Workflow ID to retrieve If no ID is specified we return default workflow of the application If an ID is specified by default we first looks into Clarifai workflows for a Workflow ID
versionId	path	required	string	Workflow version ID to retrieve If no ID is specified, latest workflow version is used

Request Body

required

application/json

schema V2PostWorkflowResultsRequest

Property	Type	Required
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
outputConfig	object	optional
└ language	string	optional
└ minValue	number	optional
└ sampleMs	integer	optional
└ hyperParams	object	optional
└ maxConcepts	integer	optional
└ modelMetadata	object	optional
└ selectConcepts	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
└ isRankable	boolean	optional
└ definition	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ keypointInfo	object	optional
└ skeleton	array	optional
└ keypointNames	array	optional
└ existingModelId	string	optional
└ hyperParameters	string	optional
└ trainingTimeout	integer	optional
└ embedModelVersionId	string	optional
└ conceptsMutuallyExclusive	boolean	optional
└ failOnMissingPositiveExamples	boolean	optional
workflowState	object	optional
└ id	string	optional
favorClarifaiWorkflows	boolean	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows/{workflowId}/versions/{versionId}/results

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows/{workflowId}/versions/{versionId}/results/similarity Compare embeddings distances using a workflow

operationId: V2_PostWorkflowResultsSimilarity

Parameters

Name	In	Required	Type	Description
userAppId.userId	path	required	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	path	required	string	—
workflowId	path	required	string	—
versionId	path	required	string	Workflow version ID to retrieve If no ID is specified, latest workflow version is used

Request Body

required

application/json

schema V2PostWorkflowResultsSimilarityRequest

Property	Type	Required
userAppId	object	optional
poolInputs	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
probeInputs	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
modelVersionId	string	optional
favorClarifaiWorkflows	boolean	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows/{workflowId}/versions/{versionId}/results/similarity

POST /v2/users/{userAppId.userId}/keys Add a key to an app.

operationId: V2_PostKeys

Parameters

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

Request Body

required

application/json

schema V2PostKeysRequest

Property	Type	Required
keys	array	optional
└ id	string	optional
└ apps	array	optional
└ id	string	optional
└ name	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
└ metadata	object	optional
└ sampleMs	integer	optional
└ createdAt	string	optional
└ extraInfo	object	optional
└ searchRevisionMarker	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ dataTierId	string	optional
└ isTemplate	boolean	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ defaultLanguage	string	optional
└ defaultWorkflow	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
└ defaultWorkflowId	string	optional
└ legalConsentStatus	integer	optional
└ type	string	optional
└ scopes	array	optional
└ createdAt	string	optional
└ endpoints	array	optional
└ expiresAt	string	optional
└ description	string	optional
└ authorizedIdpIds	array	optional
userAppId	object	optional
└ appId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/keys

POST /v2/users/{userAppId.userId}/runners Add a runners to a user.

operationId: V2_PostRunners

Parameters

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

Request Body

required

application/json

schema V2PostRunnersRequest

Property	Type	Required
runners	array	optional
└ id	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
└ labels	array	optional
└ userId	string	optional
└ metadata	object	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
└ workflow	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
└ nodes	array	optional
└ id	string	optional
└ model	object	optional
└ nodeInputs	array	optional
└ suppressOutput	boolean	optional
└ outputInfoOverride	object	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ id	string	optional
└ appId	string	optional
└ nodes	array	optional
└ userId	string	optional
└ license	string	optional
└ metadata	object	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ workflowId	string	optional
└ description	string	optional
└ metadata	object	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ checkConsents	array	optional
└ bookmarkOrigin	object	optional
└ id	string	optional
└ appId	string	optional
└ userId	string	optional
└ resourceType	string	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
userAppId	object	optional
└ appId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/runners

POST /v2/users/{userAppId.userId}/runners/{runnerId}/items/{runnerItemId}/outputs Post back outputs from remote runners since the runner_id is a UUID we can access it directly too.

operationId: V2_PostRunnerItemOutputs

Parameters

Name	In	Required	Type	Description
userAppId.userId	path	required	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
runnerId	path	required	string	The particular runner that processed the work.
runnerItemId	path	required	string	The particular item of work processed.

Request Body

required

application/json

schema V2PostRunnerItemOutputsRequest

Property	Type	Required
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
userAppId	object	optional
└ appId	string	optional
runnerItemOutputs	array	optional
└ multiOutputResponse	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
└ outputs	array	optional
└ id	string	optional
└ data	object	optional
└ input	object	optional
└ model	object	optional
└ status	object	optional
└ createdAt	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/runners/{runnerId}/items/{runnerItemId}/outputs

POST /v2/users/{userAppId.userId}/validate_password Validate new password in real-time for a user

operationId: V2_PostValidatePassword

Parameters

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

Request Body

required

application/json

schema V2PostValidatePasswordRequest

Property	Type	Required
password	object	optional
└ plaintext	string	optional
userAppId	object	optional
└ appId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/users/{userAppId.userId}/validate_password

POST /v2/validate_password Validate new password in real-time for a user

operationId: V2_PostValidatePassword2

Request Body

required

application/json

schema apiPostValidatePasswordRequest

Property	Type	Required
password	object	optional
└ plaintext	string	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/validate_password

POST /v2/workflows Add a workflow to an app. Note(zeiler): the order of the workflows that are returned from this endpoint may be different than the order in which the user provides them. This is because we reorder by a sort that optimizes for performance of the graph and its dependencies. When using the workflow in any future call the order returned by this endpoint will be used.

operationId: V2_PostWorkflows2

Request Body

required

application/json

schema apiPostWorkflowsRequest

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
workflows	array	optional
└ id	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
└ nodes	array	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
└ nodeInputs	array	optional
└ nodeId	string	optional
└ suppressOutput	boolean	optional
└ outputInfoOverride	object	optional
└ data	object	optional
└ params	object	optional
└ message	string	optional
└ fieldsMap	object	optional
└ paramsSpecs	array	optional
└ outputConfig	object	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ id	string	optional
└ appId	string	optional
└ nodes	array	optional
└ id	string	optional
└ model	object	optional
└ nodeInputs	array	optional
└ suppressOutput	boolean	optional
└ outputInfoOverride	object	optional
└ userId	string	optional
└ license	string	optional
└ metadata	object	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ workflowId	string	optional
└ description	string	optional
└ metadata	object	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ checkConsents	array	optional
└ bookmarkOrigin	object	optional
└ id	string	optional
└ appId	string	optional
└ userId	string	optional
└ resourceType	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/workflows

POST /v2/workflows/{workflowId}/publish

operationId: V2_PostWorkflowVersionsPublish2

Parameters

Name	In	Required	Type	Description
workflowId	path	required	string	—

Request Body

required

application/json

schema V2PostWorkflowVersionsPublish2Request

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/workflows/{workflowId}/publish

POST /v2/workflows/{workflowId}/results Predict using a workflow.

operationId: V2_PostWorkflowResults3

Parameters

Name	In	Required	Type	Description
workflowId	path	required	string	Workflow ID to retrieve If no ID is specified we return default workflow of the application If an ID is specified by default we first looks into Clarifai workflows for a Workflow ID

Request Body

required

application/json

schema V2PostWorkflowResults3Request

Property	Type	Required
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
outputConfig	object	optional
└ language	string	optional
└ minValue	number	optional
└ sampleMs	integer	optional
└ hyperParams	object	optional
└ maxConcepts	integer	optional
└ modelMetadata	object	optional
└ selectConcepts	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
└ isRankable	boolean	optional
└ definition	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ keypointInfo	object	optional
└ skeleton	array	optional
└ keypointNames	array	optional
└ existingModelId	string	optional
└ hyperParameters	string	optional
└ trainingTimeout	integer	optional
└ embedModelVersionId	string	optional
└ conceptsMutuallyExclusive	boolean	optional
└ failOnMissingPositiveExamples	boolean	optional
workflowState	object	optional
└ id	string	optional
favorClarifaiWorkflows	boolean	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/workflows/{workflowId}/results

POST /v2/workflows/{workflowId}/results/similarity Compare embeddings distances using a workflow

operationId: V2_PostWorkflowResultsSimilarity3

Parameters

Name	In	Required	Type	Description
workflowId	path	required	string	—

Request Body

required

application/json

schema V2PostWorkflowResultsSimilarity3Request

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
versionId	string	optional
poolInputs	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
probeInputs	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
modelVersionId	string	optional
favorClarifaiWorkflows	boolean	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/workflows/{workflowId}/results/similarity

POST /v2/workflows/{workflowId}/unpublish

operationId: V2_PostWorkflowVersionsUnPublish2

Parameters

Name	In	Required	Type	Description
workflowId	path	required	string	—

Request Body

required

application/json

schema V2PostWorkflowVersionsUnPublish2Request

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/workflows/{workflowId}/unpublish

Load more endpoints

Schemas

string BookmarkOriginBookmarkType

{
  "enum": [
    "unknown",
    "model",
    "workflow",
    "dataset",
    "module"
  ],
  "type": "string",
  "default": "unknown"
}

string CloudRegionCloud

{
  "enum": [
    "UNKOWN_CLOUD",
    "SELF_HOSTED",
    "AWS",
    "GCP",
    "AZURE",
    "LAMBDA"
  ],
  "type": "string",
  "default": "UNKOWN_CLOUD",
  "description": " - SELF_HOSTED: Run on a user's own infrastructure. This has restrictions on who can access resources\nthat are being run by SELF_HOSTED runners. Only those who are part of the user/org where they\nexist can leverage them."
}

string DeploymentSchedulingChoice

{
  "enum": [
    "UNKNOWN_SCHEDULING_CHOICE",
    "FAIL",
    "RANDOM",
    "PRICE",
    "PERFORMANCE",
    "NETWORK",
    "UTILIZATION",
    "PREFER_SPOT",
    "PREFER_ONDEMAND"
  ],
  "type": "string",
  "default": "UNKNOWN_SCHEDULING_CHOICE",
  "description": "In some scenarios it may not be obvous how we should schedule a resource to underlying nodes\nwithin the nodepool(s) above. The SchedulerChoice allows us to specify how to decide which\nnodepool to use when there are multiple nodepools and how to decide which type of node\nwithin a nodepool if there are multiple types.\nIf here are multiple nondepools then a decision on which to use comes into play\nif it is not specified in the prediction request.\nEven with a single nodepool a choice may come up such as when a resource that needs scheduling\nhas not specified the accelerator types it supports and the nodepool has multiple types.\n\n - FAIL: fail if there is any ambiguity.\n - RANDOM: randomly pick amongst the nodepools/nodes to assign.\n - PRICE: choose the compute that is cheaper\n - PERFORMANCE: schedule to the fastest known iption.\n - NETWORK: optimize based on network latency.\n - UTILIZATION: send to the least used nodepool based on it's capacity.\n - PREFER_SPOT: choose spot instances over on-demand\n - PREFER_ONDEMAND: choose on-demand instances over spot."
}

object MatrixUint64

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uint64"
      },
      "description": "Matrix data stored as an array.\nIn order to access matrix element at row i & column j, use data[i*n_cols+j]."
    },
    "nCols": {
      "type": "string",
      "title": "Number of columns",
      "format": "uint64"
    }
  },
  "description": "Store matrix of uint64s values.\nIt is recommended to store the matrix as a 1D array\nbecause it produces less bytes during serialization than a 2D array.\nThe matrix does store the number of columns, but it does not store the number of rows.\nThe number of rows can automatically be calculated as length(data)/n_cols."
}

string ModelTypeFieldModelTypeFieldType

{
  "enum": [
    "INVALID_MODEL_TYPE_FIELD_TYPE",
    "BOOLEAN",
    "STRING",
    "NUMBER",
    "ARRAY_OF_CONCEPTS",
    "ARRAY_OF_CONCEPTS_WITH_THRESHOLD",
    "RANGE",
    "ENUM",
    "COLLABORATORS",
    "JSON",
    "ARRAY_OF_NUMBERS",
    "WORKFLOW_EMBED_MODELS",
    "ARRAY_OF_STRINGS",
    "RECURSIVE_ENUM",
    "PYTHON_CODE",
    "DATASET_ID",
    "DATASET_VERSION_ID",
    "ARRAY_OF_MODEL_CONCEPTS",
    "DATASET",
    "DATASET_VERSION",
    "ENCRYPTED_STRING",
    "CHECKPOINT_MODEL"
  ],
  "type": "string",
  "default": "INVALID_MODEL_TYPE_FIELD_TYPE",
  "description": "These are various types of fields that we have UIs for.\n\n - ARRAY_OF_CONCEPTS: For auto-completing to concepts in the app. This goes into an data.concepts field.\n - ARRAY_OF_CONCEPTS_WITH_THRESHOLD: For auto-completing to concepts in the app. This goes into an data.concepts field.\n - RANGE: A range for a float value.\n - ENUM: If ENUM is used then the \"enum_options\" field should also be filled in with the respective ID and description\nfor the different ENUM options.\n - COLLABORATORS: For listing collaborators of the app. The field is a string of the collaborator's user_id.\n - JSON: For arbitrary json object: \"{...}\"\n - ARRAY_OF_NUMBERS: Such as [1.0, 2.0, 3.5]\n - WORKFLOW_EMBED_MODELS: For selecting the embed_model_version_id for context based models.\n - ARRAY_OF_STRINGS: Such as ['a', 'b', 'cantaloupe']\n - RECURSIVE_ENUM: If RECURSIVE_ENUM is used then the \"enum_options\" field should also be filled in with the respective ID and\ndescription for the different RECURSIVE_ENUM options, as well as model_type_fields for each enum choice.\n - PYTHON_CODE: For blocks of code that need to be specified by the user for setup or execution during workflow runs.\n - DATASET_ID: For selecting a dataset id in model parameters. String in API request.\n - DATASET_VERSION_ID: For selecting a dataset version id. String.\n - ARRAY_OF_MODEL_CONCEPTS: For auto-completing to concepts in the model.\n - DATASET: For selecting a dataset\n - DATASET_VERSION: For selecting a dataset version\n - ENCRYPTED_STRING: To pass a string downstream, that is encrypted in the DB and API.\n - CHECKPOINT_MODEL: For selecting a model version of the same model type to resume training from."
}

object ModuleVersionModuleNav

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "This is the left side title for this module and for browser tab title of the module.\nWe have this in the version so that users can change those settings\nwhen releasing a new version of their module."
    },
    "moduleSubNavs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ModuleVersionModuleSubNav"
      },
      "description": "A list of subnav elements to put under the module title."
    }
  }
}

object ModuleVersionModuleSubNav

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "This is the display title for a navbar element to link to a specific page.\nThe name for this subnav element to show in the sidebar."
    },
    "queryKey": {
      "type": "string",
      "title": "The query param name"
    },
    "queryValue": {
      "type": "string",
      "title": "The query param value"
    }
  }
}

string NodepoolCapacityType

{
  "enum": [
    "UKNOWN_CAPACITY_TYPE",
    "ONDEMAND_TYPE",
    "SPOT_TYPE"
  ],
  "type": "string",
  "default": "UKNOWN_CAPACITY_TYPE",
  "description": "Type of nodes that are ok for instances in this pool.\nIf both spot and on-demand are provided then the runner will be able to run on either\nwith a preference for spot until they are not available."
}

string SearchMetric

{
  "enum": [
    "METRIC_NOT_SET",
    "EUCLIDEAN_DISTANCE",
    "COSINE_DISTANCE"
  ],
  "type": "string",
  "default": "METRIC_NOT_SET",
  "description": "Metric used for search. Can be EUCLIDEAN_DISTANCE (default) or COSINE_DISTANCE.\nCurrently only brute force search supports non-eudlicean metrics."
}

string SplitIntoDatasetsDatasetSplitMethod

{
  "enum": [
    "NOT_SET",
    "RANDOM_PERCENTAGE_SPLIT"
  ],
  "type": "string",
  "title": "- RANDOM_PERCENTAGE_SPLIT: We will randomly split inputs into the datasets",
  "default": "NOT_SET"
}

string TaskInputSourceTaskInputSourceType

{
  "enum": [
    "INPUT_SOURCE_TYPE_NOT_SET",
    "ALL_INPUTS",
    "SAVED_SEARCH",
    "DATASET"
  ],
  "type": "string",
  "default": "INPUT_SOURCE_TYPE_NOT_SET",
  "description": " - ALL_INPUTS: Use all inputs in the app.\n - SAVED_SEARCH: Use the inputs from a saved search.\n - DATASET: Inputs from a dataset."
}

string TaskReviewTaskReviewStrategy

{
  "enum": [
    "TASK_REVIEW_STRATEGY_NOT_SET",
    "NONE",
    "MANUAL",
    "CONSENSUS"
  ],
  "type": "string",
  "default": "TASK_REVIEW_STRATEGY_NOT_SET",
  "description": " - NONE: No review is needed.\n - MANUAL: Manual review strategy.\n - CONSENSUS: Consensus review strategy."
}

string TaskTaskType

{
  "enum": [
    "TYPE_NOT_SET",
    "CONCEPTS_CLASSIFICATION",
    "BOUNDING_BOX_DETECTION",
    "POLYGON_DETECTION"
  ],
  "type": "string",
  "default": "TYPE_NOT_SET",
  "description": " - CONCEPTS_CLASSIFICATION: Concepts classification tasks annotate concepts for the overall image, frame of video or section of text.\n - BOUNDING_BOX_DETECTION: Bounding box detection tasks annotate rectangular bounding box regions around each concept in an image, frame of video or section of text.\n - POLYGON_DETECTION: Polygon detection tasks annotate free-form regions around concepts in an image, frame of video or section of text."
}

string TaskWorkerPartitionedStrategyInfoTaskWorkerPartitionedStrategy

{
  "enum": [
    "PARTITIONED_WORKER_STRATEGY_NOT_SET",
    "EVENLY",
    "WEIGHTED"
  ],
  "type": "string",
  "default": "PARTITIONED_WORKER_STRATEGY_NOT_SET",
  "description": " - EVENLY: Each worker will label (approximately) the same number of inputs.\n - WEIGHTED: Each worker will have an assigned weight.\nSee weights field for more details."
}

string TaskWorkerTaskWorkerStrategy

{
  "enum": [
    "WORKER_STRATEGY_NOT_SET",
    "PARTITIONED",
    "FULL"
  ],
  "type": "string",
  "default": "WORKER_STRATEGY_NOT_SET",
  "description": " - PARTITIONED: The inputs will be partitioned in several partitions.\nEach worker will label one or more input partitions.\n - FULL: Each worker will label all inputs from input source."
}

object V2CancelBulkOperationsRequest

{
  "type": "object",
  "title": "Cancel a list of bulk operation ids",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "List of bulk operation ids to be cancelled"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}

object V2CancelInputsAddJob2Request

{
  "type": "object",
  "properties": {
    "userAppId": {
      "$ref": "#/components/schemas/apiUserAppIDSet"
    }
  }
}

object V2CancelInputsAddJobRequest

{
  "type": "object",
  "properties": {
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}

object V2CancelInputsExtractionJobsRequest

{
  "type": "object",
  "title": "Cancel a list of extraction job ids",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "List of extraction job ids to be cancelled"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}

object V2DeleteAnnotationFiltersRequest

{
  "type": "object",
  "properties": {
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "annotationFilterIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Specify which filters to delete."
    }
  },
  "description": "Request to delete several annotation filters by list of ids."
}

object V2DeleteAnnotations3Request

{
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "Delete annotations with IDs"
    },
    "inputIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "Delete annotations for these Input IDs\nNote that 'ids' are optional but if the are provided the number and order in\n'ids' and 'input_ids' should match\nIf you do not specifiy 'ids' all the annotations for 'input_ids' are deleted\nHowever you need to specify at least one value for 'input_ids'\ni.e. this API does not support deleting all annotations"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  },
  "description": "Request to delete several things by the list of ids."
}

object V2DeleteBulkOperationsRequest

{
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "List of bulk operation ids to be deleted"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  },
  "description": "Request to delete the terminated bulk operations by ID\nOnly operations in terminated state can be deleted."
}

object V2DeleteCollaboratorsRequest

{
  "type": "object",
  "title": "DeleteCollaboratorsRequest",
  "properties": {
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "userEmails": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "collaboratorIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

object V2DeleteCollectorsRequest

{
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "deleteAll": {
      "type": "boolean"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  },
  "description": "Request to delete several things by the list of ids."
}

object V2DeleteConceptRelationsRequest

{
  "type": "object",
  "title": "DELETE concept relations",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The concept relationship ids to delete."
    },
    "userAppId": {
      "type": "object",
      "title": "The user_id and app_id information.",
      "description": "The user_id and app_id information."
    }
  }
}

object V2DeleteDatasetInputs2Request

{
  "type": "object",
  "properties": {
    "inputIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Specify which inputs to delete from dataset."
    },
    "userAppId": {
      "$ref": "#/components/schemas/apiUserAppIDSet"
    }
  },
  "description": "Request to delete several dataset inputs by list of ids."
}

object V2DeleteDatasetInputsRequest

{
  "type": "object",
  "properties": {
    "inputIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Specify which inputs to delete from dataset."
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  },
  "description": "Request to delete several dataset inputs by list of ids."
}

object V2DeleteDatasetVersions2Request

{
  "type": "object",
  "properties": {
    "userAppId": {
      "$ref": "#/components/schemas/apiUserAppIDSet"
    },
    "datasetVersionIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "description": "Request to delete several dataset versions by list of ids."
}

object V2DeleteDatasetVersionsRequest

{
  "type": "object",
  "properties": {
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "datasetVersionIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "description": "Request to delete several dataset versions by list of ids."
}

object V2DeleteDatasetsRequest

{
  "type": "object",
  "properties": {
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "datasetIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "description": "Request to delete several datasets by list of ids."
}

object V2DeleteInputsRequest

{
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  },
  "description": "Request to delete several things by the list of ids."
}

object V2DeleteInstalledModuleVersionsRequest

{
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  },
  "description": "Request to delete several installed module versions by the list of ids."
}

object V2DeleteLabelOrdersRequest

{
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  },
  "description": "Request to delete a list of label orders."
}

object V2DeleteModuleVersionsRequest

{
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  },
  "description": "Request to delete several module versions by the list of ids."
}

object V2DeleteRunnersRequest

{
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "userAppId": {
      "type": "object",
      "properties": {
        "appId": {
          "type": "string"
        }
      },
      "description": "Common message to identify the app in a url endpoint."
    }
  },
  "description": "Request to delete several things by the list of ids."
}

object V2DeleteTasksRequest

{
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  },
  "description": "Request to delete a list of tasks."
}

object V2DeleteUploadsRequest

{
  "type": "object",
  "title": "Stops or deletes multipart upload",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}

object V2DeleteWorkflowVersions2Request

{
  "type": "object",
  "title": "DeleteWorkflowVersionsRequest",
  "properties": {
    "userAppId": {
      "$ref": "#/components/schemas/apiUserAppIDSet"
    },
    "workflowVersionIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "Delete the versions identified by these ids"
    }
  }
}

object V2DeleteWorkflowVersionsRequest

{
  "type": "object",
  "title": "DeleteWorkflowVersionsRequest",
  "properties": {
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "workflowVersionIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "Delete the versions identified by these ids"
    }
  }
}

object V2GenerateModelOutputs2Response

{
  "type": "object",
  "title": "Stream result of apiMultiOutputResponse",
  "properties": {
    "error": {
      "$ref": "#/components/schemas/googlerpcStatus"
    },
    "result": {
      "$ref": "#/components/schemas/apiMultiOutputResponse"
    }
  }
}

object V2GenerateModelOutputsResponse

{
  "type": "object",
  "title": "Stream result of apiMultiOutputResponse",
  "properties": {
    "error": {
      "$ref": "#/components/schemas/googlerpcStatus"
    },
    "result": {
      "$ref": "#/components/schemas/apiMultiOutputResponse"
    }
  }
}

object V2PatchAnnotationFiltersRequest

{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nFor now, only 'overwrite' action is supported"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "annotationFilters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiAnnotationFilter"
      },
      "description": "List of annotation filters that are requested to be updated."
    }
  },
  "description": "Request to patch several annotation filters."
}

object V2PatchAnnotationsRequest

{
  "type": "object",
  "title": "PatchAnnotationsRequest",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "annotations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/clarifaiapiAnnotation"
      }
    },
    "deleteIfEmptyData": {
      "type": "boolean",
      "description": "If the request is a \"remove\" action and the annotation is left with empty data,\nthen setting delete_if_empty_data to true will delete the annotation,\nif possible (for example, will not delete an input-level annotation)."
    }
  }
}

object V2PatchAnnotationsSearchesRequest

{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched Search objects\nFor now only action 'overwrite' is supported"
    },
    "searches": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiSearch"
      },
      "title": "The searches to be patched"
    },
    "userAppId": {
      "type": "object",
      "title": "The user_id and app_id to query from.",
      "description": "The user_id and app_id to query from."
    }
  }
}

object V2PatchAnnotationsStatusRequest

{
  "type": "object",
  "title": "PatchAnnotationsStatusRequest",
  "properties": {
    "action": {
      "type": "string",
      "title": "'overwrite' is supported"
    },
    "userIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "title": "Filter by user IDs"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "statusCode": {
      "$ref": "#/components/schemas/statusStatusCode"
    },
    "statusCodes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/statusStatusCode"
      },
      "title": "Filter by Status codes"
    }
  }
}

object V2PatchAppRequest

{
  "type": "object",
  "title": "PatchAppRequest",
  "properties": {
    "app": {
      "$ref": "#/components/schemas/apiApp"
    },
    "action": {
      "type": "string",
      "description": "The action to perform on the patched App object except App.Metadata\nSupported values: 'overwrite' and 'remove'.\n\nNote that 'remove' can only be used to remove the app image by setting\n'image.url' in the request to the current value returned for the app."
    },
    "reindex": {
      "type": "boolean",
      "description": "If set, the app will be automatically reindexed upon change of its base workflow."
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "metadataAction": {
      "$ref": "#/components/schemas/apiPatchAction"
    }
  }
}

object V2PatchAppsIdsRequest

{
  "type": "object",
  "title": "PatchAppsIdsRequest",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiIdUpdateSource"
      },
      "title": "Array containing 1 entry"
    },
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nOnly 'overwrite' is supported"
    },
    "userAppId": {
      "type": "object",
      "properties": {
        "appId": {
          "type": "string"
        }
      },
      "description": "Common message to identify the app in a url endpoint."
    }
  }
}

object V2PatchAppsRequest

{
  "type": "object",
  "title": "PatchAppsRequest",
  "properties": {
    "apps": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiApp"
      }
    },
    "action": {
      "type": "string",
      "description": "The action to perform on the patched App objects except App.Metadata\nSupported values: 'overwrite' and 'remove'.\n\nNote that 'remove' can only be used to remove the app image by setting\n'image.url' in the request to the current value returned for that app."
    },
    "reindex": {
      "type": "boolean",
      "description": "If set, the app will be automatically reindexed upon change of its base workflow."
    },
    "userAppId": {
      "type": "object",
      "properties": {
        "appId": {
          "type": "string"
        }
      },
      "description": "Common message to identify the app in a url endpoint."
    },
    "metadataAction": {
      "$ref": "#/components/schemas/apiPatchAction"
    }
  }
}

object V2PatchCollaboratorsRequest

{
  "type": "object",
  "title": "PatchCollaboratorsRequest",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nFor now only action 'overwrite' is supported"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "collaborators": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiCollaborator"
      }
    }
  }
}

object V2PatchCollectorsRequest

{
  "type": "object",
  "title": "PatchCollectorsRequest",
  "properties": {
    "action": {
      "type": "string",
      "title": "The action to perform on the patched objects\nOnly 'overwrite' is supported"
    },
    "userAppId": {
      "type": "object",
      "description": "Common message to identify the app in a url endpoint."
    },
    "collectors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiCollector"
      }
    }
  }
}

Load more schemas

Versions

Version	Endpoints	Schemas	Ingested	Status
version not set	400	543	2026-05-11	current
version not set	400	543	2026-04-16