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 57 endpoints

PATCH /v2/annotation_filters Patch one or more annotation filters.

operationId: V2_PatchAnnotationFilters2

Request Body

required

Request to patch several annotation filters.

application/json

schema apiPatchAnnotationFiltersRequest

Property	Type	Required
action	string	optional
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.

PATCH /v2/annotation_filters

PATCH /v2/annotations Patch one or more annotations.

operationId: V2_PatchAnnotations2

Request Body

required

application/json

schema apiPatchAnnotationsRequest

Property	Type	Required
action	string	optional
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
deleteIfEmptyData	boolean	optional

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/annotations

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

operationId: V2_PatchAnnotationsSearches2

Request Body

required

application/json

schema apiPatchAnnotationsSearchesRequest

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

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/annotations/searches

PATCH /v2/bulk_operations Cancel one or more bulk operations

operationId: V2_CancelBulkOperations2

Request Body

required

application/json

schema apiCancelBulkOperationRequest

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

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/bulk_operations

PATCH /v2/collectors Patch one or more collectors.

operationId: V2_PatchCollectors2

Request Body

required

application/json

schema apiPatchCollectorsRequest

Property	Type	Required
action	string	optional
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.

PATCH /v2/collectors

PATCH /v2/concepts Patch one or more concepts.

operationId: V2_PatchConcepts2

Request Body

required

application/json

schema apiPatchConceptsRequest

Property	Type	Required
action	string	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
└ 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.

PATCH /v2/concepts

PATCH /v2/concepts/{conceptId}/languages Patch the name for a given language names by passing in a list of concepts with the new names for the languages.

operationId: V2_PatchConceptLanguages2

Parameters

Name	In	Required	Type	Description
conceptId	path	required	string	—

Request Body

required

application/json

schema V2PatchConceptLanguages2Request

Property	Type	Required
action	string	optional
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.

PATCH /v2/concepts/{conceptId}/languages

PATCH /v2/datasets Patch one or more datasets. The process is atomic, i.e. either all or no datasets are patched. If there is an error for one dataset, the process will stop, revert the transaction and return the error.

operationId: V2_PatchDatasets2

Request Body

required

Request to patch several datasets.

application/json

schema apiPatchDatasetsRequest

Property	Type	Required
action	string	optional
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.

PATCH /v2/datasets

PATCH /v2/datasets/{datasetId}/versions Patch one or more dataset versions.

operationId: V2_PatchDatasetVersions2

Parameters

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

Request Body

required

application/json

schema V2PatchDatasetVersions2Request

Property	Type	Required
action	string	optional
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.

PATCH /v2/datasets/{datasetId}/versions

PATCH /v2/inputs Patch one or more inputs.

operationId: V2_PatchInputs2

Request Body

required

application/json

schema apiPatchInputsRequest

Property	Type	Required
action	string	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

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/inputs

PATCH /v2/inputs/jobs/add/{id} cancel the input add job by ID

operationId: V2_CancelInputsAddJob2

Parameters

Name	In	Required	Type	Description
id	path	required	string	id of add inputs job to be cancelled

Request Body

required

application/json

schema V2CancelInputsAddJob2Request

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

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/inputs/jobs/add/{id}

PATCH /v2/inputs/jobs/extraction

operationId: V2_CancelInputsExtractionJobs2

Request Body

required

application/json

schema apiCancelInputsExtractionJobsRequest

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

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/inputs/jobs/extraction

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

operationId: V2_PatchInputsSearches2

Request Body

required

application/json

schema apiPatchInputsSearchesRequest

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

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/inputs/searches

PATCH /v2/label_orders Patch one or more label orders.

operationId: V2_PatchLabelOrders2

Request Body

required

Request to patch a list of label orders.

application/json

schema apiPatchLabelOrdersRequest

Property	Type	Required
action	string	optional
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.

PATCH /v2/label_orders

PATCH /v2/models Patch one or more models.

operationId: V2_PatchModels2

Request Body

required

application/json

schema apiPatchModelsRequest

Property	Type	Required
action	string	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.

PATCH /v2/models

PATCH /v2/models/{modelId}/check_consents Update model check consents

operationId: V2_PatchModelCheckConsents2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	the model id

Request Body

required

application/json

schema V2PatchModelCheckConsents2Request

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

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/models/{modelId}/check_consents

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

operationId: V2_PatchModelLanguages2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—

Request Body

required

application/json

schema V2PatchModelLanguages2Request

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

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/models/{modelId}/languages

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

operationId: V2_PatchModelToolkits2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—

Request Body

required

application/json

schema V2PatchModelToolkits2Request

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

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/models/{modelId}/toolkits

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

operationId: V2_PatchModelUseCases2

Parameters

Name	In	Required	Type	Description
modelId	path	required	string	—

Request Body

required

application/json

schema V2PatchModelUseCases2Request

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

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/models/{modelId}/usecases

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

operationId: V2_PatchSearches2

Request Body

required

application/json

schema apiPatchSearchesRequest

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

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/searches

PATCH /v2/tasks Patch one or more tasks.

operationId: V2_PatchTasks2

Request Body

required

Request to patch a list of tasks.

application/json

schema apiPatchTasksRequest

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

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/tasks

PATCH /v2/users/{userAppId.userId}/apps Patch one or more apps.

operationId: V2_PatchApps

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 V2PatchAppsRequest

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
action	string	optional
reindex	boolean	optional
userAppId	object	optional
└ appId	string	optional
metadataAction	object	optional
└ op	string	optional
└ path	string	optional
└ mergeConflictResolution	string	optional

Responses

default

An unexpected error response.

200

A successful response.

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

PATCH /v2/users/{userAppId.userId}/apps/ids Patch apps ids.

operationId: V2_PatchAppsIds

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 V2PatchAppsIdsRequest

Property	Type	Required
ids	array	optional
└ id	string	optional
└ newId	string	optional
action	string	optional
userAppId	object	optional
└ appId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/users/{userAppId.userId}/apps/ids

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId} Patch one app.

operationId: V2_PatchApp

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 V2PatchAppRequest

Property	Type	Required
app	object	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
action	string	optional
reindex	boolean	optional
userAppId	object	optional
metadataAction	object	optional
└ op	string	optional
└ path	string	optional
└ mergeConflictResolution	string	optional

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/annotation_filters Patch one or more annotation filters.

operationId: V2_PatchAnnotationFilters

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 V2PatchAnnotationFiltersRequest

Property	Type	Required
action	string	optional
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.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/annotations Patch one or more annotations.

operationId: V2_PatchAnnotations

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 V2PatchAnnotationsRequest

Property	Type	Required
action	string	optional
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
deleteIfEmptyData	boolean	optional

Responses

default

An unexpected error response.

200

A successful response.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/annotations/searches Patch saved annotations searches by ids.

operationId: V2_PatchAnnotationsSearches

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

application/json

schema V2PatchAnnotationsSearchesRequest

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

Responses

default

An unexpected error response.

200

A successful response.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/bulk_operations Cancel one or more bulk operations

operationId: V2_CancelBulkOperations

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 V2CancelBulkOperationsRequest

Property	Type	Required
ids	array	optional
userAppId	object	optional

Responses

default

An unexpected error response.

200

A successful response.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/collaborators Patch existing collaborators.

operationId: V2_PatchCollaborators

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 V2PatchCollaboratorsRequest

Property	Type	Required
action	string	optional
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.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/collectors Patch one or more collectors.

operationId: V2_PatchCollectors

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 V2PatchCollectorsRequest

Property	Type	Required
action	string	optional
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.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/concepts Patch one or more concepts.

operationId: V2_PatchConcepts

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 V2PatchConceptsRequest

Property	Type	Required
action	string	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
└ k1	integer	optional
└ k2	integer	optional
└ keypointNames	array	optional
userAppId	object	optional

Responses

default

An unexpected error response.

200

A successful response.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/concepts/{conceptId}/languages Patch the name for a given language names by passing in a list of concepts with the new names for the languages.

operationId: V2_PatchConceptLanguages

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 V2PatchConceptLanguagesRequest

Property	Type	Required
action	string	optional
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.

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

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

operationId: V2_PatchDatasets

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 V2PatchDatasetsRequest

Property	Type	Required
action	string	optional
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.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/datasets/{datasetId}/versions Patch one or more dataset versions.

operationId: V2_PatchDatasetVersions

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 V2PatchDatasetVersionsRequest

Property	Type	Required
action	string	optional
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.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/inputs Patch one or more inputs.

operationId: V2_PatchInputs

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 V2PatchInputsRequest

Property	Type	Required
action	string	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

Responses

default

An unexpected error response.

200

A successful response.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/inputs/jobs/add/{id} cancel the input add job by ID

operationId: V2_CancelInputsAddJob

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 of add inputs job to be cancelled

Request Body

required

application/json

schema V2CancelInputsAddJobRequest

Property	Type	Required
userAppId	object	optional

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/inputs/jobs/add/{id}

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/inputs/jobs/extraction

operationId: V2_CancelInputsExtractionJobs

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 V2CancelInputsExtractionJobsRequest

Property	Type	Required
ids	array	optional
userAppId	object	optional

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/inputs/jobs/extraction

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/inputs/searches Patch saved inputs searches by ids.

operationId: V2_PatchInputsSearches

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

application/json

schema V2PatchAnnotationsSearchesRequest

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

Responses

default

An unexpected error response.

200

A successful response.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/label_orders Patch one or more label orders.

operationId: V2_PatchLabelOrders

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 V2PatchLabelOrdersRequest

Property	Type	Required
action	string	optional
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.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models Patch one or more models.

operationId: V2_PatchModels

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 V2PatchModelsRequest

Property	Type	Required
action	string	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.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/ids Patch one or more models ids.

operationId: V2_PatchModelIds

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 V2PatchModelIdsRequest

Property	Type	Required
ids	array	optional
└ id	string	optional
└ newId	string	optional
action	string	optional
userAppId	object	optional

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/ids

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/check_consents Update model check consents

operationId: V2_PatchModelCheckConsents

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	the model id

Request Body

required

application/json

schema V2PatchModelCheckConsentsRequest

Property	Type	Required
action	string	optional
userAppId	object	optional
checkConsents	array	optional

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/check_consents

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/languages Update model languages tags

operationId: V2_PatchModelLanguages

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 V2PatchModelLanguagesRequest

Property	Type	Required
action	string	optional
languages	array	optional
userAppId	object	optional

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/languages

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/toolkits Update model toolkits tags

operationId: V2_PatchModelToolkits

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 V2PatchModelToolkitsRequest

Property	Type	Required
action	string	optional
toolkits	array	optional
userAppId	object	optional

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/toolkits

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/usecases Update model use_cases tags

operationId: V2_PatchModelUseCases

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 V2PatchModelUseCasesRequest

Property	Type	Required
action	string	optional
usecases	array	optional
userAppId	object	optional

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/usecases

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/versions PatchModelVersions

operationId: V2_PatchModelVersions

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 V2PatchModelVersionsRequest

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

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/versions

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/modules Patch one or more modules.

operationId: V2_PatchModules

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 V2PatchModulesRequest

Property	Type	Required
action	string	optional
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.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/modules/{moduleId}/versions Modify details of an existing module version.

operationId: V2_PatchModuleVersions

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 V2PatchModuleVersionsRequest

Property	Type	Required
action	string	optional
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.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/searches Patch saved legacy searches by ids.

operationId: V2_PatchSearches

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 V2PatchSearchesRequest

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

Responses

default

An unexpected error response.

200

A successful response.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/task/{taskId}/annotations/status Patch annotations status by worker id and task id.

operationId: V2_PatchAnnotationsStatus

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	—
taskId	path	required	string	Filter by task ID

Request Body

required

application/json

schema V2PatchAnnotationsStatusRequest

Property	Type	Required
action	string	optional
userIds	array	optional
userAppId	object	optional
statusCode	string	optional
statusCodes	array	optional

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/task/{taskId}/annotations/status

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/tasks Patch one or more tasks.

operationId: V2_PatchTasks

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 V2PatchTasksRequest

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

Responses

default

An unexpected error response.

200

A successful response.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows Patch one or more workflows.

operationId: V2_PatchWorkflows

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 V2PatchWorkflowsRequest

Property	Type	Required
action	string	optional
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.

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

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows/ids Patch one or more workflows ids.

operationId: V2_PatchWorkflowIds

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 V2PatchWorkflowIdsRequest

Property	Type	Required
ids	array	optional
└ id	string	optional
└ newId	string	optional
action	string	optional
userAppId	object	optional

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows/ids

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows/{workflowId}/versions Patch workflow versions.

operationId: V2_PatchWorkflowVersions

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	The id of the workflow that has the requested versions to patch.

Request Body

required

application/json

schema V2PatchWorkflowVersionsRequest

Property	Type	Required
action	string	optional
userAppId	object	optional
workflowVersions	array	optional
└ id	string	optional
└ appId	string	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
└ 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

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/users/{userAppId.userId}/apps/{userAppId.appId}/workflows/{workflowId}/versions

PATCH /v2/users/{userAppId.userId}/keys Patch one or more keys.

operationId: V2_PatchKeys

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 V2PatchKeysRequest

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
action	string	optional
userAppId	object	optional
└ appId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

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

PATCH /v2/workflows Patch one or more workflows.

operationId: V2_PatchWorkflows2

Request Body

required

application/json

schema apiPatchWorkflowsRequest

Property	Type	Required
action	string	optional
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.

PATCH /v2/workflows

PATCH /v2/workflows/{workflowId}/versions Patch workflow versions.

operationId: V2_PatchWorkflowVersions2

Parameters

Name	In	Required	Type	Description
workflowId	path	required	string	The id of the workflow that has the requested versions to patch.

Request Body

required

application/json

schema V2PatchWorkflowVersions2Request

Property	Type	Required
action	string	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
workflowVersions	array	optional
└ id	string	optional
└ appId	string	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
└ 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

Responses

default

An unexpected error response.

200

A successful response.

PATCH /v2/workflows/{workflowId}/versions

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