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

GET POST PUT PATCH DELETE

V2 50 endpoints

DELETE /v2/annotation_filters Delete one or more annotation filters in a single request.

operationId: V2_DeleteAnnotationFilters2

Request Body

required

Request to delete several annotation filters by list of ids.

application/json

schema apiDeleteAnnotationFiltersRequest

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

Responses

default

An unexpected error response.

200

A successful response.

DELETE /v2/annotation_filters

GET /v2/annotation_filters List all the annotation filters.

operationId: V2_ListAnnotationFilters2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/annotation_filters

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

POST /v2/annotation_filters Add annotation filters.

operationId: V2_PostAnnotationFilters2

Request Body

required

Request to add one or more annotation filters.

application/json

schema apiPostAnnotationFiltersRequest

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
annotationFilters	array	optional
└ id	string	optional
└ appId	string	optional
└ search	object	optional
└ id	string	optional
└ asOf	string	optional
└ name	string	optional
└ save	boolean	optional
└ query	object	optional
└ ands	array	optional
└ ranks	array	optional
└ filters	array	optional
└ language	string	optional
└ metric	string	optional
└ gitHash	string	optional
└ minValue	number	optional
└ algorithm	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ applicationId	string	optional
└ userId	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/annotation_filters

GET /v2/annotation_filters/{annotationFilterId} Get a specific annotation filter.

operationId: V2_GetAnnotationFilter2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/annotation_filters/{annotationFilterId}

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

operationId: V2_DeleteAnnotations4

Request Body

Request to delete several things by the list of ids.

application/json

schema apiDeleteAnnotationsRequest

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

Responses

default

An unexpected error response.

200

A successful response.

DELETE /v2/annotations

GET /v2/annotations List all the annotation.

operationId: V2_ListAnnotations2

Parameters

Name	In	Required	Type	Description
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
ids	query	optional	array	List annotations for these IDs
inputIds	query	optional	array	List annotations for these Input IDs Note that ‘ids’ are optional but if the are provided the number and order in ‘ids’ and ‘input_ids’ should match If you do not specify ‘ids’ all the annotations for ‘input_ids’ are returned If a you do not specify both ‘input_ids’ and ‘ids’ all the annotations in the app are returned
userIds	query	optional	array	Only return the annotations that has one of these user IDs, effectively operating as an OR among them to filter down the results. If model_version_ids are also provided these user_ids are OR’d with them as well since annotations are either provided by users or model versions and we want the union of any provided user or model version annotations in the results of ListAnnotations request. If no user_ids are provided then annotations from all users are returned.
modelVersionIds	query	optional	array	Only return the annotations that has one of these model version IDs, effectively operating as an OR among them to filter down the results. If user_ids are also provided these model_versions_ids are OR’d with them as well since annotations are either provided by users or model versions and we want the union of any provided user or model version annotations in the results of ListAnnotations request. If no model_version_ids are provided then annotations from all model versions are returned.
listAllAnnotations	query	optional	boolean	Set this flag to list both trusted and not trusted annotations by default it’s listing only trusted annotations
returnModelOutput	query	optional	boolean	Set this flag to return the model output for model annotations in the response.
page	query	optional	integer	(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.
perPage	query	optional	integer	(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.
taskId	query	optional	string	Flag to filter annotations by task_id

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/annotations

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

POST /v2/annotations Post annotations.

operationId: V2_PostAnnotations2

Request Body

required

application/json

schema apiPostAnnotationsRequest

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
annotations	array	optional
└ id	string	optional
└ data	object	optional
└ geo	object	optional
└ geoBox	array	optional
└ geoLimit	object	optional
└ geoPoint	object	optional
└ hits	array	optional
└ appId	string	optional
└ input	object	optional
└ score	number	optional
└ userId	string	optional
└ annotation	object	optional
└ text	object	optional
└ raw	string	optional
└ url	string	optional
└ hosted	object	optional
└ textInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ audio	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ audioInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ image	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ imageInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ video	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ videoInfo	object	optional
└ thumbnailUrl	string	optional
└ hostedThumbnail	object	optional
└ allowDuplicateUrl	boolean	optional
└ colors	array	optional
└ w3c	object	optional
└ value	number	optional
└ rawHex	string	optional
└ frames	array	optional
└ id	string	optional
└ data	object	optional
└ frameInfo	object	optional
└ tracks	array	optional
└ id	string	optional
└ data	object	optional
└ quality	number	optional
└ timeInfo	object	optional
└ regions	array	optional
└ id	string	optional
└ data	object	optional
└ value	number	optional
└ trackId	string	optional
└ regionInfo	object	optional
└ clusters	array	optional
└ id	string	optional
└ hits	array	optional
└ count	integer	optional
└ score	number	optional
└ projection	array	optional
└ concepts	array	optional
└ id	string	optional
└ name	string	optional
└ appId	string	optional
└ value	number	optional
└ userId	string	optional
└ vocabId	string	optional
└ language	string	optional
└ createdAt	string	optional
└ extraInfo	object	optional
└ definition	string	optional
└ visibility	object	optional
└ keypointInfo	object	optional
└ heatmaps	array	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ imageInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ metadata	object	optional
└ embeddings	array	optional
└ vector	array	optional
└ numDimensions	integer	optional
└ timeSegments	array	optional
└ id	string	optional
└ data	object	optional
└ timeInfo	object	optional
└ status	object	optional
└ code	string	optional
└ reqId	string	optional
└ details	string	optional
└ stackTrace	array	optional
└ description	string	optional
└ redirectInfo	object	optional
└ url	string	optional
└ resourceType	string	optional
└ newResourceId	string	optional
└ oldResourceId	string	optional
└ timeRemaining	integer	optional
└ developerNotes	string	optional
└ internalDetails	string	optional
└ percentCompleted	integer	optional
└ taskId	string	optional
└ userId	string	optional
└ inputId	string	optional
└ trusted	boolean	optional
└ createdAt	string	optional
└ inputLevel	boolean	optional
└ modifiedAt	string	optional
└ consensusInfo	object	optional
└ annotationInfo	object	optional
└ modelVersionId	string	optional
└ workflowVersionId	string	optional
└ embedModelVersionId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/annotations

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

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

operationId: V2_PostAnnotationsSearches2

Request Body

required

application/json

schema apiPostAnnotationsSearchesRequest

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

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/annotations/searches

GET /v2/annotations/searches/metrics List the evaluation results between two search requests

operationId: V2_ListAnnotationSearchMetrics2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/annotations/searches/metrics

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

operationId: V2_PostAnnotationSearchMetrics2

Request Body

required

application/json

schema apiPostAnnotationSearchMetricsRequest

Property	Type	Required
id	string	optional
data	object	optional
└ geo	object	optional
└ geoBox	array	optional
└ geoPoint	object	optional
└ geoLimit	object	optional
└ type	string	optional
└ value	number	optional
└ geoPoint	object	optional
└ latitude	number	optional
└ longitude	number	optional
└ hits	array	optional
└ appId	string	optional
└ input	object	optional
└ id	string	optional
└ data	object	optional
└ status	object	optional
└ createdAt	string	optional
└ datasetIds	array	optional
└ modifiedAt	string	optional
└ score	number	optional
└ userId	string	optional
└ annotation	object	optional
└ id	string	optional
└ data	object	optional
└ status	object	optional
└ taskId	string	optional
└ userId	string	optional
└ inputId	string	optional
└ trusted	boolean	optional
└ createdAt	string	optional
└ inputLevel	boolean	optional
└ modifiedAt	string	optional
└ consensusInfo	object	optional
└ annotationInfo	object	optional
└ modelVersionId	string	optional
└ workflowVersionId	string	optional
└ embedModelVersionId	string	optional
└ text	object	optional
└ raw	string	optional
└ url	string	optional
└ hosted	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ textInfo	object	optional
└ encoding	string	optional
└ charCount	integer	optional
└ allowDuplicateUrl	boolean	optional
└ audio	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ audioInfo	object	optional
└ bitRate	integer	optional
└ sampleRate	integer	optional
└ audioFormat	string	optional
└ durationSeconds	number	optional
└ allowDuplicateUrl	boolean	optional
└ image	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ imageInfo	object	optional
└ width	integer	optional
└ format	string	optional
└ height	integer	optional
└ colorMode	string	optional
└ allowDuplicateUrl	boolean	optional
└ video	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ videoInfo	object	optional
└ fps	number	optional
└ width	integer	optional
└ height	integer	optional
└ bitRate	integer	optional
└ frameCount	integer	optional
└ videoFormat	string	optional
└ durationSeconds	number	optional
└ thumbnailUrl	string	optional
└ hostedThumbnail	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ allowDuplicateUrl	boolean	optional
└ colors	array	optional
└ w3c	object	optional
└ hex	string	optional
└ name	string	optional
└ value	number	optional
└ rawHex	string	optional
└ frames	array	optional
└ id	string	optional
└ data	object	optional
└ frameInfo	object	optional
└ time	integer	optional
└ index	integer	optional
└ tracks	array	optional
└ id	string	optional
└ data	object	optional
└ quality	number	optional
└ timeInfo	object	optional
└ endTime	number	optional
└ beginTime	number	optional
└ numFrames	integer	optional
└ regions	array	optional
└ id	string	optional
└ data	object	optional
└ value	number	optional
└ trackId	string	optional
└ regionInfo	object	optional
└ mask	object	optional
└ span	object	optional
└ point	object	optional
└ token	object	optional
└ polygon	object	optional
└ boundingBox	object	optional
└ keypointLocations	array	optional
└ clusters	array	optional
└ id	string	optional
└ hits	array	optional
└ appId	string	optional
└ input	object	optional
└ score	number	optional
└ userId	string	optional
└ annotation	object	optional
└ count	integer	optional
└ score	number	optional
└ projection	array	optional
└ concepts	array	optional
└ id	string	optional
└ name	string	optional
└ appId	string	optional
└ value	number	optional
└ userId	string	optional
└ vocabId	string	optional
└ language	string	optional
└ createdAt	string	optional
└ extraInfo	object	optional
└ isRankable	boolean	optional
└ definition	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ keypointInfo	object	optional
└ skeleton	array	optional
└ keypointNames	array	optional
└ heatmaps	array	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ imageInfo	object	optional
└ width	integer	optional
└ format	string	optional
└ height	integer	optional
└ colorMode	string	optional
└ allowDuplicateUrl	boolean	optional
└ metadata	object	optional
└ embeddings	array	optional
└ vector	array	optional
└ numDimensions	integer	optional
└ timeSegments	array	optional
└ id	string	optional
└ data	object	optional
└ timeInfo	object	optional
└ endTime	number	optional
└ beginTime	number	optional
└ numFrames	integer	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
groundTruth	object	optional
└ id	string	optional
└ asOf	string	optional
└ name	string	optional
└ save	boolean	optional
└ query	object	optional
└ ands	array	optional
└ input	object	optional
└ negate	boolean	optional
└ output	object	optional
└ annotation	object	optional
└ ranks	array	optional
└ negate	boolean	optional
└ annotation	object	optional
└ filters	array	optional
└ input	object	optional
└ negate	boolean	optional
└ annotation	object	optional
└ lastUpdatedTimeRange	object	optional
└ language	string	optional
└ metric	string	optional
└ gitHash	string	optional
└ minValue	number	optional
└ algorithm	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ applicationId	string	optional
searchToEval	object	optional
└ id	string	optional
└ asOf	string	optional
└ name	string	optional
└ save	boolean	optional
└ query	object	optional
└ ands	array	optional
└ input	object	optional
└ negate	boolean	optional
└ output	object	optional
└ annotation	object	optional
└ ranks	array	optional
└ negate	boolean	optional
└ annotation	object	optional
└ filters	array	optional
└ input	object	optional
└ negate	boolean	optional
└ annotation	object	optional
└ lastUpdatedTimeRange	object	optional
└ language	string	optional
└ metric	string	optional
└ gitHash	string	optional
└ minValue	number	optional
└ algorithm	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ applicationId	string	optional
evaluationType	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/annotations/searches/metrics

DELETE /v2/annotations/searches/metrics/{id} DeleteAnnotationSearchMetrics

operationId: V2_DeleteAnnotationSearchMetrics2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

DELETE /v2/annotations/searches/metrics/{id}

GET /v2/annotations/searches/metrics/{id} Get the evaluation results between two search requests

operationId: V2_GetAnnotationSearchMetrics2

Parameters

Name	In	Required	Type	Description
id	path	required	string	Unique custom facing id that identifies the eval to get
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/annotations/searches/metrics/{id}

GET /v2/annotations/workers ListAnnotationWorkers lists users, models, and workflows (collectively known as "workers") that have added annotations to the application.

operationId: V2_ListAnnotationWorkers2

Parameters

Name	In	Required	Type	Description
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
page	query	optional	integer	(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.
perPage	query	optional	integer	(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.
additionalFields	query	optional	array	(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, names
trustedOnly	query	optional	boolean	(optional URL parameter) Only list workers that have created trusted annotations.

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/annotations/workers

GET /v2/app Get a specific app from an app.

operationId: V2_GetApp2

Parameters

Name	In	Required	Type	Description
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
additionalFields	query	optional	array	(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/app

GET /v2/apps List all the apps.

operationId: V2_ListApps2

Parameters

Name	In	Required	Type	Description
userAppId.userId	query	optional	string	Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId	query	optional	string	—
page	query	optional	integer	(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1.
perPage	query	optional	integer	(optional URL parameter) The number of results that will be contained in each page. Defaults to 128.
additionalFields	query	optional	array	(optional URL parameter) List of additional fields to be included in the response. Currently supported: all, stars
sortAscending	query	optional	boolean	Sorting options: Whether to sort in ascending order. If false, will order in descending order.
sortByName	query	optional	boolean	Whether to order by the name
sortByModifiedAt	query	optional	boolean	Whether to order by the modified_at time. If none of the sort options is set to true, will sort by modified_at.
sortByCreatedAt	query	optional	boolean	Whether to order by the created_at time.
sortByStarCount	query	optional	boolean	Whether to order by the number of users stared the app
featuredOnly	query	optional	boolean	Filtering options: If true, we only return apps that are handpicked by clarifai staff
starredOnly	query	optional	boolean	If true, we only return apps that are starred by the requesting user
templateOnly	query	optional	boolean	If true, we only return apps that are marked as a template by the app owner.
search	query	optional	string	Searching options: Specify a search parameter in order to perform keyword search on the following fields of the application: id name description notes user_id (unless user_app_id.user_id is already set) Keywords are both normalized for search (so searching for “satisfy” matches “satisfied”) and used for partial prefix-matching (so searching for “clari” matches “clarifai”). NOTE: Both the list of fields searched and the exact keyword matching rules are subject to change and not guaranteed to be backwards-compatible.
query	query	optional	string	Query various text fields (id, name, description, and notes) that can contain the words in the query string Deprecated: use search instead.
name	query	optional	string	Filter by the id, name and notes of the app. This supports wilcard queries like “gen*” to match “general” as an example. Deprecated: use search instead.
id	query	optional	string	Filter by the user-unique-id of the app. This supports wilcard queries like “gen*” to match “general” as an example. Deprecated: use search instead.

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/apps

DELETE /v2/bulk_operations delete one or more terminated bulk operations

operationId: V2_DeleteBulkOperations2

Request Body

required

Request to delete the terminated bulk operations by ID
Only operations in terminated state can be deleted.

application/json

schema apiDeleteBulkOperationRequest

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

Responses

default

An unexpected error response.

200

A successful response.

DELETE /v2/bulk_operations

GET /v2/bulk_operations List all the bulk operations

operationId: V2_ListBulkOperations2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/bulk_operations

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

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

operationId: V2_PostBulkOperations2

Request Body

required

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

application/json

schema apiPostBulkOperationsRequest

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
bulkOperations	array	optional
└ id	string	optional
└ appId	string	optional
└ search	object	optional
└ id	string	optional
└ asOf	string	optional
└ name	string	optional
└ save	boolean	optional
└ query	object	optional
└ ands	array	optional
└ ranks	array	optional
└ filters	array	optional
└ language	string	optional
└ metric	string	optional
└ gitHash	string	optional
└ minValue	number	optional
└ algorithm	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ applicationId	string	optional
└ status	object	optional
└ code	string	optional
└ reqId	string	optional
└ details	string	optional
└ stackTrace	array	optional
└ description	string	optional
└ redirectInfo	object	optional
└ url	string	optional
└ resourceType	string	optional
└ newResourceId	string	optional
└ oldResourceId	string	optional
└ timeRemaining	integer	optional
└ developerNotes	string	optional
└ internalDetails	string	optional
└ percentCompleted	integer	optional
└ dataset	object	optional
└ id	string	optional
└ appId	string	optional
└ image	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ imageInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ id	string	optional
└ appId	string	optional
└ status	object	optional
└ userId	string	optional
└ metrics	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ datasetId	string	optional
└ exportInfo	object	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ description	string	optional
└ processingInfo	object	optional
└ modelPredictConfig	object	optional
└ embedModelVersionIds	array	optional
└ annotationFilterConfig	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ bookmarkOrigin	object	optional
└ id	string	optional
└ appId	string	optional
└ userId	string	optional
└ resourceType	string	optional
└ defaultProcessingInfo	object	optional
└ frameInterpolationInfo	object	optional
└ defaultAnnotationFilter	object	optional
└ id	string	optional
└ appId	string	optional
└ search	object	optional
└ userId	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ inputIds	object	optional
└ inputIds	array	optional
└ progress	object	optional
└ processed	integer	optional
└ lastProcessedId	string	optional
└ createdAt	string	optional
└ createdBy	string	optional
└ operation	object	optional
└ deleteGeo	object	optional
└ addConcepts	object	optional
└ concepts	array	optional
└ addMetadata	object	optional
└ metadata	object	optional
└ addToDataset	object	optional
└ datasetId	string	optional
└ overwriteGeo	object	optional
└ geo	object	optional
└ deleteConcepts	object	optional
└ userIds	array	optional
└ concepts	array	optional
└ deleteMetadata	object	optional
└ metadata	object	optional
└ deleteFromDataset	object	optional
└ datasetId	string	optional
└ splitIntoDatasets	object	optional
└ method	string	optional
└ datasetSplits	array	optional
└ lastModifiedAt	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/bulk_operations

GET /v2/bulk_operations/{id} Get the bulk operation details by ID

operationId: V2_GetBulkOperation2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/bulk_operations/{id}

DELETE /v2/collectors Delete multiple collectors in one request. This call is asynchronous. Use DeleteCollector if you want a synchronous version.

operationId: V2_DeleteCollectors2

Request Body

required

Request to delete several things by the list of ids.

application/json

schema apiDeleteCollectorsRequest

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

Responses

default

An unexpected error response.

200

A successful response.

DELETE /v2/collectors

GET /v2/collectors List all the collectors.

operationId: V2_ListCollectors2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/collectors

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

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

operationId: V2_PostCollectors2

Request Body

required

Request to create Collectors.

application/json

schema apiPostCollectorsRequest

Property	Type	Required
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
collectors	array	optional
└ id	string	optional
└ status	object	optional
└ code	string	optional
└ reqId	string	optional
└ details	string	optional
└ stackTrace	array	optional
└ description	string	optional
└ redirectInfo	object	optional
└ url	string	optional
└ resourceType	string	optional
└ newResourceId	string	optional
└ oldResourceId	string	optional
└ timeRemaining	integer	optional
└ developerNotes	string	optional
└ internalDetails	string	optional
└ percentCompleted	integer	optional
└ createdAt	string	optional
└ description	string	optional
└ collectOutputs	boolean	optional
└ collectorSource	object	optional
└ apiPostModelOutputsCollectorSource	object	optional
└ modelId	string	optional
└ modelAppId	string	optional
└ modelUserId	string	optional
└ callerUserId	string	optional
└ modelVersionId	string	optional
└ postInputsKeyId	string	optional
└ preQueueWorkflowId	string	optional
└ postQueueWorkflowId	string	optional
└ preQueueRandomSample	number	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/collectors

GET /v2/collectors/{collectorId} Get a specific collector from an app.

operationId: V2_GetCollector2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/collectors/{collectorId}

GET /v2/concepts List all the concepts.

operationId: V2_ListConcepts2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/concepts

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

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

operationId: V2_PostConcepts2

Request Body

required

application/json

schema apiPostConceptsRequest

Property	Type	Required
concepts	array	optional
└ id	string	optional
└ name	string	optional
└ appId	string	optional
└ value	number	optional
└ userId	string	optional
└ vocabId	string	optional
└ language	string	optional
└ createdAt	string	optional
└ extraInfo	object	optional
└ isRankable	boolean	optional
└ definition	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ keypointInfo	object	optional
└ skeleton	array	optional
└ k1	integer	optional
└ k2	integer	optional
└ keypointNames	array	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/concepts

GET /v2/concepts/knowledge_graphs List all domain graphs.

operationId: V2_ListKnowledgeGraphs2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/concepts/knowledge_graphs

POST /v2/concepts/knowledge_graphs Post domain graphs.

operationId: V2_PostKnowledgeGraphs2

Request Body

required

application/json

schema apiPostKnowledgeGraphsRequest

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

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/concepts/knowledge_graphs

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

operationId: V2_PostConceptMappingJobs2

Request Body

required

application/json

schema apiPostConceptMappingJobsRequest

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

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/concepts/mappings/jobs

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

operationId: V2_PostConceptsSearches2

Request Body

required

application/json

schema apiPostConceptsSearchesRequest

Property	Type	Required
extraInfo	object	optional
└ rankableModel	object	optional
└ id	string	optional
└ name	string	optional
└ task	string	optional
└ appId	string	optional
└ image	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ imageInfo	object	optional
└ allowDuplicateUrl	boolean	optional
└ notes	string	optional
└ userId	string	optional
└ presets	object	optional
└ metadata	object	optional
└ toolkits	array	optional
└ useCases	array	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ languages	array	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ outputInfo	object	optional
└ data	object	optional
└ params	object	optional
└ message	string	optional
└ fieldsMap	object	optional
└ paramsSpecs	array	optional
└ outputConfig	object	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ displayName	string	optional
└ …7 more	object	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
pagination	object	optional
└ page	integer	optional
└ perPage	integer	optional
conceptQuery	object	optional
└ name	string	optional
└ language	string	optional
└ useCases	array	optional
└ workflowId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/concepts/searches

GET /v2/concepts/status List all the concepts with their positive and negative counts

operationId: V2_GetConceptCounts2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/concepts/status

GET /v2/concepts/{conceptId} Get a specific concept from an app.

operationId: V2_GetConcept2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/concepts/{conceptId}

GET /v2/concepts/{conceptId}/languages List the concept in all the translated languages.

operationId: V2_ListConceptLanguages2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/concepts/{conceptId}/languages

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

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

operationId: V2_PostConceptLanguages2

Parameters

Name	In	Required	Type	Description
conceptId	path	required	string	—

Request Body

required

application/json

schema V2PostConceptLanguages2Request

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

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/concepts/{conceptId}/languages

GET /v2/concepts/{conceptId}/languages/{language} Get a specific concept from an app.

operationId: V2_GetConceptLanguage2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/concepts/{conceptId}/languages/{language}

DELETE /v2/datasets Delete one or more datasets in a single request.

operationId: V2_DeleteDatasets2

Request Body

required

Request to delete several datasets by list of ids.

application/json

schema apiDeleteDatasetsRequest

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

Responses

default

An unexpected error response.

200

A successful response.

DELETE /v2/datasets

GET /v2/datasets List all the datasets.

operationId: V2_ListDatasets3

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/datasets

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

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

operationId: V2_PostDatasets2

Request Body

required

Request to add one or more datasets.

application/json

schema apiPostDatasetsRequest

Property	Type	Required
datasets	array	optional
└ id	string	optional
└ appId	string	optional
└ image	object	optional
└ url	string	optional
└ base64	string	optional
└ hosted	object	optional
└ sizes	array	optional
└ prefix	string	optional
└ suffix	string	optional
└ crossorigin	string	optional
└ imageInfo	object	optional
└ width	integer	optional
└ format	string	optional
└ height	integer	optional
└ colorMode	string	optional
└ allowDuplicateUrl	boolean	optional
└ notes	string	optional
└ userId	string	optional
└ version	object	optional
└ id	string	optional
└ appId	string	optional
└ status	object	optional
└ code	string	optional
└ reqId	string	optional
└ details	string	optional
└ stackTrace	array	optional
└ description	string	optional
└ redirectInfo	object	optional
└ timeRemaining	integer	optional
└ developerNotes	string	optional
└ internalDetails	string	optional
└ percentCompleted	integer	optional
└ userId	string	optional
└ metrics	object	optional
└ metadata	object	optional
└ createdAt	string	optional
└ datasetId	string	optional
└ exportInfo	object	optional
└ coco	object	optional
└ clarifaiDataJson	object	optional
└ clarifaiDataProtobuf	object	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ processingInfo	object	optional
└ frameInterpolationInfo	object	optional
└ modelPredictConfig	object	optional
└ model	object	optional
└ embedModelVersionIds	array	optional
└ annotationFilterConfig	object	optional
└ annotationFilter	object	optional
└ ignoreEmptyInputs	boolean	optional
└ metadata	object	optional
└ createdAt	string	optional
└ isStarred	boolean	optional
└ starCount	integer	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ description	string	optional
└ bookmarkOrigin	object	optional
└ id	string	optional
└ appId	string	optional
└ userId	string	optional
└ resourceType	string	optional
└ defaultProcessingInfo	object	optional
└ frameInterpolationInfo	object	optional
└ sampleMs	integer	optional
└ defaultAnnotationFilter	object	optional
└ id	string	optional
└ appId	string	optional
└ search	object	optional
└ id	string	optional
└ asOf	string	optional
└ name	string	optional
└ save	boolean	optional
└ query	object	optional
└ metric	string	optional
└ gitHash	string	optional
└ minValue	number	optional
└ algorithm	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ applicationId	string	optional
└ userId	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/datasets

GET /v2/datasets/{datasetId} Get a specific dataset.

operationId: V2_GetDataset2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/datasets/{datasetId}

DELETE /v2/datasets/{datasetId}/inputs Delete one or more dataset inputs in a single request.

operationId: V2_DeleteDatasetInputs2

Parameters

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

Request Body

required

application/json

schema V2DeleteDatasetInputs2Request

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

Responses

default

An unexpected error response.

200

A successful response.

DELETE /v2/datasets/{datasetId}/inputs

GET /v2/datasets/{datasetId}/inputs List all the dataset inputs in a dataset.

operationId: V2_ListDatasetInputs2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/datasets/{datasetId}/inputs

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

operationId: V2_PostDatasetInputs2

Parameters

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

Request Body

required

application/json

schema V2PostDatasetInputs2Request

Property	Type	Required
search	object	optional
└ id	string	optional
└ asOf	string	optional
└ name	string	optional
└ save	boolean	optional
└ query	object	optional
└ ands	array	optional
└ input	object	optional
└ negate	boolean	optional
└ output	object	optional
└ annotation	object	optional
└ ranks	array	optional
└ negate	boolean	optional
└ annotation	object	optional
└ filters	array	optional
└ input	object	optional
└ negate	boolean	optional
└ annotation	object	optional
└ lastUpdatedTimeRange	object	optional
└ language	string	optional
└ metric	string	optional
└ gitHash	string	optional
└ minValue	number	optional
└ algorithm	string	optional
└ createdAt	string	optional
└ modifiedAt	string	optional
└ visibility	object	optional
└ gettable	string	optional
└ applicationId	string	optional
userAppId	object	optional
└ appId	string	optional
└ userId	string	optional
datasetInputs	array	optional
└ input	object	optional
└ id	string	optional
└ data	object	optional
└ geo	object	optional
└ hits	array	optional
└ text	object	optional
└ audio	object	optional
└ image	object	optional
└ video	object	optional
└ colors	array	optional
└ frames	array	optional
└ tracks	array	optional
└ regions	array	optional
└ clusters	array	optional
└ concepts	array	optional
└ heatmaps	array	optional
└ metadata	object	optional
└ embeddings	array	optional
└ timeSegments	array	optional
└ status	object	optional
└ code	string	optional
└ reqId	string	optional
└ details	string	optional
└ stackTrace	array	optional
└ description	string	optional
└ redirectInfo	object	optional
└ timeRemaining	integer	optional
└ developerNotes	string	optional
└ internalDetails	string	optional
└ percentCompleted	integer	optional
└ createdAt	string	optional
└ datasetIds	array	optional
└ modifiedAt	string	optional
└ createdAt	string	optional

Responses

default

An unexpected error response.

200

A successful response.

POST /v2/datasets/{datasetId}/inputs

GET /v2/datasets/{datasetId}/inputs/{inputId} Get a specific dataset input.

operationId: V2_GetDatasetInput2

Parameters

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

Responses

default

An unexpected error response.

200

A successful response.

GET /v2/datasets/{datasetId}/inputs/{inputId}

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