Clarifai Users API
The Users API from Clarifai — 175 operation(s) for users.
Operations 281
Showing the first 250 of 281. The full set is in the contract, and via get_provider_operations.
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…
#
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
V2 cancel inputs extraction jobs
#
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…
#
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.
#
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…
#
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
#
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
#
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/models
Delete multiple models in one request
#
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.
#
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.
#
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…
#
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…
#
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 model_id or model_id/version_id 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 use_cases 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…
#
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…
#
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
V2 list log entries4
#
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…
#
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.
#
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…
#
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…
#
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 model_id or model_id/version_id 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…
#
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.
#
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps
V2 list pipeline steps
#
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps
V2 delete pipeline steps
#
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps
V2 post pipeline steps
#
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps/{pipeline_step_id}
V2 get pipeline step
#
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps/{pipeline_step_id}/versions
V2 list pipeline step versions
#
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipeline_steps/{pipeline_step_id}/versions
V2 delete pipeline step 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}
V2 get pipeline step version
#
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…
#
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}
V2 get pipeline
#
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions
V2 list pipeline versions
#
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions
V2 delete pipeline versions
#
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions
V2 patch pipeline versions
#
GET
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}
V2 get pipeline version
#
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
V2 post pipeline version runs
#
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/runs
V2 patch pipeline version 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}
V2 get pipeline version run
#
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
V2 list pipeline version run 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
V2 list log entries5
#
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
V2 stream log entries3
#
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.
#
DELETE
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/tasks
Delete multiple tasks in one request
#
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=LABEL_START.
#
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…
#
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
V2 get input samples
#
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/uploads
PostUploads is used to upload files.
#
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.
#
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.
#
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
V2 post workflow versions 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
V2 post workflow versions un publish
#
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
V2 list workflow version evaluations
#
POST
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions/{workflow_version_id}/evaluations
V2 post workflow version evaluations
#
PATCH
/v2/users/{user_app_id.user_id}/apps/{user_app_id.app_id}/workflows/{workflow_id}/versions/{workflow_version_id}/evaluations
V2 patch workflow version 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}
V2 get workflow version evaluation
#
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
V2 list workflow version evaluation 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
V2 post workflow version evaluation data
#
GET
/v2/users/{user_app_id.user_id}/collaborations
Collaboration includes the app user are invitied to work on
#
DELETE
/v2/users/{user_app_id.user_id}/compute_clusters
Delete multiple compute_clusters in one request
#
GET
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools
V2 list 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
V2 post nodepools
#
PATCH
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools
V2 patch 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.
#
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.
#
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 runner_id is a UUID we can…
#
GET
/v2/users/{user_app_id.user_id}/compute_clusters/{compute_cluster_id}/nodepools/{nodepool_id}/runners/{runner_id}/{log_type}/logs
V2 list log entries
#
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
#
Documentation
📖
Documentation
https://docs.clarifai.com
📖
Authentication
https://docs.clarifai.com/getting-started/quickstart/