Clarifai V2 API
The V2 API from Clarifai — 297 operation(s) for v2.
Clarifai V2 API is published by Clarifai on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include v2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 466 operations across 297 paths, and defines 652 schemas. It is described by OpenAPI 3.2.0, at version version not set.
Requests are made against a single base URL, https://api.clarifai.com/v2.
466 operations
297 paths
652 schemas
58 DELETE219 GET64 PATCH118 POST7 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 466
Across 297 paths, the API surfaces 466 operations — 58 DELETE, 219 GET, 64 PATCH, 118 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.
V2 466
GET
/v2/annotation_filters
List all the annotation filters.
DELETE
/v2/annotation_filters
Delete one or more annotation filters in a single request.
POST
/v2/annotation_filters
Add annotation filters.
PATCH
/v2/annotation_filters
Patch one or more annotation filters.
GET
/v2/annotation_filters/{annotation_filter_id}
Get a specific annotation filter.
GET
/v2/annotations
List all the annotation.
DELETE
/v2/annotations
Delete multiple annotations in one request.
POST
/v2/annotations
Post annotations.
PATCH
/v2/annotations
Patch one or more annotations.
POST
/v2/annotations/searches
Execute a search over annotations
PATCH
/v2/annotations/searches
Patch saved annotations searches by ids.
GET
/v2/annotations/workers
ListAnnotationWorkers lists users, models, and workflows (collectively known as "workers") that have added annotations to the application.
GET
/v2/app
Get a specific app from an app.
GET
/v2/apps
List all the apps.
POST
/v2/artifact_versions/upload
This is a streaming endpoint, the request has a field, uploaddata, which can either be the config for the upload or the actual data to upload. The config must be sent first before the artifactbytes c…
GET
/v2/bulk_operations
List all the bulk operations
DELETE
/v2/bulk_operations
delete one or more terminated 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…
PATCH
/v2/bulk_operations
Cancel one or more bulk operations
GET
/v2/bulk_operations/{id}
Get the bulk operation details by ID
GET
/v2/cloud_providers
List Available Cloud Providers
GET
/v2/cloud_providers/{cloud_provider.id}/regions
List Regions for given Cloud Provider
GET
/v2/cloud_providers/{cloud_provider.id}/regions/{region}/instance_types
Get InstanceTypes given Cloud Provider and Region
GET
/v2/compute_clusters
POST
/v2/compute_plane_metrics
GET
/v2/concepts
List all the concepts.
POST
/v2/concepts
Add a concept to an app.
PATCH
/v2/concepts
Patch one or more concepts.
GET
/v2/concepts/knowledge_graphs
List all domain graphs.
POST
/v2/concepts/knowledge_graphs
Post domain graphs.
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 perpage as url query param variables in this request.
GET
/v2/concepts/status
List all the concepts with their positive and negative counts
GET
/v2/concepts/{concept_id}
Get a specific concept from an app.
GET
/v2/concepts/{concept_id}/languages
List the concept in all the translated languages.
POST
/v2/concepts/{concept_id}/languages
Add a new translation for this concept.
PATCH
/v2/concepts/{concept_id}/languages
Patch the name for a given language names by passing in a list of concepts with the new names for the languages.
GET
/v2/concepts/{concept_id}/languages/{language}
Get a specific concept from an app.
GET
/v2/datasets
List all the datasets.
DELETE
/v2/datasets
Delete one or more datasets in a single request.
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.
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.
GET
/v2/datasets/{dataset_id}
Get a specific dataset.
GET
/v2/datasets/{dataset_id}/inputs
List all the dataset inputs in a dataset.
DELETE
/v2/datasets/{dataset_id}/inputs
Delete one or more dataset inputs in a single request.
POST
/v2/datasets/{dataset_id}/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 a…
GET
/v2/datasets/{dataset_id}/inputs/{input_id}
Get a specific dataset input.
GET
/v2/datasets/{dataset_id}/versions
List all the dataset versions.
DELETE
/v2/datasets/{dataset_id}/versions
Delete one or more dataset versions in a single request.
POST
/v2/datasets/{dataset_id}/versions
Add dataset versions to a dataset.
PATCH
/v2/datasets/{dataset_id}/versions
Patch one or more dataset versions.
GET
/v2/datasets/{dataset_id}/versions/{dataset_version_id}
Get a specific dataset version.
PUT
/v2/datasets/{dataset_id}/versions/{dataset_version_id}/exports
Create export of a dataset version.
GET
/v2/datasets/{dataset_id}/versions/{dataset_version_id}/metrics
GET
/v2/deployments
GET
/v2/evaluations
POST
/v2/evaluations
GET
/v2/evaluations/{evaluation_id}
GET
/v2/inputs
List all the inputs.
DELETE
/v2/inputs
Delete multiple inputs in one request. This call is asynchronous.
POST
/v2/inputs
PostInputs adds one or more inputs to the app. Takes a list of image/video/audio/text URLs, image/video/audio bytes or raw text Optionally, include concepts or dataset ids to link them Optionally, in…
PATCH
/v2/inputs
Patch one or more inputs.
DELETE
/v2/inputs/annotations
Delete multiple annotations in one request.
POST
/v2/inputs/data_sources
Initiates retrieval of inputs from cloud storage from a user provided data source. Will create and return an inputs-add-job for tracking progress. Archives will be extracted and their contents will b…
GET
/v2/inputs/jobs/add
List all the inputs add jobs
GET
/v2/inputs/jobs/add/{id}
Get the input add job details by ID
PATCH
/v2/inputs/jobs/add/{id}
cancel the input add job by ID
GET
/v2/inputs/jobs/extraction
List all the input extraction jobs
PATCH
/v2/inputs/jobs/extraction
GET
/v2/inputs/jobs/extraction/{inputs_extraction_job_id}
Get the input extraction job details by ID
POST
/v2/inputs/searches
Execute a search over inputs
PATCH
/v2/inputs/searches
Patch saved inputs searches by ids.
GET
/v2/inputs/status
Get input count per status.
GET
/v2/inputs/stream
Streams all the inputs starting from oldest assets.
POST
/v2/inputs/uploads
Create new upload job with a file archive containing inputs (images, videos, text, audio) Actual file upload happens in next steps by calling PutUploadContentParts endpoint and providing the file con…
GET
/v2/inputs/{input_id}
Get a specific input from an app.
DELETE
/v2/inputs/{input_id}
Delete a single input asynchronously.
GET
/v2/inputs/{input_id}/annotation_tracks
List all the annotation tracks.
DELETE
/v2/inputs/{input_id}/annotation_tracks
Delete multiple annotation tracks in one request.
POST
/v2/inputs/{input_id}/annotation_tracks
Post annotation tracks.
PATCH
/v2/inputs/{input_id}/annotation_tracks
Patch one or more annotation tracks.
POST
/v2/inputs/{input_id}/annotations/stream/live
Stream live video annotations as soon as they are available. This endpoint will NOT replay old annotations, but only stream new annotations that are generated after the stream is opened.
GET
/v2/inputs/{input_id}/annotations/{annotation_id}
Get a specific annotation from an app.
DELETE
/v2/inputs/{input_id}/annotations/{annotation_id}
Delete a single annotation.
POST
/v2/inputs/{input_id}/track_annotations/searches
List video track annotations for a specific input.
POST
/v2/inputs/{input_id}/track_annotations/searches/stream
Stream annotations for a specific input one-by-one.
GET
/v2/inputs/{input_id}/video_manifest
Get a MPEG-DASH manifest for video-type inputs that were added via PostInputs and successfully processed Experimental. Manifest is used by browser and desktop clients that implement an efficient stre…
GET
/v2/label_orders
List label orders.
DELETE
/v2/label_orders
Delete multiple label orders in one request. this do not change task status
POST
/v2/label_orders
Add Label orders.
PATCH
/v2/label_orders
Patch one or more label orders.
GET
/v2/label_orders/{label_order_id}
Get a label order.
POST
/v2/log_entries
GET
/v2/models
List all the models.
DELETE
/v2/models
Delete multiple models in one request.
POST
/v2/models
Add a models to an app.
PATCH
/v2/models
Patch one or more models.
POST
/v2/models/outputs/stream
Stream of requests and stream of responses
POST
/v2/models/searches
Search over the models to find one or more you're looking for. This leverage the "body" parameter because we also have page and perpage as url query param variables in this request.
GET
/v2/models/types
List all the model types available in the platform. This MUST be above ListModels so that the /models/types endpoint takes precedence.
GET
/v2/models/types/{model_type_id}
Get a specific model type.
POST
/v2/models/versions/upload
This is a streaming endpoint, the request has a field, uploaddata, which can either be the config for the upload or the actual data to upload. The config must be sent first before the modelbytes can…
GET
/v2/models/{model_id}
Get a specific model from an app.
DELETE
/v2/models/{model_id}
Delete a single model.
PATCH
/v2/models/{model_id}/check_consents
Update model check consents
GET
/v2/models/{model_id}/inputs
Deprecated: Unmaintained and ideally replaced with usage of datasets The server may refuse to accept requests to this endpoint.
PATCH
/v2/models/{model_id}/languages
Update model languages tags
GET
/v2/models/{model_id}/output_info
Get a the output info for a given modelid or modelid/versionid combo.
POST
/v2/models/{model_id}/outputs
Get predicted outputs from the model.
POST
/v2/models/{model_id}/publish
PostModelVersionsPublish
GET
/v2/models/{model_id}/references
Lists model references tied to a particular model id.
PATCH
/v2/models/{model_id}/toolkits
Update model toolkits tags
POST
/v2/models/{model_id}/unpublish
PostModelVersionsUnPublish
PATCH
/v2/models/{model_id}/usecases
Update model usecases tags
GET
/v2/models/{model_id}/versions
List all the models.
POST
/v2/models/{model_id}/versions
Create a new model version to trigger training of the model.
POST
/v2/models/{model_id}/versions/time_estimate
Get the training time estimate based off train request and estimated input count.
GET
/v2/models/{model_id}/versions/{model_version_id}/evaluations
Deprecated, use GetEvaluation instead List the evaluation metrics for a model version.
POST
/v2/models/{model_id}/versions/{model_version_id}/evaluations
Deprecated, use PostEvaluations instead
GET
/v2/models/{model_id}/versions/{model_version_id}/evaluations/{evaluation_id}
Deprecated, use GetEvaluation instead Get an evaluation metrics for a model version.
GET
/v2/models/{model_id}/versions/{model_version_id}/input_examples
ListModelVersionInputExamples
GET
/v2/models/{model_id}/versions/{model_version_id}/input_examples/{example_id}
GetModelVersionInputExample
GET
/v2/models/{model_id}/versions/{version_id}
Get a specific model from an app.
DELETE
/v2/models/{model_id}/versions/{version_id}
Delete a single model.
GET
/v2/models/{model_id}/versions/{version_id}/exports
GetModelVersionExport
PUT
/v2/models/{model_id}/versions/{version_id}/exports
Export a model
GET
/v2/models/{model_id}/versions/{version_id}/inputs
Deprecated: Unmaintained and ideally replaced with usage of datasets The server may refuse to accept requests to this endpoint.
GET
/v2/models/{model_id}/versions/{version_id}/metrics
Get the evaluation metrics for a model version. Deprecated: Use GetEvaluation instead The server may refuse to accept requests to this endpoint.
POST
/v2/models/{model_id}/versions/{version_id}/metrics
Deprecated, use PostEvaluations instead Run the evaluation metrics for a model version.
GET
/v2/models/{model_id}/versions/{version_id}/output_info
Get a the output info for a given modelid or modelid/versionid combo.
POST
/v2/models/{model_id}/versions/{version_id}/outputs
Get predicted outputs from the model.
GET
/v2/my_scopes
API Keys in the public API -- request is itself Key authorized, and will tell the user the scopes/access of the key/credential they're providing, as computed by our authorizer:
GET
/v2/myscopes
API Keys in the public API -- request is itself Key authorized, and will tell the user the scopes/access of the key/credential they're providing, as computed by our authorizer:
GET
/v2/myscopesroot
GET
/v2/nodepools
GET
/v2/open_source_licenses
List all the supported open source licenses in the platform.
POST
/v2/pipeline_step_versions/upload
This is a streaming endpoint, the request has a field, uploaddata, which can either be the config for the upload or the actual data to upload. The config must be sent first before the pipelinestepbyt…
GET
/v2/pipeline_templates
Lists pipeline templates, which are ready-to-use templates that can simply be run on demand.
GET
/v2/pipelines
GET
/v2/pipelines/{pipeline_id}
GET
/v2/pipelines/{pipeline_id}/versions
GET
/v2/pipelines/{pipeline_id}/versions/{pipeline_version_id}
GET
/v2/pipelines/{pipeline_id}/versions/{pipeline_version_id}/runs/{pipeline_version_run_id}
GET
/v2/resource_counts
List the resource counts for the app.
POST
/v2/runners/items/process
This maintains a single request for asking the API if there is any work to be done, processing it and streaming back results. To do that first handshake the MultiRunnerItemOutputResponse will have RU…
GET
/v2/searches
List all saved legacy searches.
POST
/v2/searches
Execute a new search and optionally save it.
PATCH
/v2/searches
Patch saved legacy searches by ids.
GET
/v2/searches/{id}
Get a saved legacy search.
DELETE
/v2/searches/{id}
Delete a saved search.
POST
/v2/searches/{id}
Execute a previously saved legacy search.
GET
/v2/status_codes
List all status codes.
GET
/v2/status_codes/{status_code_id}
Get more details for a status code.
GET
/v2/tasks
List tasks from an app.
DELETE
/v2/tasks
Delete multiple tasks in one request.
POST
/v2/tasks
Add tasks to an app.
PATCH
/v2/tasks
Patch one or more tasks.
GET
/v2/tasks/{task_id}
Get a specific task from an app.
GET
/v2/tasks/{task_id}/annotations/count
Task annotation count
GET
/v2/tasks/{task_id}/assignments
Deprecated: Use PutTaskAssignments with action=LABELSTART. This endpoint has initially been designed as a GET request, but has been re-designed to serve a PUT logic. In order to clearly highlight tha…
GET
/v2/tasks/{task_id}/inputs/count
Task Input count
GET
/v2/tasks/{task_id}/inputs/samples
GET
/v2/uploads
DELETE
/v2/uploads
POST
/v2/uploads
PostUploads is used to upload files. Note that this does not create inputs. returns job with uploadID, job has UPLOADINPROGRESS status Actual upload content can be done in multiple calls with PutUplo…
GET
/v2/uploads/{upload_id}
PUT
/v2/uploads/{upload_id}/content_parts
Upload a part of a multipart upload. Behaviour on completion depends on the endpoint that was used to initiate the upload.
POST
/v2/users/{runner_selector.deployment.user_id}/deployments/{runner_selector.deployment.id}/outputs
Get predicted outputs from the model.
POST
/v2/users/{user_app_id.user_id_1}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners
Patch runners of a user.
GET
/v2/users/{user_app_id.user_id_1}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners/{runner_id}/{log_type}/logs
GET
/v2/users/{user_app_id.user_id_1}/compute_clusters/{compute_cluster_user_id}/{compute_cluster_id}/nodepools/{nodepool_id}/versions/{model_version_id}/{log_type}/logs
GET
/v2/users/{user_app_id.user_id}
Get user information
GET
/v2/users/{user_app_id.user_id}/apps
List all the apps.
POST
/v2/users/{user_app_id.user_id}/apps
Add a app to an app. This needs to load the default workflow to make a copy, validating all the models in it, and then writing the new workflow back to this new app.
PATCH
/v2/users/{user_app_id.user_id}/apps
Patch one or more apps.
PATCH
/v2/users/{user_app_id.user_id}/apps/ids
Patch apps ids.
POST
/v2/users/{user_app_id.user_id}/apps/searches
Search over the applications to find one or more you're looking for.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}
Get a specific app from an app.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}
Search over the apps to find one or more you're looking for. This leverage the "body" parameter because we also have page and perpage as url query param variables in this request.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}
Patch one app.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotation_filters
List all the annotation filters.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotation_filters
Delete one or more annotation filters in a single request.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotation_filters
Add annotation filters.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotation_filters
Patch one or more annotation filters.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotation_filters/{annotation_filter_id}
Get a specific annotation filter.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotation_tracks
Delete multiple annotation tracks in one request.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotations
List all the annotation.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotations
Delete multiple annotations in one request.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotations
Post annotations.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotations
Patch one or more annotations.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotations/searches
Execute a search over annotations
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotations/searches
Patch saved annotations searches by ids.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/annotations/workers
ListAnnotationWorkers lists users, models, and workflows (collectively known as "workers") that have added annotations to the application.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/artifacts
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/artifacts
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/artifacts
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/artifacts/{artifact_id}
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/artifacts/{artifact_id}/versions
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/artifacts/{artifact_id}/versions
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/artifacts/{artifact_id}/versions/{artifact_version_id}
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/bulk_operations
List all the bulk operations
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/bulk_operations
delete one or more terminated bulk operations
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/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…
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/bulk_operations
Cancel one or more bulk operations
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/bulk_operations/{id}
Get the bulk operation details by ID
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/collaborators
owner list users who the app is shared with
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/collaborators
Delete existing collaborators.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/collaborators
add collaborators to an app.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/collaborators
Patch existing collaborators.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts
List all the concepts.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts
Add a concept to an app.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts
Patch one or more concepts.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/knowledge_graphs
List all domain graphs.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/knowledge_graphs
Post domain graphs.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/relations
List concept relations between concepts in the platform. MUST be above ListConcepts so that if conceptid is empty this will still match /concepts/relations to list all the concept relations in the ap…
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/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 perpage as url query param variables in this request.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/status
List all the concepts with their positive and negative counts
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/{concept_id}
Get a specific concept from an app.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/{concept_id}/languages
List the concept in all the translated languages.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/{concept_id}/languages
Add a new translation for this concept.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/{concept_id}/languages
Patch the name for a given language names by passing in a list of concepts with the new names for the languages.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/{concept_id}/languages/{language}
Get a specific concept from an app.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/{concept_id}/relations
List concept relations between concepts in the platform. MUST be above ListConcepts so that if conceptid is empty this will still match /concepts/relations to list all the concept relations in the ap…
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/{concept_id}/relations
Post concept relations to create relations between concepts in the platform.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/concepts/{concept_id}/relations
Post concept relations to create relations between concepts in the platform.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets
List all the datasets.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets
Delete one or more datasets in a single request.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/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.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/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.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}
Get a specific dataset.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/inputs
List all the dataset inputs in a dataset.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/inputs
Delete one or more dataset inputs in a single request.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/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 a…
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/inputs/{input_id}
Get a specific dataset input.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/versions
List all the dataset versions.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/versions
Delete one or more dataset versions in a single request.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/versions
Add dataset versions to a dataset.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/versions
Patch one or more dataset versions.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/versions/{dataset_version_id}
Get a specific dataset version.
PUT
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/versions/{dataset_version_id}/exports
Create export of a dataset version.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets/{dataset_id}/versions/{dataset_version_id}/metrics
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/duplications
Deprecated: App duplication is no longer supported. PostAppDuplications starts async app duplication jobs which copy resources (inputs, annotations, models etc) from one application to another.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/evaluations
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/evaluations
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/evaluations/{evaluation_id}
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs
List all the inputs.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs
Delete multiple inputs in one request. This call is asynchronous.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs
PostInputs adds one or more inputs to the app. Takes a list of image/video/audio/text URLs, image/video/audio bytes or raw text Optionally, include concepts or dataset ids to link them Optionally, in…
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs
Patch one or more inputs.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/annotations
Delete multiple annotations in one request.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/data_sources
Initiates retrieval of inputs from cloud storage from a user provided data source. Will create and return an inputs-add-job for tracking progress. Archives will be extracted and their contents will b…
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/jobs/add
List all the inputs add jobs
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/jobs/add/{id}
Get the input add job details by ID
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/jobs/add/{id}
cancel the input add job by ID
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/jobs/extraction
List all the input extraction jobs
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/jobs/extraction
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/jobs/extraction/{inputs_extraction_job_id}
Get the input extraction job details by ID
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/searches
Execute a search over inputs
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/searches
Patch saved inputs searches by ids.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/status
Get input count per status.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/stream
Streams all the inputs starting from oldest assets.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/uploads
Create new upload job with a file archive containing inputs (images, videos, text, audio) Actual file upload happens in next steps by calling PutUploadContentParts endpoint and providing the file con…
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}
Get a specific input from an app.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}
Delete a single input asynchronously.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/annotation_tracks
List all the annotation tracks.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/annotation_tracks
Post annotation tracks.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/annotation_tracks
Patch one or more annotation tracks.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/annotations/stream/live
Stream live video annotations as soon as they are available. This endpoint will NOT replay old annotations, but only stream new annotations that are generated after the stream is opened.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/annotations/{annotation_id}
Get a specific annotation from an app.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/annotations/{annotation_id}
Delete a single annotation.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/track_annotations/searches
List video track annotations for a specific input.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/track_annotations/searches/stream
Stream annotations for a specific input one-by-one.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/inputs/{input_id}/video_manifest
Get a MPEG-DASH manifest for video-type inputs that were added via PostInputs and successfully processed Experimental. Manifest is used by browser and desktop clients that implement an efficient stre…
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/keys
List keys by appid
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/label_orders
List label orders.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/label_orders
Delete multiple label orders in one request. this do not change task status
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/label_orders
Add Label orders.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/label_orders
Patch one or more label orders.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/label_orders/{label_order_id}
Get a label order.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models
List all the models.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models
Delete multiple models in one request.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models
Add a models to an app.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models
Patch one or more models.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/ids
Patch one or more models ids.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/searches
Search over the models to find one or more you're looking for. This leverage the "body" parameter because we also have page and perpage as url query param variables in this request.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/types
List all the model types available in the platform. This MUST be above ListModels so that the /models/types endpoint takes precedence.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/types/{model_type_id}
Get a specific model type.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}
Get a specific model from an app.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}
Delete a single model.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/check_consents
Update model check consents
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/concepts
List models concepts.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/inputs
Deprecated: Unmaintained and ideally replaced with usage of datasets The server may refuse to accept requests to this endpoint.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/languages
Update model languages tags
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/migration
Reverts a model migration from Docker format back to Triton format.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/migration
Kicks off conversion from the old Triton model format to the new Docker model format.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/output_info
Get a the output info for a given modelid or modelid/versionid combo.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/outputs
Get predicted outputs from the model.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/outputs/generate
TODO(zeiler): will need to Single request but streaming responses.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/publish
PostModelVersionsPublish
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/references
Lists model references tied to a particular model id.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/toolkits
Update model toolkits tags
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/unpublish
PostModelVersionsUnPublish
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/usecases
Update model usecases tags
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions
List all the models.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions
Create a new model version to trigger training of the model.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions
PatchModelVersions
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/time_estimate
Get the training time estimate based off train request and estimated input count.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{model_version_id}/evaluations
Deprecated, use GetEvaluation instead List the evaluation metrics for a model version.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{model_version_id}/evaluations
Deprecated, use PostEvaluations instead
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{model_version_id}/evaluations/{evaluation_id}
Deprecated, use GetEvaluation instead Get an evaluation metrics for a model version.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{model_version_id}/input_examples
ListModelVersionInputExamples
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{model_version_id}/input_examples/{example_id}
GetModelVersionInputExample
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{model_version_id}/{log_type}/logs
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}
Get a specific model from an app.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}
Delete a single model.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/concepts
List models concepts.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/exports
GetModelVersionExport
PUT
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/exports
Export a model
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/inputs
Deprecated: Unmaintained and ideally replaced with usage of datasets The server may refuse to accept requests to this endpoint.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/metrics
Get the evaluation metrics for a model version. Deprecated: Use GetEvaluation instead The server may refuse to accept requests to this endpoint.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/metrics
Deprecated, use PostEvaluations instead Run the evaluation metrics for a model version.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/migration
Kicks off conversion from the old Triton model format to the new Docker model format.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/output_info
Get a the output info for a given modelid or modelid/versionid combo.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/outputs
Get predicted outputs from the model.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models/{model_id}/versions/{version_id}/outputs/generate
TODO(zeiler): will need to Single request but streaming responses.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/myscopes
API Keys in the public API -- request is itself Key authorized, and will tell the user the scopes/access of the key/credential they're providing, as computed by our authorizer:
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/partial
Allows to Patch only the below fields in one or more apps. Allowed fields are notes, description and image
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps/{pipeline_step_id}
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps/{pipeline_step_id}/versions
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps/{pipeline_step_id}/versions
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps/{pipeline_step_id}/versions/{pipeline_step_version_id}
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_templates/{pipeline_template_name}/pipeline_version_runs
Creates a Pipeline, PipelineVersion, and PipelineVersionRun from a PipelineTemplate. This is a convenience endpoint for users to quickly get started with running pipelines.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/runs
putting above the Get Nodepool endpoint to make it appear above the other one
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/runs
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/runs
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/runs/{pipeline_version_run_id}
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/runs/{pipeline_version_run_id}/status_logs
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/runs/{pipeline_version_run_id}/{log_type}/logs
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/runs/{pipeline_version_run_id}/{log_type}/stream/logs
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/resource_counts
List the resource counts for the app.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/runner_replica_task_metrics
Post task metrics from runner replicas.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/searches
List all saved legacy searches.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/searches
Execute a new search and optionally save it.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/searches
Patch saved legacy searches by ids.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/searches/{id}
Get a saved legacy search.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/searches/{id}
Delete a saved search.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/searches/{id}
Execute a previously saved legacy search.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/task/{task_id}/annotations/status
Patch annotations status by worker id and task id. Deprecated: Use PutTaskAssignments to update task annotations. For example, you can use PutTaskAssignments with action REVIEWAPPROVE to approve task…
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks
List tasks from an app.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks
Delete multiple tasks in one request.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks
Add tasks to an app.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks
Patch one or more tasks.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks/{task_id}
Get a specific task from an app.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks/{task_id}/annotations/count
Task annotation count
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks/{task_id}/assignments
Deprecated: Use PutTaskAssignments with action=LABELSTART. This endpoint has initially been designed as a GET request, but has been re-designed to serve a PUT logic. In order to clearly highlight tha…
PUT
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks/{task_id}/assignments
PutTaskAssignments performs an idempotent action for the task assignments in given task. See PutTaskAssignmentsRequestAction for more details about possible actions.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks/{task_id}/inputs/count
Task Input count
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks/{task_id}/inputs/samples
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/uploads
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/uploads
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/uploads
PostUploads is used to upload files. Note that this does not create inputs. returns job with uploadID, job has UPLOADINPROGRESS status Actual upload content can be done in multiple calls with PutUplo…
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/uploads/{upload_id}
PUT
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/uploads/{upload_id}/content_parts
Upload a part of a multipart upload. Behaviour on completion depends on the endpoint that was used to initiate the upload.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows
List all the workflows.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows
Delete multiple workflows in one request.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows
Add a workflow to an app. Note(zeiler): the order of the workflows that are returned from this endpoint may be different than the order in which the user provides them. This is because we reorder by…
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows
Patch one or more workflows.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/ids
Patch one or more workflows ids.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}
Get a specific workflow from an app.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}
Delete a single workflow.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/publish
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/results
Predict using a workflow.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/unpublish
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions
List workflow versions.
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions
Delete workflow versions.
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions
Patch workflow versions.
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions/{version_id}/results
Predict using a workflow.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions/{workflow_version_id}
Get single workflow version.
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions/{workflow_version_id}/evaluations
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions/{workflow_version_id}/evaluations
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions/{workflow_version_id}/evaluations
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions/{workflow_version_id}/evaluations/{workflow_version_evaluation_id}
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions/{workflow_version_id}/evaluations/{workflow_version_evaluation_id}/data
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions/{workflow_version_id}/evaluations/{workflow_version_evaluation_id}/data
POST
/v2/users/{user_app_id.user_id}/audit_log/searches
GET
/v2/users/{user_app_id.user_id}/collaborations
Collaboration includes the app user are invitied to work on
GET
/v2/users/{user_app_id.user_id}/compute_clusters
DELETE
/v2/users/{user_app_id.user_id}/compute_clusters
Delete multiple computeclusters in one request.
POST
/v2/users/{user_app_id.user_id}/compute_clusters
PATCH
/v2/users/{user_app_id.user_id}/compute_clusters
GET
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}
ComputeCluster CRUD
GET
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools
DELETE
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools
Delete multiple nodepools in one request.
POST
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools
PATCH
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools
GET
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}
Nodepools CRUD
GET
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/pipeline_version_runs
putting above the Get Nodepool endpoint to make it appear above the other one
GET
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners
List all the runners for the user.
DELETE
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners
Delete multiple runners in one request.
POST
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners
Add a runners to a user.
GET
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners/{runner_id}
Get a specific runner. TODO(zeiler): runnerid is a UUID so can list globally as well.
GET
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners/{runner_id}/items
List items for the remote runner to work on. since the runnerid is a UUID we can access it directly too.
POST
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners/{runner_id}/items/{runner_item_id}/outputs
Post back outputs from remote runners since the runnerid is a UUID we can access it directly too.
GET
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners/{runner_id}/{log_type}/logs
POST
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/status
Update nodepool status. Called by the agent to report nodepool health/errors.
GET
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/{log_type}/logs
GET
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_user_id}/{compute_cluster_id}/nodepools/{nodepool_id}/versions/{model_version_id}/{log_type}/logs
GET
/v2/users/{user_app_id.user_id}/datasets
List all the datasets.
GET
/v2/users/{user_app_id.user_id}/deployments
DELETE
/v2/users/{user_app_id.user_id}/deployments
Delete multiple deployments in one request.
POST
/v2/users/{user_app_id.user_id}/deployments
PATCH
/v2/users/{user_app_id.user_id}/deployments
GET
/v2/users/{user_app_id.user_id}/deployments/{deployment_id}
Deployments CRUD
GET
/v2/users/{user_app_id.user_id}/duplications
Deprecated: App duplication is no longer supported. ListAppDuplications lists all app duplication jobs created by the user.
GET
/v2/users/{user_app_id.user_id}/duplications/{app_duplication_id}
Deprecated: App duplication is no longer supported. GetAppDuplication returns an app duplication job created by the user.
GET
/v2/users/{user_app_id.user_id}/evaluations
GET
/v2/users/{user_app_id.user_id}/keys
List all the keys.
POST
/v2/users/{user_app_id.user_id}/keys
Add a key to an app.
PATCH
/v2/users/{user_app_id.user_id}/keys
Patch one or more keys.
GET
/v2/users/{user_app_id.user_id}/keys/{key_id}
Get a specific key from an app.
DELETE
/v2/users/{user_app_id.user_id}/keys/{key_id}
Search over the keys to find one or more you're looking for. This leverage the "body" parameter because we also have page and perpage as url query param variables in this request.
POST
/v2/users/{user_app_id.user_id}/metrics
GET
/v2/users/{user_app_id.user_id}/metrics/labels
GET
/v2/users/{user_app_id.user_id}/models
List all the models.
GET
/v2/users/{user_app_id.user_id}/myscopes
GET
/v2/users/{user_app_id.user_id}/nodepools
GET
/v2/users/{user_app_id.user_id}/runners
List all the runners for the user.
GET
/v2/users/{user_app_id.user_id}/runners/{runner_id}
Get a specific runner. TODO(zeiler): runnerid is a UUID so can list globally as well.
GET
/v2/users/{user_app_id.user_id}/scopes
List all auth scopes available to me as a user.
GET
/v2/users/{user_app_id.user_id}/secrets
DELETE
/v2/users/{user_app_id.user_id}/secrets
POST
/v2/users/{user_app_id.user_id}/secrets
PATCH
/v2/users/{user_app_id.user_id}/secrets
GET
/v2/users/{user_app_id.user_id}/secrets/{id}
POST
/v2/users/{user_app_id.user_id}/validate_password
Validate new password in real-time for a user
GET
/v2/users/{user_app_id.user_id}/workflows
List all the workflows.
POST
/v2/validate_password
Validate new password in real-time for a user
GET
/v2/workflow-version-evaluation-templates
GET
/v2/workflow-version-evaluations
GET
/v2/workflow-version-evaluations/{workflow_version_evaluation_id}
GET
/v2/workflow-version-evaluations/{workflow_version_evaluation_id}/data
POST
/v2/workflow-version-evaluations/{workflow_version_evaluation_id}/data
GET
/v2/workflows
List all the workflows.
DELETE
/v2/workflows
Delete multiple workflows in one request.
POST
/v2/workflows
Add a workflow to an app. Note(zeiler): the order of the workflows that are returned from this endpoint may be different than the order in which the user provides them. This is because we reorder by…
PATCH
/v2/workflows
Patch one or more workflows.
GET
/v2/workflows/{workflow_id}
Get a specific workflow from an app.
DELETE
/v2/workflows/{workflow_id}
Delete a single workflow.
POST
/v2/workflows/{workflow_id}/publish
POST
/v2/workflows/{workflow_id}/results
Predict using a workflow.
POST
/v2/workflows/{workflow_id}/unpublish
GET
/v2/workflows/{workflow_id}/versions
List workflow versions.
DELETE
/v2/workflows/{workflow_id}/versions
Delete workflow versions.
PATCH
/v2/workflows/{workflow_id}/versions
Patch workflow versions.
GET
/v2/workflows/{workflow_id}/versions/{workflow_version_id}
Get single workflow version.
Schemas 652
The contract defines 652 schemas that model the data the API accepts and returns. The most detailed are apiModel (36 properties), apiModelVersion (25 properties), apiUser (24 properties), apiData (24 properties). Each schema is shown below with its type and property counts.
apiROC
object
5 properties
apiCooccurrenceMatrix
object
2 properties
apiPutTaskAssignmentsRequestAction
string
apiEvalMetrics
object
18 properties
apiMetricAggregate
object
2 properties
clarifaiapiDataType
string
V2PatchComputeClustersBody
object
3 properties
apiMultiListWorkflowVersionEvaluationDataResponse
object
2 properties
apiData
object
24 properties
apiNodepoolDeploymentMetrics
object
NodepoolDeploymentMetrics captures metrics for a single nodepool within a Deployment.
3 properties
apiProgress
object
2 properties
apiPostWorkflowsRequest
object
2 properties
apiAddToDataset
object
1 property
apiMethodSignature
object
MethodSignature is a definition of a method that a model can have. This is used to communicate between a python method definition of any arbitrary function to…
5 properties
apiDatasetVersionRequestOrigin
string
apiSingleLabelOrderResponse
object
Response with a label order.
2 properties
utilsTimeOfDay
object
4 properties
apiAnd
object
This is the common building block of a query which is a sequence of And messages ANDed together. Note that some fields are used too RANK results (affect the sc…
4 properties
apiDeploymentMetricsSummary
object
DeploymentMetricsSummary holds the core deployment metrics fields, reusable as both an aggregate across all nodepools and per-individual-nodepool metrics.
3 properties
apiMultiAnnotationFilterResponse
object
2 properties
protobufAny
object
1 property
apiAuditLogQuery
object
AuditLogQuery is a query for audit log entries.
7 properties
apiMultiInputAnnotationResponse
object
2 properties
apiSingleAnnotationResponse
object
2 properties
V2DeleteComputeClustersBody
object
2 properties
apiSingleStatusCodeResponse
object
1 property
apiWorkflowVersionPublishRequest
object
1 property
V2PatchModelIdsBody
object
3 properties
apiAppCopyProgress
object
2 properties
apiInputsExtractionJob
object
8 properties
apiPostPipelineStepVersionsUploadConfig
object
5 properties
apiSingleComputeClusterResponse
object
2 properties
apiMultiAnnotationTrackResponse
object
2 properties
apiColor
object
3 properties
apiKeypointEdge
object
2 properties
apiSinglePipelineVersionResponse
object
2 properties
apiWorkflowEvaluationResult
object
1 property
clarifaiapiDeleteAnnotations
object
This operation takes no data (payload).
PipelineTemplatePipelineTemplateType
string
apiInputEvaluationMetricValue
object
4 properties
V2DeleteInputsBody
object
Request to delete several things by the list of ids.
2 properties
apiSyncStateRequest
object
SyncStateRequest is a message that the control plane sends to the agent runner to notify it of changes to objects.
6 properties
apiPatchTasksRequest
object
Request to patch a list of tasks.
3 properties
apiPipeline
object
10 properties
apiMetricLabel
string
V2PostDatasetInputsBody
object
Request to add one or more datasets.
3 properties
V2DeleteWorkflowVersionsBody
object
2 properties
V2DeleteDatasetsBody
object
Request to delete several datasets by list of ids.
2 properties
apiLogEntry
object
LogEntry is a single technical log entry (e.g. service log, stack traces, etc).
4 properties
apiMultiDatasetVersionExportResponse
object
2 properties
apiBookmarkOrigin
object
4 properties
apiMultiWorkerResponse
object
2 properties
apiModel
object
This is the Model object which represents a created model in the platform. Each model has a particular type denoted by the modeltypeid. When creating a Model w…
36 properties
V2PostLabelOrdersBody
object
Request to create label orders.
2 properties
apiPostBulkOperationsRequest
object
Request to perform bulk operations on a list of inputs based on input source.
2 properties
apiMultiDatasetResponse
object
2 properties
apiGetResourceCountsResponse
object
6 properties
apiReviewApproveConfig
object
2 properties
apiSingleStreamAnnotationResponse
object
3 properties
apiRunnerMethodType
string
apiPagination
object
Split the results into pages.
2 properties
apiPostLabelOrdersRequest
object
Request to create label orders.
2 properties
apiPostAnnotationsSearchesRequest
object
3 properties
apiPostConceptsSearchesRequest
object
4 properties
clarifaiapiAnnotation
object
15 properties
apiDeleteWorkflowsRequest
object
Request to delete several things by the list of ids.
3 properties
apiCancelBulkOperationRequest
object
2 properties
apiMultiKeyResponse
object
2 properties
V2PatchConceptLanguagesBody
object
PATCH multiple concept languages for the given concept.
3 properties
NodepoolNodepoolStatus
string
V2PatchModelToolkitsBody
object
3 properties
V2PostCollaboratorsBody
object
2 properties
V2DeleteUploadsBody
object
2 properties
V2DeleteDeploymentsBody
object
2 properties
apiLabelOrder
object
10 properties
V2PostAuditLogSearchesBody
object
4 properties
V2PatchAppsIdsBody
object
3 properties
apiAnnotationFilter
object
AnnotationFilter is used to create a new dataset version. For now, the filter is simply a wrapper over a Search. In the future, we may add extra fields to cust…
6 properties
apiConceptExtraInfo
object
ConceptExtraInfo represents extra information related to a concept that is context-dependent. It is only set when requested in ConceptExtraInfoRequest.
1 property
apiMultiDatasetVersionResponse
object
2 properties
V2DeleteCollaboratorsBody
object
3 properties
apiGeoPoint
object
2 properties
V2DeleteArtifactBody
object
2 properties
apiSingleUserResponse
object
2 properties
V2PatchModelCheckConsentsBody
object
3 properties
TaskReviewTaskReviewStrategy
string
- NONE: No review is needed. When a labeler labels an input, the annotations are immediately approved. - MANUAL: Human reviewers will review the work done by l…
apiPipelineVersionRun
object
13 properties
apiInputSettings
object
4 properties
apiOutputConfig
object
OutputConfig is a collection of parameters controlling either inference or training settings for the given Model. This message will be deprecated over time in…
13 properties
apiCollaborator
object
8 properties
apiUser
object
24 properties
apiPostModelVersionsUploadRequest
object
2 properties
V2PatchModelLanguagesBody
object
3 properties
V2PostInputsBody
object
4 properties
apiPatchAnnotationsRequest
object
4 properties
V2PostConceptLanguagesBody
object
POST multiple concept languages for the given concept.
2 properties
DeploymentSchedulingChoice
string
In some scenarios it may not be obvous how we should schedule a resource to underlying nodes within the nodepool(s) above. The SchedulerChoice allows us to spe…
apiDatasetInput
object
2 properties
apiDeployment
object
A deployment allows you to configure how runners for a particular type of resource will scale up and down. These are unique per userid, nodepool and model so f…
19 properties
V2DeleteDatasetVersionsBody
object
Request to delete several dataset versions by list of ids.
2 properties
SplitIntoDatasetsDatasetSplitMethod
string
apiMultiConceptCountResponse
object
2 properties
apiComputeInfo
object
These are the resource needs of a given API object such as a model. This is what they require as a minimum to run and will be used upon scheduling as the reque…
8 properties
V2PatchConceptsBody
object
3 properties
apiBulkOperation
object
12 properties
V2PostPipelineVersionRunFromTemplateBody
object
6 properties
V2PostPipelineVersionRunsBody
object
3 properties
V2PatchWorkflowIdsBody
object
3 properties
apiSingleConceptLanguageResponse
object
2 properties
apiQuery
object
This is the search query used in /searches, model training requests, bulk data exports, etc.
4 properties
V2PostAnnotationTracksBody
object
2 properties
apiTaskWorkerPartitionedStrategyInfo
object
3 properties
apiKnowledgeGraph
object
5 properties
apiTaskConceptAutoAnnotationConfig
object
5 properties
apiScopeDeps
object
2 properties
apiMultiNodepoolResponse
object
2 properties
apiWorkflowVersionEvaluationMetric
object
5 properties
apiEvaluationType
string
apiSingleWorkflowResponse
object
2 properties
apiEvalTestSetEntry
object
6 properties
apiPostInputsRequest
object
4 properties
V2PostModelVersionEvaluationsBody
object
2 properties
apiAddConcepts
object
1 property
apiEndpointDeps
object
2 properties
apiAddMetadata
object
1 property
apiPipelineTemplateParameterType
string
apiPatchWorkflowsRequest
object
3 properties
apiTask
object
Task is the work that needs to be done for labeling the inputs in an app.
23 properties
apiAiAssistParameters
object
3 properties
V2PatchCollaboratorsBody
object
3 properties
apiAuditLogEntry
object
AuditLogEntry is a single operation recorded in an audit log.
9 properties
V2PatchWorkflowVersionsBody
object
3 properties
apiPostAnnotationsRequest
object
2 properties
apiHitCount
object
1 property
apiSingleArtifactVersionResponse
object
2 properties
apiMultiLogEntryResponse
object
4 properties
apiPassword
object
1 property
apiArgoOrchestrationSpec
object
2 properties
apiReviewRequestChangesConfig
object
2 properties
V2PatchDeploymentsBody
object
3 properties
V2PutUploadContentPartsBody
object
Upload a part of a multipart upload. Behaviour on completion depends on the endpoint that was used to initiate the upload.
2 properties
apiSinglePasswordValidationResponse
object
2 properties
ConstraintsStringConstraints
object
4 properties
apiTaskReviewConsensusStrategyInfo
object
3 properties
apiPostSearchesRequest
object
4 properties
apiDeploymentNodepool
object
DeploymentNodepool associates a nodepool with a deployment and holds per-nodepool settings.
4 properties
apiModelTypeEnumOption
object
6 properties
V2PostModelVersionsBody
object
Create (train) a new model version.
5 properties
apiInputsAddJobProgress
object
4 properties
apiPostArtifactVersionsUploadRequest
object
2 properties
apiTaskTaskType
string
- CONCEPTSCLASSIFICATION: Concepts classification tasks annotate concepts for the overall image, frame of video or section of text. - BOUNDINGBOXDETECTION: Bou…
apiSingleDeploymentResponse
object
2 properties
V2PostConceptsSearchesBody
object
4 properties
apiSingleDatasetResponse
object
2 properties
apiComputeCluster
object
We define a cluster here to be used in Nodepools and by the cloud provider. There will be one cloud provider per Cluster. This allows us to define Clusters tha…
11 properties
V2PostAnnotationsBody
object
2 properties
apiDatasetVersionMetricsGroupType
string
- INPUTTYPE: Group data examples by input type. Examples: images, videos, text, audio. - CONCEPTID: Group data examples by concept ID. Examples: inputs with ca…
apiRunnerItemMetadata
object
2 properties
apiDeleteGeo
object
apiMultiOutputResponse
object
3 properties
V2PostTasksBody
object
Request to create Tasks.
2 properties
apiW3C
object
2 properties
apiDeleteAnnotationFiltersRequest
object
Request to delete several annotation filters by list of ids.
2 properties
apiWorkflowVersion
object
12 properties
apiPatchSearchesRequest
object
3 properties
apiSinglePipelineVersionRunResponse
object
2 properties
apiLabelCount
object
3 properties
apiModelTypeFieldDataType
string
DataType is used in MethodSignature to define all the possible types that a python function may have that we want to support. These include built-ins like int,…
apiSingleAppDuplicationResponse
object
2 properties
V2PostModelOutputsBody
object
////////////////////////////////////////////////// Model prediction related stuff needs inputs and produces outputs. //////////////////////////////////////////…
8 properties
apiWorkflowVersionEvaluation
object
12 properties
apiWorkflowModelUseCase
string
- CLASSIFICATION: Classifier models without a detector parent (recursive check) in a workflow are used for classification. - DETECTION: Detector models in a wo…
V2DeleteNodepoolsBody
object
2 properties
apiTaskInputSourceMetrics
object
1 property
apiModelReference
object
A link to a html/markdown/text file that stores reference material tied to a model.
5 properties
apiPipelineVersion
object
11 properties
apiSingleInputsExtractionJobResponse
object
2 properties
apiRunnerMetrics
object
RunnerMetrics captures metrics and status for a Runner's underlying k8s deployment. This allows tracking of deployment health, replica counts, and other releva…
4 properties
apiReviewRejectConfig
object
2 properties
V2PostRunnerReplicaTaskMetricsBody
object
2 properties
apiRunnerSelector
object
//////////////////////////////////////// Don't need RunnerSelector if we're opening up endpoints for deployments. //////////////////////////////////////// The…
3 properties
apiProcessingInfo
object
3 properties
apiRoleType
string
apiPostAnnotationFiltersRequest
object
Request to add one or more annotation filters.
2 properties
apiOrchestrationArgsOverride
object
1 property
apiMask
object
Segmentation mask.
1 property
apiPatchModelsRequest
object
3 properties
apiLicenseType
string
apiMultiModelVersionInputExampleResponse
object
2 properties
apiPretrainedModelConfig
object
4 properties
V2PostModelsSearchesBody
object
Search over the available models.
3 properties
apiSingleDatasetVersionResponse
object
2 properties
apiReviewStartConfig
object
1 property
apiPostPipelineStepVersionsUploadRequest
object
2 properties
apiPostRunnerItemOutputsRequest
object
PostRunnerItemOutputsRequest This is the message that runners send to the API to communicate. At the end of the request it will have the RunnerItemOutput fille…
10 properties
statusBaseResponse
object
Base message to return when there is a internal server error that is not caught elsewhere.
1 property
V2PostModelsBody
object
3 properties
apiWorkflowState
object
1 property
apiMultiModelUseCaseResponse
object
2 properties
SearchMetric
string
Metric used for search. Can be EUCLIDEANDISTANCE (default) or COSINEDISTANCE. Currently only brute force search supports non-eudlicean metrics.
apiNodepool
object
A nodepool is a set of nodes dedicated for a given user's compute needs. This compute will typically be consumed by runners and in the future other objects lik…
18 properties
apiTrack
object
4 properties
apiWorkflowNode
object
5 properties
apiModelVersionPublishRequest
object
1 property
apiSingleSecretResponse
object
2 properties
apiImageInfo
object
5 properties
apiDatasetVersionExportFormat
string
- CLARIFAIDATAPROTOBUF: CLARIFAIDATAPROTOBUF is the proprietary Clarifai API Data format. It is a ZIP-archive containing batches of serialized InputBatch proto…
apiSingleAppResponse
object
2 properties
apiUserDetail
object
This message holds the confidential information from the User object that we don't want to expose to other users. It will be accessible only from /users/{useri…
14 properties
apiSingleDatasetInputResponse
object
2 properties
apiModelVersionExport
object
ModelVersionExport contains metadata for a single Model version export.
3 properties
apiRole
object
8 properties
apiMultiTaskResponse
object
Response with multiple Tasks.
2 properties
apiPostModelVersionsUploadResponse
object
3 properties
V2PatchWorkflowsBody
object
3 properties
V2PatchAnnotationsStatusBody
object
5 properties
V2DeletePipelinesBody
object
2 properties
apiSingleConceptResponse
object
2 properties
apiTimeRange
object
2 properties
apiPolygon
object
1 property
apiPoint
object
4 properties
V2PostModelVersionMetricsBody
object
Evaluate this model version.
3 properties
apiEvaluationMetricValue
object
4 properties
V2PatchRunnersBody
object
3 properties
apiAppDuplicationFilters
object
5 properties
apiInputsAddJob
object
9 properties
apiModelLayerInfo
object
4 properties
apiMultiPipelineTemplateResponse
object
2 properties
V2PostNodepoolsBody
object
2 properties
apiVideoInfo
object
7 properties
TaskWorkerPartitionedStrategyInfoTaskWorkerPartitionedStrategy
string
- EVENLY: Each worker will label (approximately) the same number of inputs. - WEIGHTED: Each worker will have an assigned weight. See weights field for more de…
apiPostPipelineStepVersionsUploadResponse
object
3 properties
apiPostValidatePasswordRequest
object
2 properties
ModelTypeFieldModelTypeFieldType
string
These are various types of fields that we have UIs for. - ARRAYOFCONCEPTS: For auto-completing to concepts in the app. This goes into an data.concepts field. -…
apiModelPredictConfig
object
1 property
apiDatasetSplit
object
2 properties
apiPipelineStepVersion
object
13 properties
apiConcept
object
14 properties
apiMultiRunnerItemResponse
object
2 properties
V2PostInputsSearchesBody
object
4 properties
apiLabelDistribution
object
1 property
V2DeletePipelineStepVersionsBody
object
2 properties
apiRegion
object
A region within the data.
5 properties
apiDeleteTasksRequest
object
Request to delete a list of tasks.
2 properties
BookmarkOriginBookmarkType
string
V2PostKnowledgeGraphsBody
object
2 properties
apiRunnerItem
object
This is a unit of work for a runner to process. This comes from the API in the MultiRunnerItemResponse and contains the user's requests to process.
7 properties
V2PostKeysBody
object
2 properties
apiTaskReview
object
5 properties
V2PatchModelVersionsBody
object
3 properties
apiSingleArtifactResponse
object
2 properties
apiCommitmentValue
object
2 properties
V2DeleteWorkflowsBody
object
Request to delete several things by the list of ids.
3 properties
apiDatasetVersion
object
17 properties
apiWorkflowResult
object
WorkflowResult One result per input in the workflow.
6 properties
apiMetricValue
object
3 properties
apiInputInfo
object
3 properties
apiToken
object
3 properties
apiAWSCreds
object
AWS S3 storage credentials.
4 properties
V2PostRunnerItemOutputsBody
object
PostRunnerItemOutputsRequest This is the message that runners send to the API to communicate. At the end of the request it will have the RunnerItemOutput fille…
6 properties
V2PatchAnnotationsSearchesBody
object
3 properties
apiModelQuery
object
2 properties
apiAutoAnnotationRequest
object
3 properties
apiMultiPipelineVersionRunResponse
object
2 properties
apiDeleteUploadsRequest
object
2 properties
apiTaskAIAssistant
object
2 properties
apiSingleModelVersionResponse
object
2 properties
V2DeletePipelineStepsBody
object
2 properties
apiMultiRunnerResponse
object
2 properties
apiMultiDatasetInputResponse
object
3 properties
V2PostConceptsBody
object
2 properties
apiTritonCondaEnvInfo
object
2 properties
apiMultiCloudRegionResponse
object
3 properties
apiSpan
object
3 properties
V2PostAnnotationsSearchesBody
object
3 properties
V2PatchAnnotationTracksBody
object
3 properties
apiSecret
object
8 properties
apiMetricsQueryResponse
object
3 properties
utilsTimeOfDayRange
object
4 properties
V2PostComputeClustersBody
object
2 properties
apiDeploymentMetrics
object
DeploymentMetrics captures metrics and status for a Deployment's underlying runners. This allows tracking of the desired replica count and the actual live repl…
5 properties
apiDeleteConcepts
object
2 properties
apiPostLogEntriesRequest
object
1 property
apiOrchestrationSpec
object
1 property
apiTextInfo
object
2 properties
V2DeleteTasksBody
object
Request to delete a list of tasks.
2 properties
apiDatasetVersionExportInfo
object
DatasetVersionExportInfo contains information about all exports of a dataset version. If the dataset version has not been exported in a format, then the Datase…
3 properties
V2PostPipelineStepsBody
object
2 properties
apiText
object
5 properties
apiCancelInputsExtractionJobsRequest
object
2 properties
apiDataSourceURL
object
2 properties
V2PostModelVersionsPublishBody
object
2 properties
apiWorkflowVersionUnPublishRequest
object
1 property
V2DeleteDatasetInputsBody
object
Request to delete several dataset inputs by list of ids.
2 properties
V2CancelInputsExtractionJobsBody
object
2 properties
V2PostUploadsBody
object
2 properties
apiRunner
object
14 properties
apiMultiModelReferenceResponse
object
2 properties
apiInputIDs
object
1 property
apiBuildInfo
object
4 properties
apiMultiModelLanguageResponse
object
2 properties
apiMetricData
object
1 property
apiMultiEvalMetricsResponse
object
2 properties
apiMultiModelCheckConsentResponse
object
2 properties
apiSingleRunnerResponse
object
2 properties
apiSingleNodepoolResponse
object
2 properties
apiMultiScopeDepsResponse
object
3 properties
V2PatchSecretsBody
object
3 properties
apiApp
object
21 properties
apiConceptExtraInfoRequest
object
1 property
apiConfusionMatrix
object
2 properties
V2PatchKeysBody
object
3 properties
apiLabelSubmitConfig
object
1 property
apiDatasetVersionMetrics
object
18 properties
apiSingleUploadResponse
object
2 properties
apiConceptQuery
object
7 properties
apiAppQuery
object
1 property
apiOverwriteGeo
object
1 property
V2PatchLabelOrdersBody
object
Request to patch a list of label orders.
3 properties
apiSingleWorkflowVersionResponse
object
2 properties
V2PostWorkflowVersionEvaluationsBody
object
3 properties
MetricFilterMultiValues
object
1 property
apiWorkflowVersionEvaluationData
object
5 properties
apiPostTasksRequest
object
Request to create Tasks.
2 properties
apiInputCount
object
NOTE: inconsistency: this is weird mix of plural and singular words.
8 properties
apiSingleInputResponse
object
2 properties
TaskTaskPriority
string
apiUpload
object
8 properties
V2PostWorkflowVersionsUnPublishBody
object
2 properties
apiMultiWorkflowEvaluationTemplateResponse
object
2 properties
apiRank
object
2 properties
MatrixUint64
object
Store matrix of uint64s values. It is recommended to store the matrix as a 1D array because it produces less bytes during serialization than a 2D array. The ma…
2 properties
apiMultiTaskAssignmentResponse
object
2 properties
apiSingleModelVersionExportResponse
object
2 properties
apiMetricDataLabel
object
2 properties
apiTaskInputSource
object
2 properties
apiOrchestrationStatus
object
2 properties
apiExtendedMetrics
object
1 property
apiModelType
object
ModelType is a definition of a set of models that generally have the same input and output fields. This is used to understand more about the possible models in…
14 properties
apiMultiScopeResponse
object
5 properties
V2DeleteSecretsBody
object
2 properties
apiAppExtraInfo
object
2 properties
apiOutput
object
9 properties
apiModelVersion
object
25 properties
apiPatchInputsSearchesRequest
object
3 properties
apiPipelineStepInputParam
object
4 properties
apiTaskAssignment
object
6 properties
apiSpecialHandling
object
Tracks special handling reason and whether it's been done.
3 properties
apiArgoParameterOverride
object
2 properties
V2PostSecretsBody
object
2 properties
V2PostWorkflowVersionEvaluationDataBody
object
4 properties
apiMultiAuditLogEntryResponse
object
2 properties
apiPostPipelineVersionRunFromTemplateResponse
object
3 properties
PipelineTemplateParameterUIHints
object
3 properties
apiPatchConceptsRequest
object
3 properties
TaskWorkerTaskWorkerStrategy
string
- PARTITIONED: The inputs will be partitioned in several partitions. Each worker will label one or more input partitions. All inputs are assigned at task creat…
apiListOpenSourceLicensesResponse
object
2 properties
apiAnnotationTrack
object
12 properties
V2PostNodepoolStatusBody
object
3 properties
apiOrchestrationStepSpec
object
1 property
V2PatchWorkflowVersionEvaluationsBody
object
3 properties
apiFilter
object
4 properties
V2PostValidatePasswordBody
object
2 properties
V2PatchTasksBody
object
Request to patch a list of tasks.
3 properties
apiThresholdRange
object
4 properties
apiModelTypeField
object
ModelTypeField stores a field value of a configurable type.
15 properties
apiCpuMetrics
object
5 properties
apiGpuMetrics
object
5 properties
apiDeleteDatasetsRequest
object
Request to delete several datasets by list of ids.
2 properties
V2PatchDatasetVersionsBody
object
Request to patch several dataset versions.
3 properties
apiSingleSearchResponse
object
2 properties
V2PostConceptRelationsBody
object
2 properties
apiSingleWorkflowVersionEvaluationResponse
object
2 properties
apiNDArray
object
To convert this proto 'ndarrayproto' to a numpy array: array = np.frombuffer(ndarrayproto.buffer, dtype=ndarrayproto.dtype) array = array.reshape(tuple(ndarray…
3 properties
V2PostAppDuplicationsBody
object
Deprecated: App duplication is no longer supported. Request to start app duplication jobs.
2 properties
apiMultiPipelineVersionResponse
object
2 properties
apiCollaboration
object
collaboration includes an app you're invited to work on.
5 properties
apiModelVersionInputExample
object
6 properties
V2StreamAnnotationsBody
object
9 properties
apiMultiScopeUserResponse
object
4 properties
apiMultiPipelineStepVersionResponse
object
2 properties
apiEvalInfo
object
1 property
apiDetailConceptCount
object
4 properties
apiPatchInputsRequest
object
3 properties
apiAudio
object
5 properties
apiPipelineTemplate
object
6 properties
apiModelVersionUnpublishRequest
object
1 property
apiMultiScopeRootResponse
object
4 properties
V2PatchAppsDetailsBody
object
3 properties
apiPatchAnnotationsSearchesRequest
object
3 properties
apiInputIDConflictResolution
string
- INPUTIDCONFLICTRESOLUTIONNOTSET: Defaults to SKIP - SKIP: Mark duplicate inputs as error and skip processing them. - SUFFIX: Add a suffix to inputs with conf…
apiPostDatasetsRequest
object
Request to add one or more datasets.
2 properties
apiCooccurrenceMatrixEntry
object
3 properties
V2PostInputsUploadsBody
object
Start uploading a file archive containing inputs. Will create and return an inputs-add-job for tracking progress. Associated inputs-add-job contains an upload…
2 properties
apiMultiConceptResponse
object
2 properties
V2DeletePipelineVersionsBody
object
2 properties
apiImage
object
7 properties
apiSingleInputsAddJobResponse
object
2 properties
apiRunnerReplicaTaskMetrics
object
RunnerReplicaTaskMetrics captures auto-annotation task metrics reported by an individual runner replica. Each entry corresponds to a specific task running on a…
21 properties
apiDataSourceCredentials
object
3 properties
apiMultiPipelineStepResponse
object
2 properties
V2PatchModelUseCasesBody
object
3 properties
apiMultiCloudProviderResponse
object
2 properties
apiDeleteFromDataset
object
1 property
apiAutoscaleConfig
object
It might be better to do this as runner autoscaling so that resources of a model are very simply what that model needs at minimum. Note that resources for thin…
8 properties
apiPatchLabelOrdersRequest
object
Request to patch a list of label orders.
3 properties
apiFrameInfo
object
The information of the location of the Frame.
3 properties
apiRunnerItemOutput
object
1 property
apiConceptTypeCount
object
2 properties
apiAnnotationFilterConfig
object
2 properties
apiMultiArtifactResponse
object
2 properties
apiOutputInfo
object
OutputInfo defines some of the settings for each model version that PatchModels can effect. These parameters control some of the training or inference operatio…
6 properties
apiWorkflowVersionEvaluationTemplate
object
4 properties
apiPasswordViolations
object
14 properties
apiTimeSegment
object
3 properties
V2PostWorkflowsBody
object
2 properties
apiPart
object
A part of data used for multi-modal processing.
2 properties
apiWorkflowVersionEvaluationTemplateTaskType
string
V2PatchAnnotationsBody
object
4 properties
V2DeleteArtifactVersionBody
object
2 properties
V2PatchPipelineVersionsBody
object
3 properties
apiLayerShape
object
4 properties
apiConceptLanguage
object
This represents a link to an outside source for the given concept. The values from here are sticked into Concept message into the name and definition fields wh…
3 properties
V2PatchModelsBody
object
3 properties
apiMultiCollaborationsResponse
object
2 properties
apiTaskReviewManualStrategyInfo
object
2 properties
apiMetricFilter
object
3 properties
apiUploadContentPart
object
3 properties
apiTrainInfo
object
3 properties
apiAzureBlobCreds
object
Azure Blob storage credentials.
2 properties
apiMultiConceptRelationResponse
object
2 properties
apiPatchAction
object
3 properties
V2PostDatasetVersionsBody
object
Request to add one or more dataset versions.
2 properties
ConstraintsFloatConstraints
object
2 properties
apiTaskReviewMetrics
object
5 properties
apiMultiWorkflowVersionResponse
object
2 properties
apiInput
object
7 properties
apiMultiInputsExtractionJobResponse
object
2 properties
apiArgoOrchestrationStepSpec
object
2 properties
apiAnnotationDataType
string
apiBinaryMetrics
object
13 properties
apiSplitIntoDatasets
object
2 properties
WorkflowVersionEvaluationMetricVisualisationType
string
apiPipelineVersionConfig
object
1 property
apiMultiCollaboratorsResponse
object
3 properties
V2PatchSearchesBody
object
3 properties
apiSearch
object
This is the new Search object used in saved searches.
13 properties
apiGeoLimit
object
2 properties
apiUserAppIDSet
object
Common message to identify the app in a url endpoint.
2 properties
V2DeleteAnnotationTracksBody
object
2 properties
apiMultiDatasetVersionMetricsGroupResponse
object
2 properties
CommitmentValueCommitmentType
string
AppEmbeddingsStorage
string
V2DeleteModelsBody
object
Request to delete several things by the list of ids.
3 properties
apiPatchDatasetsRequest
object
Request to patch several datasets.
3 properties
apiPostModelsSearchesRequest
object
Search over the available models.
3 properties
apiMultiWorkflowResponse
object
2 properties
apiInputsDataSource
object
4 properties
apiMultiConceptLanguageResponse
object
2 properties
apiPointVisibility
string
- NOTSET: Visibility of the point is not set - VISIBLE: Point is visible - NOTVISIBLE: Point is occluded - NOTPRESENT: Point is not in the image
apiArgoOrchestrationStatus
object
1 property
apiMultiDeploymentResponse
object
2 properties
apiPostModelOutputsRequest
object
////////////////////////////////////////////////// Model prediction related stuff needs inputs and produces outputs. //////////////////////////////////////////…
8 properties
apiHit
object
5 properties
apiAuditLogTarget
object
AuditLogTarget is a resource on which an operation recorded in an audit log was performed.
11 properties
ModelSource
string
apiPostInputsUploadsRequest
object
Start uploading a file archive containing inputs. Will create and return an inputs-add-job for tracking progress. Associated inputs-add-job contains an upload…
2 properties
apiPatchAnnotationsStatusResponse
object
3 properties
V2PostAnnotationFiltersBody
object
Request to add one or more annotation filters.
2 properties
V2DeleteRunnersBody
object
Request to delete several things by the list of ids.
2 properties
ConstraintsIntConstraints
object
2 properties
apiNodeCapacityType
object
Type of nodes that are ok for instances in this pool. If both spot and on-demand are provided then the runner will be able to run on either with a preference f…
1 property
apiMultiInputsAddJobResponse
object
2 properties
MatrixDataTimeSeries
object
2 properties
apiMetricsSummary
object
10 properties
apiPostKnowledgeGraphsRequest
object
2 properties
V2StreamLivestreamAnnotationsBody
object
2 properties
apiFullTag
object
2 properties
apiCluster
object
5 properties
apiPostWorkflowResultsResponse
object
4 properties
NodeCapacityTypeCapacityType
string
apiMultiStatusCodeResponse
object
2 properties
apiSingleTaskCountResponse
object
4 properties
apiGetVideoManifestResponse
object
2 properties
apiMultiAnnotationResponse
object
2 properties
apiKeypointInfo
object
2 properties
V2PostBulkOperationsBody
object
Request to perform bulk operations on a list of inputs based on input source.
2 properties
apiDeleteBulkOperationRequest
object
Request to delete the terminated bulk operations by ID Only operations in terminated state can be deleted.
2 properties
SpecialHandlingReason
string
V2DeleteAnnotationFiltersBody
object
Request to delete several annotation filters by list of ids.
2 properties
apiSingleInputCountResponse
object
2 properties
apiPostInputsSearchesRequest
object
4 properties
apiMultiComputeClusterResponse
object
2 properties
apiSingleModelVersionInputExampleResponse
object
2 properties
apiMetricTypeLabels
object
2 properties
V2PatchInputsSearchesBody
object
3 properties
apiEventType
string
apiComputeSourceMetadata
object
ComputeSourceMetadata describes the source of something computed. The who and where.
13 properties
apiCloudRegion
object
CloudRegion represents a region where compute resources can be deployed.
2 properties
UIHintsUIWidget
string
apiMultiKnowledgeGraphResponse
object
2 properties
apiNodeInput
object
NodeInput represents inputs to a node of the graph.
1 property
V2PostWorkflowVersionsPublishBody
object
2 properties
apiTaskMetrics
object
3 properties
apiIdUpdateSource
object
2 properties
apiDatasetVersionExport
object
DatasetVersionExport contains metadata for a single dataset version export.
5 properties
apiPostUploadsRequest
object
2 properties
V2CancelInputsAddJobBody
object
1 property
V2PostInputsDataSourcesBody
object
Initiates retrieval of inputs from cloud storage from a user provided data source. Will create and return an inputs-add-job for tracking progress. Archives wil…
4 properties
apiPipelineTemplateParameter
object
10 properties
apiModelTypeEnumOptionAlias
object
2 properties
TaskWorkerWorkerType
string
apiPrecisionRecallCurve
object
3 properties
apiPipelineStep
object
7 properties
apiMultiSearchResponse
object
6 properties
V2PutTaskAssignmentsBody
object
8 properties
apiPostModelsRequest
object
3 properties
apiMultiAppResponse
object
2 properties
apiEmbedding
object
2 properties
V2PostSearchesByIDBody
object
2 properties
V2PostPipelinesBody
object
2 properties
apiSingleModelTypeResponse
object
2 properties
V2PatchInputsBody
object
3 properties
apiDeleteAnnotationsRequest
object
Request to delete several things by the list of ids.
3 properties
apiSingleBulkOperationsResponse
object
2 properties
apiInputsUpload
object
5 properties
apiWorkflowEvaluationInputResult
object
1 property
V2PostEvaluationsBody
object
2 properties
apiWorker
object
Worker is the author of an annotation.
3 properties
apiPostArtifactVersionsUploadResponse
object
3 properties
apiBoundingBox
object
Rectangular bounding box for a region.
4 properties
apiSinglePipelineStepVersionResponse
object
2 properties
apiMultiBulkOperationsResponse
object
2 properties
apiTaskWorkMetrics
object
2 properties
apiTaskStatusCountPerUser
object
7 properties
apiMultiModelToolkitResponse
object
2 properties
apiDeployRestriction
string
- USAGERESTRICTIONNOTSET: Default uninitialized state. - NOLIMITS: No restrictions on usage. - SHAREDCOMPUTEONLY: Model can only be used on shared compute reso…
apiDeleteLabelOrdersRequest
object
Request to delete a list of label orders.
2 properties
V2PostWorkflowResultsBody
object
7 properties
apiImportInfo
object
1 property
MetricDataMatrixData
object
1 property
apiTaskWorker
object
TaskWorker includes information about the workers that will work on this task.
7 properties
googlerpcStatus
object
3 properties
V2GenerateModelOutputsBody
object
////////////////////////////////////////////////// Model prediction related stuff needs inputs and produces outputs. //////////////////////////////////////////…
7 properties
V2PostRunnersBody
object
2 properties
apiMultiArtifactVersionResponse
object
2 properties
apiHostedURL
object
4 properties
apiPostInputsDataSourcesRequest
object
Initiates retrieval of inputs from cloud storage from a user provided data source. Will create and return an inputs-add-job for tracking progress. Archives wil…
4 properties
TaskInputSourceTaskInputSourceType
string
apiGeo
object
3 properties
apiPatchAnnotationFiltersRequest
object
Request to patch several annotation filters.
3 properties
apiWorkflow
object
17 properties
V2PostModelMigrationBody
object
1 property
apiSinglePipelineResponse
object
2 properties
apiPostConceptsRequest
object
2 properties
apiDatasetVersionProcessingInfo
object
DatasetVersionProcessingInfo contains information about processing applied to a dataset version.
1 property
apiSinglePipelineStepResponse
object
2 properties
statusStatusCode
string
expired cc, still in trial, feature not supported in your tier - CONNTOKENINVALID: invalid auth token used. Deprecated: we should return CONNKEYINVALID instead…
apiVideo
object
7 properties
apiSingleModelResponse
object
3 properties
apiPostComputePlaneMetricsRequest
object
1 property
apiV2DeleteAnnotationsBody
object
Request to delete several things by the list of ids.
3 properties
apiInstanceType
object
The instance types that will be available in this pool of nodes. Clarifai offers multiple different choices that combine cpu cores, memory and accelerator.
11 properties
apiArgoArgsOverride
object
1 property
apiArtifact
object
Artifact is a resource that represents a file stored in Clarifai's storage system. It should have a reference to upload resource which contains the actual file…
7 properties
apiCloudProvider
object
CloudProvider represents the entity that provides the infrastructure where the Nodepools are deployed. This could be a public cloud provider like AWS, GCP, Azu…
3 properties
apiDeleteMetadata
object
1 property
apiTrackerMetrics
object
6 properties
apiMultiModelVersionResponse
object
2 properties
apiMetricSearchQuery
object
6 properties
apiMultiPipelineVersionRunStatusLogResponse
object
2 properties
V2PatchAppsBody
object
5 properties
V2PostSearchesBody
object
4 properties
statusRedirectInfo
object
4 properties
V2PostDatasetsBody
object
Request to add one or more datasets.
2 properties
apiTeam
object
Represents a group of users.
5 properties
apiComputePlaneMetrics
object
ComputePlaneMetrics captures the compute plane metrics to send back to the control plane. Each message should have the meta filled and one or more of the other…
13 properties
apiFrame
object
A Frame of time-series Data such as a Video.
3 properties
apiSingleTaskResponse
object
Response with a single Task.
2 properties
apiDeploymentStatus
string
Status of the deployment. - ENABLED: Default: deployment is enabled and can serve traffic. - DISABLED: Deployment is disabled: scaled to zero, traffic rejected.
V2PostArtifactsBody
object
2 properties
apiAudioInfo
object
4 properties
apiOperation
object
10 properties
apiPostArtifactVersionsUploadConfig
object
5 properties
apiDatasetVersionMetricsGroup
object
4 properties
V2PostModelVersionsTrainingTimeEstimateBody
object
3 properties
apiMultiUploadResponse
object
2 properties
apiPipelineVersionRunStatusLog
object
6 properties
apiInputsExtractionJobProgress
object
8 properties
apiGeoBoxedPoint
object
1 property
V2PostModelVersionsUnPublishBody
object
2 properties
apiConceptCount
object
4 properties
MetricDataMetricSample
object
2 properties
apiArtifactVersion
object
ArtifactVersion represents a specific version of the artifact.
9 properties
MetricAggregateOperator
string
apiMultiSecretResponse
object
2 properties
apiWorkflowEvaluationResultSummary
object
1 property
MetricTypeLabelsLabelWithValues
object
2 properties
PipelineTemplateParameterConstraints
object
3 properties
apiDataset
object
16 properties
V2DeleteBulkOperationsBody
object
Request to delete the terminated bulk operations by ID Only operations in terminated state can be deleted.
2 properties
V2PatchAppBody
object
5 properties
apistatusStatus
object
11 properties
V2PostAppsBody
object
2 properties
apiMultiModelResponse
object
2 properties
apiOpenRouterInfo
object
1 property
apiMultiMetricLabelsResponse
object
2 properties
apiMultiInputResponse
object
3 properties
ModelBillingType
string
apiAppDuplication
object
10 properties
apiConceptRelation
object
6 properties
V2PatchNodepoolsBody
object
3 properties
apiKey
object
10 properties
V2PatchAnnotationFiltersBody
object
Request to patch several annotation filters.
3 properties
clarifaiapiVisibility
object
Visibility represents how visible the given resource is to other users. When authenticating a request we can tell if a user is a collaborator or a teammate for…
1 property
V2PutDatasetVersionExportsBody
object
Request to create exports of a dataset version.
2 properties
apiDeleteInputsRequest
object
Request to delete several things by the list of ids.
2 properties
apiWorkflowVersionEvaluationMetricDataType
string
apiDeleteModelsRequest
object
Request to delete several things by the list of ids.
3 properties
apiMultiLabelOrderResponse
object
Response with multiple label order.
2 properties
V2PostMetricsQueryBody
object
2 properties
V2PatchPipelinesBody
object
3 properties
V2PostDeploymentsBody
object
2 properties
apiMultiPipelineResponse
object
2 properties
apiMultiWorkflowVersionEvaluationResponse
object
2 properties
apiMetricType
string
apiConfusionMatrixEntry
object
5 properties
apiEmailAddress
object
3 properties
V2PatchDatasetsBody
object
Request to patch several datasets.
3 properties
V2DeleteLabelOrdersBody
object
Request to delete a list of label orders.
2 properties
apiPostModelVersionsUploadConfig
object
6 properties
apiModelTypeRangeInfo
object
3 properties
VisibilityGettable
string
Gettable defined the level of access for GET operations for this resource. - UNKNOWNVISIBILITY: Default value not allowed. - PRIVATE: PRIVATE requires collabor…
V2PostAppsSearchesBody
object
Search over the available applications.
3 properties
apiMultiRunnerItemOutputResponse
object
2 properties
apiTimeInfo
object
3 properties
apiMultiAppDuplicationsResponse
object
2 properties
apiFrameInterpolationInfo
object
FrameInterpolationInfo contains information about frame annotations interpolated from other video annotations, such as image object-detection regions generated…
1 property
apiSingleEvalMetricsResponse
object
2 properties
apiAppResourceCounts
object
5 properties
apiMultiInstanceTypeResponse
object
2 properties
apiRegionInfo
object
The information of the location of the Region.
7 properties
V2DeleteConceptRelationsBody
object
2 properties
apiPostEvaluationsRequest
object
2 properties
apiMultiModelTypeResponse
object
4 properties
V2PostTrackAnnotationsSearchesBody
object
8 properties
apiMultiTrainingTimeEstimateResponse
object
2 properties
apiSingleAnnotationFilterResponse
object
2 properties
apiSingleKeyResponse
object
2 properties
V2PatchPipelineVersionRunsBody
object
3 properties
apiTaskConcept
object
2 properties
V2CancelBulkOperationsBody
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#v2
Where this information came from
This is an independent, third-party profile of Clarifai V2 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.