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…
#
POST
/v2/artifact_versions/upload
This is a streaming endpoint, the request has a field, upload_data, which can…
#
GET
/v2/cloud_providers/{cloud_provider.id}/regions/{region}/instance_types
Get InstanceTypes given Cloud Provider and Region
#
PATCH
/v2/concepts/{concept_id}/languages
Patch the name for a given language names by passing in a list of concepts with…
#
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
V2 list dataset version metrics groups2
#
POST
/v2/inputs/data_sources
Initiates retrieval of inputs from cloud storage from a user provided data…
#
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…
#
POST
/v2/inputs/{input_id}/annotations/stream/live
Stream live video annotations as soon as they are available.
#
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…
#
DELETE
/v2/label_orders
Delete multiple label orders in one request. this do not change task status
#
POST
/v2/models/versions/upload
This is a streaming endpoint, the request has a field, upload_data, which can…
#
GET
/v2/models/{model_id}/inputs
Deprecated: Unmaintained and ideally replaced with usage of datasets The server…
#
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…
#
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…
#
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…
#
GET
/v2/models/{model_id}/versions/{version_id}/metrics
Get the evaluation metrics for a model version.
#
POST
/v2/models/{model_id}/versions/{version_id}/metrics
Deprecated, use PostEvaluations instead Run the evaluation metrics for a model…
#
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
#
POST
/v2/pipeline_step_versions/upload
This is a streaming endpoint, the request has a field, upload_data, which can…
#
GET
/v2/pipeline_templates
Lists pipeline templates, which are ready-to-use templates that can simply be…
#
GET
/v2/pipelines/{pipeline_id}/versions/{pipeline_version_id}/runs/{pipeline_version_run_id}
V2 get pipeline version run2
#
POST
/v2/runners/items/process
This maintains a single request for asking the API if there is any work to be…
#
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
V2 stream log entries
#
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
V2 stream log entries2
#
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.
#
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
#
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…
#
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/artifacts/{artifact_id}
V2 get artifact
#
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/artifacts/{artifact_id}/versions
V2 list artifact versions
#
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/artifacts/{artifact_id}/versions
V2 delete artifact version
#
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/artifacts/{artifact_id}/versions/{artifact_version_id}
V2 get artifact version
#
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.
#
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.
#
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.
#
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…
#
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.
#
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
#
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/datasets
Patch one or more datasets.
#
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.
#
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
V2 list dataset version metrics groups
#
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/duplications
Deprecated: App duplication is no longer supported.
#
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/evaluations/{evaluation_id}
V2 get evaluation
#
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.
#
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…
#
Documentation
📖
Documentation
https://docs.clarifai.com
📖
Authentication
https://docs.clarifai.com/getting-started/quickstart/