Artifacts

Last updated 1 month ago

Was this helpful?

Get Artifact

get

Get an artifact by ID.

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

Returns: The artifact with the given ID.

Authorizations

Path parameters

artifact_idstring · uuidRequired

Query parameters

hydratebooleanOptionalDefault: true

Responses

get

GET /api/v1/artifacts/{artifact_id} HTTP/1.1
Host: 
Accept: */*

{
  "body": {
    "created": "2025-04-26T17:46:46.324Z",
    "updated": "2025-04-26T17:46:46.324Z",
    "user": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "email": "text",
        "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": true,
      "name": "text"
    },
    "tags": [
      {
        "body": {
          "created": "2025-04-26T17:46:46.324Z",
          "updated": "2025-04-26T17:46:46.324Z",
          "user": {
            "body": {
              "created": "2025-04-26T17:46:46.324Z",
              "updated": "2025-04-26T17:46:46.324Z",
              "active": true,
              "activation_token": "text",
              "full_name": "text",
              "email_opted_in": true,
              "is_service_account": true,
              "is_admin": true,
              "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
            },
            "metadata": {
              "email": "text",
              "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": true,
            "name": "text"
          },
          "color": "grey",
          "exclusive": true,
          "tagged_count": 1
        },
        "metadata": {},
        "resources": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "permission_denied": true,
        "name": "text"
      }
    ],
    "latest_version_name": "text",
    "latest_version_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "metadata": {
    "project": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "display_name": "text"
      },
      "metadata": {
        "description": "text"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "has_custom_name": true
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}

Delete Artifact

delete

Delete an artifact by ID.

Args: artifact_id: The ID of the artifact to delete.

Authorizations

Path parameters

artifact_idstring · uuidRequired

Responses

Responseany

delete

DELETE /api/v1/artifacts/{artifact_id} HTTP/1.1
Host: 
Accept: */*

No content

List Artifacts

get

Get artifacts according to query filters.

Args: artifact_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.

Returns: The artifacts according to query filters.

Authorizations

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

stringOptional

nullOptional

createdany ofOptional

string · date-timeOptional

stringOptional

nullOptional

updatedany ofOptional

string · date-timeOptional

stringOptional

nullOptional

tagany ofOptional

stringOptional

nullOptional

tagsany ofOptional

string[]Optional

nullOptional

scope_userany ofOptional

string · uuidOptional

nullOptional

userany ofOptional

string · uuidOptional

stringOptional

nullOptional

projectany ofOptional

string · uuidOptional

stringOptional

nullOptional

nameany ofOptional

stringOptional

nullOptional

has_custom_nameany ofOptional

booleanOptional

nullOptional

Responses

get

GET /api/v1/artifacts HTTP/1.1
Host: 
Accept: */*

{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "user": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "active": true,
            "activation_token": "text",
            "full_name": "text",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "email": "text",
            "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": true,
          "name": "text"
        },
        "tags": [
          {
            "body": {
              "created": "2025-04-26T17:46:46.324Z",
              "updated": "2025-04-26T17:46:46.324Z",
              "user": {
                "body": {
                  "created": "2025-04-26T17:46:46.324Z",
                  "updated": "2025-04-26T17:46:46.324Z",
                  "active": true,
                  "activation_token": "text",
                  "full_name": "text",
                  "email_opted_in": true,
                  "is_service_account": true,
                  "is_admin": true,
                  "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
                },
                "metadata": {
                  "email": "text",
                  "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": true,
                "name": "text"
              },
              "color": "grey",
              "exclusive": true,
              "tagged_count": 1
            },
            "metadata": {},
            "resources": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": true,
            "name": "text"
          }
        ],
        "latest_version_name": "text",
        "latest_version_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "project": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "display_name": "text"
          },
          "metadata": {
            "description": "text"
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "has_custom_name": true
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    }
  ]
}

Create Artifact

post

Create a new artifact.

Args: artifact: The artifact to create.

Returns: The created artifact.

Authorizations

Body

Artifact request model.

userany ofOptional

string · uuidOptional

nullOptional

projectstring · uuidRequired

namestring · max: 255Required

has_custom_namebooleanOptionalDefault: false

tagsany ofOptional

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

string[]Optional

nullOptional

Responses

post

POST /api/v1/artifacts HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "user": "123e4567-e89b-12d3-a456-426614174000",
  "project": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "has_custom_name": true,
  "tags": [
    "text"
  ]
}

{
  "body": {
    "created": "2025-04-26T17:46:46.324Z",
    "updated": "2025-04-26T17:46:46.324Z",
    "user": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "email": "text",
        "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": true,
      "name": "text"
    },
    "tags": [
      {
        "body": {
          "created": "2025-04-26T17:46:46.324Z",
          "updated": "2025-04-26T17:46:46.324Z",
          "user": {
            "body": {
              "created": "2025-04-26T17:46:46.324Z",
              "updated": "2025-04-26T17:46:46.324Z",
              "active": true,
              "activation_token": "text",
              "full_name": "text",
              "email_opted_in": true,
              "is_service_account": true,
              "is_admin": true,
              "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
            },
            "metadata": {
              "email": "text",
              "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": true,
            "name": "text"
          },
          "color": "grey",
          "exclusive": true,
          "tagged_count": 1
        },
        "metadata": {},
        "resources": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "permission_denied": true,
        "name": "text"
      }
    ],
    "latest_version_name": "text",
    "latest_version_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "metadata": {
    "project": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "display_name": "text"
      },
      "metadata": {
        "description": "text"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "has_custom_name": true
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}

Update Artifact

put

Update an artifact by ID.

Args: artifact_id: The ID of the artifact to update. artifact_update: The update to apply to the artifact.

Returns: The updated artifact.

Authorizations

Path parameters

artifact_idstring · uuidRequired

Body

Artifact update model.

nameany ofOptional

stringOptional

nullOptional

add_tagsany ofOptional

string[]Optional

nullOptional

remove_tagsany ofOptional

string[]Optional

nullOptional

has_custom_nameany ofOptional

booleanOptional

nullOptional

Responses

put

PUT /api/v1/artifacts/{artifact_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "name": "text",
  "add_tags": [
    "text"
  ],
  "remove_tags": [
    "text"
  ],
  "has_custom_name": true
}

{
  "body": {
    "created": "2025-04-26T17:46:46.324Z",
    "updated": "2025-04-26T17:46:46.324Z",
    "user": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "email": "text",
        "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": true,
      "name": "text"
    },
    "tags": [
      {
        "body": {
          "created": "2025-04-26T17:46:46.324Z",
          "updated": "2025-04-26T17:46:46.324Z",
          "user": {
            "body": {
              "created": "2025-04-26T17:46:46.324Z",
              "updated": "2025-04-26T17:46:46.324Z",
              "active": true,
              "activation_token": "text",
              "full_name": "text",
              "email_opted_in": true,
              "is_service_account": true,
              "is_admin": true,
              "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
            },
            "metadata": {
              "email": "text",
              "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": true,
            "name": "text"
          },
          "color": "grey",
          "exclusive": true,
          "tagged_count": 1
        },
        "metadata": {},
        "resources": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "permission_denied": true,
        "name": "text"
      }
    ],
    "latest_version_name": "text",
    "latest_version_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "metadata": {
    "project": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "display_name": "text"
      },
      "metadata": {
        "description": "text"
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "has_custom_name": true
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}