Clarifai V2 API
The V2 API from Clarifai — 297 operation(s) for v2.
Operations 466
Showing the first 250 of 466. The full set is in the contract, and via get_provider_operations.
GET
/v2/annotations/workers
ListAnnotationWorkers lists users, models, and workflows (collectively known as "workers") that have added annotations to the application.
#
POST
/v2/artifact_versions/upload
This is a streaming endpoint, the request has a field, upload_data, which can either be the config for the upload or the actual data to upload. The config must be sent first before
#
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 Li
#
GET
/v2/cloud_providers/{cloud_provider.id}/regions/{region}/instance_types
Get InstanceTypes given Cloud Provider and Region
#
POST
/v2/concepts/searches
Search over the concepts to find one or more you're looking for. This leverage the "body" parameter because we also have page and per_page as url query param variables in this requ
#
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.
#
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 ret
#
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 a
#
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 da
#
DELETE
/v2/datasets/{dataset_id}/versions
Delete one or more dataset versions in a single request.
#
PUT
/v2/datasets/{dataset_id}/versions/{dataset_version_id}/exports
Create export of a dataset version.
#
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
#
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 th
#
GET
/v2/inputs/jobs/extraction/{inputs_extraction_job_id}
Get the input extraction job details by ID
#
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 p
#
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 o
#
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 implemen
#
DELETE
/v2/label_orders
Delete multiple label orders in one request. this do not change task status
#
POST
/v2/models/searches
Search over the models to find one or more you're looking for. This leverage the "body" parameter because we also have page and per_page as url query param variables in this reques
#
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.
#
POST
/v2/models/versions/upload
This is a streaming endpoint, the request has a field, upload_data, which can either be the config for the upload or the actual data to upload. The config must be sent first before
#
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.
#
GET
/v2/models/{model_id}/output_info
Get a the output info for a given model_id or model_id/version_id combo.
#
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}/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 model_id or model_id/version_id combo.
#
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:
#
POST
/v2/pipeline_step_versions/upload
This is a streaming endpoint, the request has a field, upload_data, which can either be the config for the upload or the actual data to upload. The config must be sent first before
#
GET
/v2/pipeline_templates
Lists pipeline templates, which are ready-to-use templates that can simply be run on demand.
#
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 MultiRunnerItemOutputRe
#
GET
/v2/tasks/{task_id}/assignments
Deprecated: Use PutTaskAssignments with action=LABEL_START. This endpoint has initially been designed as a GET request, but has been re-designed to serve a PUT logic. In order to c
#
POST
/v2/uploads
PostUploads is used to upload files. Note that this does not create inputs. returns job with uploadID, job has UPLOAD_IN_PROGRESS status Actual upload content can be done in multip
#
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
#
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.
#
POST
/v2/users/{user_app_id.user_id}/apps/searches
Search over the applications to find one or more you're looking for.
#
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 per_page as url query param variables in this request.
#
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.
#
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/{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 Li
#
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.
#
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 concept_id is empty this will still match /concepts/relations to list all the concept
#
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 per_page as url query param variables in this requ
#
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 concept_id is empty this will still match /concepts/relations to list all the concept
#
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.
#
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 ret
#
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 a
#
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 da
#
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 applicatio
#
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
#
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 th
#
Documentation
📖
Documentation
https://docs.clarifai.com
📖
Authentication
https://docs.clarifai.com/getting-started/quickstart/