GitHubStart free

Artifact versions

List Artifact Versions

get

Get artifact versions according to query filters.

Args: artifact_version_filter_model: Filter model used for pagination, sorting, filtering. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response. auth_context: The authentication context.

Returns: The artifact versions according to query filters.

Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
hydratebooleanOptionalDefault: false
sort_bystringOptionalDefault: created
logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:
pageinteger · min: 1OptionalDefault: 1
sizeinteger · min: 1 · max: 10000OptionalDefault: 20
idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
createdany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
updatedany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
run_metadataany ofOptional
string[]Optional
or
nullOptional
tagany ofOptional
stringOptional
or
nullOptional
tagsany ofOptional
string[]Optional
or
nullOptional
scope_userany ofOptional
string · uuidOptional
or
nullOptional
userany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
projectany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
artifactany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
artifact_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
versionany ofOptional
stringOptional
or
nullOptional
version_numberany ofOptional
integerOptional
or
stringOptional
or
nullOptional
uriany ofOptional
stringOptional
or
nullOptional
materializerany ofOptional
stringOptional
or
nullOptional
typeany ofOptional
stringOptional
or
nullOptional
data_typeany ofOptional
stringOptional
or
nullOptional
artifact_store_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
model_version_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
only_unusedany ofOptionalDefault: false
booleanOptional
or
nullOptional
has_custom_nameany ofOptional
booleanOptional
or
nullOptional
modelany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
pipeline_runany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/api/v1/artifact_versions
GET /api/v1/artifact_versions HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2025-11-14T20:31:19.099Z",
        "updated": "2025-11-14T20:31:19.099Z",
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "project_id": "123e4567-e89b-12d3-a456-426614174000",
        "artifact": {
          "body": {
            "created": "2025-11-14T20:31:19.099Z",
            "updated": "2025-11-14T20:31:19.099Z",
            "user_id": "123e4567-e89b-12d3-a456-426614174000",
            "project_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "has_custom_name": false
          },
          "resources": {
            "user": {
              "body": {
                "created": "2025-11-14T20:31:19.099Z",
                "updated": "2025-11-14T20:31:19.099Z",
                "active": false,
                "activation_token": "text",
                "full_name": "",
                "email_opted_in": true,
                "is_service_account": true,
                "is_admin": true,
                "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                "avatar_url": "text"
              },
              "metadata": {
                "email": "",
                "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                "user_metadata": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                }
              },
              "resources": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "permission_denied": false,
              "name": "text"
            },
            "tags": [
              {
                "body": {
                  "created": "2025-11-14T20:31:19.099Z",
                  "updated": "2025-11-14T20:31:19.099Z",
                  "user_id": "123e4567-e89b-12d3-a456-426614174000",
                  "color": "grey",
                  "exclusive": true
                },
                "metadata": {
                  "tagged_count": 1
                },
                "resources": {
                  "user": {
                    "body": {
                      "created": "2025-11-14T20:31:19.099Z",
                      "updated": "2025-11-14T20:31:19.099Z",
                      "active": false,
                      "activation_token": "text",
                      "full_name": "",
                      "email_opted_in": true,
                      "is_service_account": true,
                      "is_admin": true,
                      "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                      "avatar_url": "text"
                    },
                    "metadata": {
                      "email": "",
                      "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                      "user_metadata": {
                        "ANY_ADDITIONAL_PROPERTY": "anything"
                      }
                    },
                    "resources": {
                      "ANY_ADDITIONAL_PROPERTY": "anything"
                    },
                    "id": "123e4567-e89b-12d3-a456-426614174000",
                    "permission_denied": false,
                    "name": "text"
                  },
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": false,
                "name": "text"
              }
            ],
            "latest_version_name": "text",
            "latest_version_id": "123e4567-e89b-12d3-a456-426614174000",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": false,
          "name": "text"
        },
        "version": "text",
        "uri": "text",
        "type": "DataAnalysisArtifact",
        "materializer": {
          "module": "text",
          "attribute": "text",
          "type": "user",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "data_type": {
          "module": "text",
          "attribute": "text",
          "type": "user",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "save_type": "step_output",
        "artifact_store_id": "123e4567-e89b-12d3-a456-426614174000",
        "content_hash": "text"
      },
      "metadata": {
        "visualizations": "[Circular Reference]",
        "run_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "resources": {
        "user": {
          "body": {
            "created": "2025-11-14T20:31:19.099Z",
            "updated": "2025-11-14T20:31:19.099Z",
            "active": false,
            "activation_token": "text",
            "full_name": "",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
            "avatar_url": "text"
          },
          "metadata": {
            "email": "",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": false,
          "name": "text"
        },
        "tags": [
          {
            "body": {
              "created": "2025-11-14T20:31:19.099Z",
              "updated": "2025-11-14T20:31:19.099Z",
              "user_id": "123e4567-e89b-12d3-a456-426614174000",
              "color": "grey",
              "exclusive": true
            },
            "metadata": {
              "tagged_count": 1
            },
            "resources": {
              "user": {
                "body": {
                  "created": "2025-11-14T20:31:19.099Z",
                  "updated": "2025-11-14T20:31:19.099Z",
                  "active": false,
                  "activation_token": "text",
                  "full_name": "",
                  "email_opted_in": true,
                  "is_service_account": true,
                  "is_admin": true,
                  "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                  "avatar_url": "text"
                },
                "metadata": {
                  "email": "",
                  "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                  "user_metadata": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  }
                },
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": false,
                "name": "text"
              },
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": false,
            "name": "text"
          }
        ],
        "producer_step_run_id": "123e4567-e89b-12d3-a456-426614174000",
        "producer_pipeline_run_id": "123e4567-e89b-12d3-a456-426614174000",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false
    }
  ]
}

Create Artifact Version

post

Create a new artifact version.

Args: artifact_version: The artifact version to create.

Returns: The created artifact version.

Authorizations
OAuth2passwordRequired
Token URL:
Body

Request model for artifact versions.

userany ofOptional
string · uuidOptional
or
nullOptional
projectstring · uuidRequired
artifact_idany ofOptional
string · uuidOptional
or
nullOptional
artifact_nameany ofOptional
stringOptional
or
nullOptional
versionany ofOptional
integerOptional
or
stringOptional
or
nullOptional
has_custom_namebooleanOptionalDefault: false
typestring · enumRequired

All possible types an artifact can have.

Possible values:
artifact_store_idany ofOptional
string · uuidOptional
or
nullOptional
uristring · max: 65535Required
content_hashany ofOptional
string · max: 255Optional
or
nullOptional
tagsany ofOptional

Should be a list of plain strings, e.g., ['tag1', 'tag2']

string[]Optional
or
nullOptional
visualizationsany ofOptional
or
nullOptional
save_typestring · enumRequired

All possible method types of how artifact versions can be saved.

Possible values:
metadataany ofOptional
or
nullOptional
Responses
200

Successful Response

application/json
post
/api/v1/artifact_versions
POST /api/v1/artifact_versions HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 670

{
  "user": "123e4567-e89b-12d3-a456-426614174000",
  "project": "123e4567-e89b-12d3-a456-426614174000",
  "artifact_id": "123e4567-e89b-12d3-a456-426614174000",
  "artifact_name": "text",
  "version": 1,
  "has_custom_name": false,
  "type": "DataAnalysisArtifact",
  "artifact_store_id": "123e4567-e89b-12d3-a456-426614174000",
  "uri": "text",
  "materializer": {
    "module": "text",
    "attribute": "text",
    "type": "user",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "data_type": {
    "module": "text",
    "attribute": "text",
    "type": "user",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "content_hash": "text",
  "tags": [
    "text"
  ],
  "visualizations": [
    {
      "type": "csv",
      "uri": "text"
    }
  ],
  "save_type": "step_output",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}
{
  "body": {
    "created": "2025-11-14T20:31:19.099Z",
    "updated": "2025-11-14T20:31:19.099Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "artifact": {
      "body": {
        "created": "2025-11-14T20:31:19.099Z",
        "updated": "2025-11-14T20:31:19.099Z",
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "has_custom_name": false
      },
      "resources": {
        "user": {
          "body": {
            "created": "2025-11-14T20:31:19.099Z",
            "updated": "2025-11-14T20:31:19.099Z",
            "active": false,
            "activation_token": "text",
            "full_name": "",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
            "avatar_url": "text"
          },
          "metadata": {
            "email": "",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": false,
          "name": "text"
        },
        "tags": [
          {
            "body": {
              "created": "2025-11-14T20:31:19.099Z",
              "updated": "2025-11-14T20:31:19.099Z",
              "user_id": "123e4567-e89b-12d3-a456-426614174000",
              "color": "grey",
              "exclusive": true
            },
            "metadata": {
              "tagged_count": 1
            },
            "resources": {
              "user": {
                "body": {
                  "created": "2025-11-14T20:31:19.099Z",
                  "updated": "2025-11-14T20:31:19.099Z",
                  "active": false,
                  "activation_token": "text",
                  "full_name": "",
                  "email_opted_in": true,
                  "is_service_account": true,
                  "is_admin": true,
                  "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                  "avatar_url": "text"
                },
                "metadata": {
                  "email": "",
                  "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                  "user_metadata": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  }
                },
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": false,
                "name": "text"
              },
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": false,
            "name": "text"
          }
        ],
        "latest_version_name": "text",
        "latest_version_id": "123e4567-e89b-12d3-a456-426614174000",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    },
    "version": "text",
    "uri": "text",
    "type": "DataAnalysisArtifact",
    "materializer": {
      "module": "text",
      "attribute": "text",
      "type": "user",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "data_type": {
      "module": "text",
      "attribute": "text",
      "type": "user",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "save_type": "step_output",
    "artifact_store_id": "123e4567-e89b-12d3-a456-426614174000",
    "content_hash": "text"
  },
  "metadata": {
    "visualizations": [
      {
        "body": {
          "created": "2025-11-14T20:31:19.099Z",
          "updated": "2025-11-14T20:31:19.099Z",
          "type": "csv",
          "uri": "text"
        },
        "metadata": {
          "artifact_version_id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "resources": "[Circular Reference]",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "permission_denied": false
      }
    ],
    "run_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "resources": {
    "user": {
      "body": {
        "created": "2025-11-14T20:31:19.099Z",
        "updated": "2025-11-14T20:31:19.099Z",
        "active": false,
        "activation_token": "text",
        "full_name": "",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
        "avatar_url": "text"
      },
      "metadata": {
        "email": "",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    },
    "tags": [
      {
        "body": {
          "created": "2025-11-14T20:31:19.099Z",
          "updated": "2025-11-14T20:31:19.099Z",
          "user_id": "123e4567-e89b-12d3-a456-426614174000",
          "color": "grey",
          "exclusive": true
        },
        "metadata": {
          "tagged_count": 1
        },
        "resources": {
          "user": {
            "body": {
              "created": "2025-11-14T20:31:19.099Z",
              "updated": "2025-11-14T20:31:19.099Z",
              "active": false,
              "activation_token": "text",
              "full_name": "",
              "email_opted_in": true,
              "is_service_account": true,
              "is_admin": true,
              "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
              "avatar_url": "text"
            },
            "metadata": {
              "email": "",
              "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
              "user_metadata": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              }
            },
            "resources": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": false,
            "name": "text"
          },
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "permission_denied": false,
        "name": "text"
      }
    ],
    "producer_step_run_id": "123e4567-e89b-12d3-a456-426614174000",
    "producer_pipeline_run_id": "123e4567-e89b-12d3-a456-426614174000",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": false
}

Prune Artifact Versions

delete

Prunes unused artifact versions and their artifacts.

Args: project_name_or_id: The project name or ID to prune artifact versions for. only_versions: Only delete artifact versions, keeping artifacts

Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
project_name_or_idany ofRequired
stringOptional
or
string · uuidOptional
only_versionsbooleanOptionalDefault: true
Responses
200

Successful Response

application/json
Responseany
delete
/api/v1/artifact_versions
DELETE /api/v1/artifact_versions?project_name_or_id=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Get Artifact Version

get

Get an artifact version by ID.

Args: artifact_version_id: The ID of the artifact version to get. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: The artifact version with the given ID.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
artifact_version_idstring · uuidRequired
Query parameters
hydratebooleanOptionalDefault: true
Responses
200

Successful Response

application/json
get
/api/v1/artifact_versions/{artifact_version_id}
GET /api/v1/artifact_versions/{artifact_version_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "body": {
    "created": "2025-11-14T20:31:19.099Z",
    "updated": "2025-11-14T20:31:19.099Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "artifact": {
      "body": {
        "created": "2025-11-14T20:31:19.099Z",
        "updated": "2025-11-14T20:31:19.099Z",
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "has_custom_name": false
      },
      "resources": {
        "user": {
          "body": {
            "created": "2025-11-14T20:31:19.099Z",
            "updated": "2025-11-14T20:31:19.099Z",
            "active": false,
            "activation_token": "text",
            "full_name": "",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
            "avatar_url": "text"
          },
          "metadata": {
            "email": "",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": false,
          "name": "text"
        },
        "tags": [
          {
            "body": {
              "created": "2025-11-14T20:31:19.099Z",
              "updated": "2025-11-14T20:31:19.099Z",
              "user_id": "123e4567-e89b-12d3-a456-426614174000",
              "color": "grey",
              "exclusive": true
            },
            "metadata": {
              "tagged_count": 1
            },
            "resources": {
              "user": {
                "body": {
                  "created": "2025-11-14T20:31:19.099Z",
                  "updated": "2025-11-14T20:31:19.099Z",
                  "active": false,
                  "activation_token": "text",
                  "full_name": "",
                  "email_opted_in": true,
                  "is_service_account": true,
                  "is_admin": true,
                  "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                  "avatar_url": "text"
                },
                "metadata": {
                  "email": "",
                  "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                  "user_metadata": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  }
                },
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": false,
                "name": "text"
              },
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": false,
            "name": "text"
          }
        ],
        "latest_version_name": "text",
        "latest_version_id": "123e4567-e89b-12d3-a456-426614174000",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    },
    "version": "text",
    "uri": "text",
    "type": "DataAnalysisArtifact",
    "materializer": {
      "module": "text",
      "attribute": "text",
      "type": "user",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "data_type": {
      "module": "text",
      "attribute": "text",
      "type": "user",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "save_type": "step_output",
    "artifact_store_id": "123e4567-e89b-12d3-a456-426614174000",
    "content_hash": "text"
  },
  "metadata": {
    "visualizations": [
      {
        "body": {
          "created": "2025-11-14T20:31:19.099Z",
          "updated": "2025-11-14T20:31:19.099Z",
          "type": "csv",
          "uri": "text"
        },
        "metadata": {
          "artifact_version_id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "resources": "[Circular Reference]",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "permission_denied": false
      }
    ],
    "run_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "resources": {
    "user": {
      "body": {
        "created": "2025-11-14T20:31:19.099Z",
        "updated": "2025-11-14T20:31:19.099Z",
        "active": false,
        "activation_token": "text",
        "full_name": "",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
        "avatar_url": "text"
      },
      "metadata": {
        "email": "",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    },
    "tags": [
      {
        "body": {
          "created": "2025-11-14T20:31:19.099Z",
          "updated": "2025-11-14T20:31:19.099Z",
          "user_id": "123e4567-e89b-12d3-a456-426614174000",
          "color": "grey",
          "exclusive": true
        },
        "metadata": {
          "tagged_count": 1
        },
        "resources": {
          "user": {
            "body": {
              "created": "2025-11-14T20:31:19.099Z",
              "updated": "2025-11-14T20:31:19.099Z",
              "active": false,
              "activation_token": "text",
              "full_name": "",
              "email_opted_in": true,
              "is_service_account": true,
              "is_admin": true,
              "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
              "avatar_url": "text"
            },
            "metadata": {
              "email": "",
              "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
              "user_metadata": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              }
            },
            "resources": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": false,
            "name": "text"
          },
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "permission_denied": false,
        "name": "text"
      }
    ],
    "producer_step_run_id": "123e4567-e89b-12d3-a456-426614174000",
    "producer_pipeline_run_id": "123e4567-e89b-12d3-a456-426614174000",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": false
}

Update Artifact Version

put

Update an artifact by ID.

Args: artifact_version_id: The ID of the artifact version to update. artifact_version_update: The update to apply to the artifact version.

Returns: The updated artifact.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
artifact_version_idstring · uuidRequired
Body

Artifact version update model.

nameany ofOptional
stringOptional
or
nullOptional
add_tagsany ofOptional
string[]Optional
or
nullOptional
remove_tagsany ofOptional
string[]Optional
or
nullOptional
Responses
200

Successful Response

application/json
put
/api/v1/artifact_versions/{artifact_version_id}
PUT /api/v1/artifact_versions/{artifact_version_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "name": "text",
  "add_tags": [
    "text"
  ],
  "remove_tags": [
    "text"
  ]
}
{
  "body": {
    "created": "2025-11-14T20:31:19.099Z",
    "updated": "2025-11-14T20:31:19.099Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "artifact": {
      "body": {
        "created": "2025-11-14T20:31:19.099Z",
        "updated": "2025-11-14T20:31:19.099Z",
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "has_custom_name": false
      },
      "resources": {
        "user": {
          "body": {
            "created": "2025-11-14T20:31:19.099Z",
            "updated": "2025-11-14T20:31:19.099Z",
            "active": false,
            "activation_token": "text",
            "full_name": "",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
            "avatar_url": "text"
          },
          "metadata": {
            "email": "",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": false,
          "name": "text"
        },
        "tags": [
          {
            "body": {
              "created": "2025-11-14T20:31:19.099Z",
              "updated": "2025-11-14T20:31:19.099Z",
              "user_id": "123e4567-e89b-12d3-a456-426614174000",
              "color": "grey",
              "exclusive": true
            },
            "metadata": {
              "tagged_count": 1
            },
            "resources": {
              "user": {
                "body": {
                  "created": "2025-11-14T20:31:19.099Z",
                  "updated": "2025-11-14T20:31:19.099Z",
                  "active": false,
                  "activation_token": "text",
                  "full_name": "",
                  "email_opted_in": true,
                  "is_service_account": true,
                  "is_admin": true,
                  "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                  "avatar_url": "text"
                },
                "metadata": {
                  "email": "",
                  "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                  "user_metadata": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  }
                },
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": false,
                "name": "text"
              },
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": false,
            "name": "text"
          }
        ],
        "latest_version_name": "text",
        "latest_version_id": "123e4567-e89b-12d3-a456-426614174000",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    },
    "version": "text",
    "uri": "text",
    "type": "DataAnalysisArtifact",
    "materializer": {
      "module": "text",
      "attribute": "text",
      "type": "user",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "data_type": {
      "module": "text",
      "attribute": "text",
      "type": "user",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "save_type": "step_output",
    "artifact_store_id": "123e4567-e89b-12d3-a456-426614174000",
    "content_hash": "text"
  },
  "metadata": {
    "visualizations": [
      {
        "body": {
          "created": "2025-11-14T20:31:19.099Z",
          "updated": "2025-11-14T20:31:19.099Z",
          "type": "csv",
          "uri": "text"
        },
        "metadata": {
          "artifact_version_id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "resources": "[Circular Reference]",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "permission_denied": false
      }
    ],
    "run_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "resources": {
    "user": {
      "body": {
        "created": "2025-11-14T20:31:19.099Z",
        "updated": "2025-11-14T20:31:19.099Z",
        "active": false,
        "activation_token": "text",
        "full_name": "",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
        "avatar_url": "text"
      },
      "metadata": {
        "email": "",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    },
    "tags": [
      {
        "body": {
          "created": "2025-11-14T20:31:19.099Z",
          "updated": "2025-11-14T20:31:19.099Z",
          "user_id": "123e4567-e89b-12d3-a456-426614174000",
          "color": "grey",
          "exclusive": true
        },
        "metadata": {
          "tagged_count": 1
        },
        "resources": {
          "user": {
            "body": {
              "created": "2025-11-14T20:31:19.099Z",
              "updated": "2025-11-14T20:31:19.099Z",
              "active": false,
              "activation_token": "text",
              "full_name": "",
              "email_opted_in": true,
              "is_service_account": true,
              "is_admin": true,
              "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
              "avatar_url": "text"
            },
            "metadata": {
              "email": "",
              "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
              "user_metadata": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              }
            },
            "resources": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": false,
            "name": "text"
          },
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "permission_denied": false,
        "name": "text"
      }
    ],
    "producer_step_run_id": "123e4567-e89b-12d3-a456-426614174000",
    "producer_pipeline_run_id": "123e4567-e89b-12d3-a456-426614174000",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": false
}

Delete Artifact Version

delete

Delete an artifact version by ID.

Args: artifact_version_id: The ID of the artifact version to delete.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
artifact_version_idstring · uuidRequired
Responses
200

Successful Response

application/json
Responseany
delete
/api/v1/artifact_versions/{artifact_version_id}
DELETE /api/v1/artifact_versions/{artifact_version_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content
PreviousArtifactsNextBatch

Last updated

Was this helpful?