openapi.city
Sign in

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

PUT /v2/datasets/{datasetId}/versions/{datasetVersionId}/exports
operationId: V2_PutDatasetVersionExports2

Parameters

Name In Required Type Description
datasetId path required string

Identify dataset by id.
datasetVersionId path required string

Identify dataset version by id.

Request Body

required
application/json
schema V2PutDatasetVersionExports2Request
Property Type Required
exports array optional
└ url string optional
└ size string optional
└ format 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
└ includeEmbeddings boolean optional
userAppId object optional
└ appId string optional
└ userId string optional

Responses

default

An unexpected error response.
200

A successful response.
PUT /v2/datasets/{datasetId}/versions/{datasetVersionId}/exports
PUT /v2/models/{modelId}/versions/{versionId}/exports
operationId: V2_PutModelVersionExports2

Parameters

Name In Required Type Description
modelId path required string —
versionId path required string —
userAppId.userId query optional string

Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId query optional string —

Responses

default

An unexpected error response.
200

A successful response.
PUT /v2/models/{modelId}/versions/{versionId}/exports
PUT /v2/uploads/{uploadId}/content_parts
operationId: V2_PutUploadContentParts2

Parameters

Name In Required Type Description
uploadId path required string —
userAppId.userId query optional string

Note user_id ‘me’ is reserved - it is the alias for the id of authorized user
userAppId.appId query optional string —

Responses

default

An unexpected error response.
200

A successful response.
PUT /v2/uploads/{uploadId}/content_parts
PUT /v2/users/{userAppId.userId}/apps/{userAppId.appId}/datasets/{datasetId}/versions/{datasetVersionId}/exports
operationId: V2_PutDatasetVersionExports

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.
datasetVersionId path required string

Identify dataset version by id.

Request Body

required
application/json
schema V2PutDatasetVersionExportsRequest
Property Type Required
exports array optional
└ url string optional
└ size string optional
└ format 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
└ includeEmbeddings boolean optional
userAppId object optional

Responses

default

An unexpected error response.
200

A successful response.
PUT /v2/users/{userAppId.userId}/apps/{userAppId.appId}/datasets/{datasetId}/versions/{datasetVersionId}/exports
PUT /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/versions/{versionId}/exports
operationId: V2_PutModelVersionExports

Parameters

Name In Required Type Description
userAppId.userId path required string

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

Responses

default

An unexpected error response.
200

A successful response.
PUT /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/versions/{versionId}/exports
PUT /v2/users/{userAppId.userId}/apps/{userAppId.appId}/tasks/{taskId}/assignments
operationId: V2_PutTaskAssignments

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 —

Request Body

required
application/json
schema V2PutTaskAssignmentsRequest
Property Type Required
action string optional
inputId string optional
userAppId object optional
labelSubmitConfig object optional
└ taskAssignments array optional
└ id string optional
└ input object optional
└ id string optional
└ data object optional
└ status object optional
└ createdAt string optional
└ datasetIds array optional
└ modifiedAt 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
└ worker object optional
└ user object optional
└ model object optional
└ workflow object optional
└ createdAt string optional
└ modifiedAt string optional
reviewApproveConfig object optional
└ workers array 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
└ 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
└ model object optional
└ id string optional
└ name string optional
└ task string optional
└ appId string optional
└ image object optional
└ notes string optional
└ userId string optional
└ presets object optional
└ metadata object optional
└ toolkits array optional
└ useCases array optional
└ createdAt string optional
└ isStarred boolean optional
└ languages array optional
└ starCount integer optional
└ modifiedAt string optional
└ outputInfo object optional
└ visibility object optional
└ description string optional
└ displayName string optional
└ …7 more object optional
└ workflow object optional
└ id string optional
└ appId string optional
└ image object optional
└ nodes array optional
└ notes string optional
└ userId string optional
└ version object optional
└ metadata object optional
└ useCases array optional
└ createdAt string optional
└ isStarred boolean optional
└ starCount integer optional
└ modifiedAt string optional
└ visibility object optional
└ description string optional
└ checkConsents array optional
└ bookmarkOrigin object optional
└ taskAssignments array optional
└ id string optional
└ input object optional
└ id string optional
└ data object optional
└ status object optional
└ createdAt string optional
└ datasetIds array optional
└ modifiedAt 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
└ worker object optional
└ user object optional
└ model object optional
└ workflow object optional
└ createdAt string optional
└ modifiedAt string optional
reviewRequestChangesConfig object optional
└ workers array 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
└ 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
└ model object optional
└ id string optional
└ name string optional
└ task string optional
└ appId string optional
└ image object optional
└ notes string optional
└ userId string optional
└ presets object optional
└ metadata object optional
└ toolkits array optional
└ useCases array optional
└ createdAt string optional
└ isStarred boolean optional
└ languages array optional
└ starCount integer optional
└ modifiedAt string optional
└ outputInfo object optional
└ visibility object optional
└ description string optional
└ displayName string optional
└ …7 more object optional
└ workflow object optional
└ id string optional
└ appId string optional
└ image object optional
└ nodes array optional
└ notes string optional
└ userId string optional
└ version object optional
└ metadata object optional
└ useCases array optional
└ createdAt string optional
└ isStarred boolean optional
└ starCount integer optional
└ modifiedAt string optional
└ visibility object optional
└ description string optional
└ checkConsents array optional
└ bookmarkOrigin object optional
└ taskAssignments array optional
└ id string optional
└ input object optional
└ id string optional
└ data object optional
└ status object optional
└ createdAt string optional
└ datasetIds array optional
└ modifiedAt 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
└ worker object optional
└ user object optional
└ model object optional
└ workflow object optional
└ createdAt string optional
└ modifiedAt string optional

Responses

default

An unexpected error response.
200

A successful response.
PUT /v2/users/{userAppId.userId}/apps/{userAppId.appId}/tasks/{taskId}/assignments
PUT /v2/users/{userAppId.userId}/apps/{userAppId.appId}/uploads/{uploadId}/content_parts
operationId: V2_PutUploadContentParts

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 —
uploadId path required string —

Request Body

required
application/json
schema V2PutUploadContentPartsRequest
Property Type Required
userAppId object optional
contentParts array optional
└ data string optional
└ partNumber string optional
└ rangeStart string optional

Responses

default

An unexpected error response.
200

A successful response.
PUT /v2/users/{userAppId.userId}/apps/{userAppId.appId}/uploads/{uploadId}/content_parts
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