Deployments.ai Docs
Command reference

deployments artifact

Run and message artifacts

CommandSummary
deployments artifact listList artifacts
deployments artifact uploadCreate a customer artifact upload
deployments artifact showShow artifact metadata
deployments artifact downloadCreate a scoped artifact access URL
deployments artifact completeVerify and complete a customer artifact upload
deployments artifact deleteDelete an artifact and erase its stored bytes
deployments artifact retentionSet or clear artifact retention

deployments artifact list

List artifacts.

deployments artifact list
  • Calls GET /v1/artifacts (SDK listArtifacts).
  • Needs an environment: --env or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
--run-idstringFilter by run ID
--thread-idstringFilter by thread ID
--typestringFilter by artifact type
--content-typestringFilter by media type or family, such as image/*
--created-afterstringOnly artifacts created at or after this timestamp
--created-beforestringOnly artifacts created at or before this timestamp

Also accepts the global flags.

deployments artifact upload

Create a customer artifact upload.

deployments artifact upload --name <name> --type <type> --file-name <file-name> --content-type <content-type> --byte-size <number> --sha256 <sha256>
  • Calls POST /v1/artifacts (SDK createArtifactUpload).
  • Needs an environment: --env or the saved context.
  • Output contains secrets. They are redacted unless you pass --reveal.
FlagTypeRequiredDefaultDescription
--namestringyesArtifact name
--typestringyesArtifact type
--file-namestringyesArtifact file name
--content-typestringyesArtifact media type
--byte-sizestring (number)yesArtifact byte size
--sha256stringyesLowercase SHA-256 digest
--visibilitystringprivate or organization
--run-idstringAssociated run ID
--thread-idstringAssociated thread ID
--retention-expires-atstringCanonical retention expiration
--metadatastring (json)Artifact metadata

Also accepts the global flags.

deployments artifact show

Show artifact metadata.

deployments artifact show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments artifact download

Create a scoped artifact access URL.

deployments artifact download <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--expires-in-secondsstring (number)Access URL lifetime in seconds
--dispositionstringattachment to make a browser save the file, or inline

Also accepts the global flags.

deployments artifact complete

Verify and complete a customer artifact upload.

deployments artifact complete <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments artifact delete

Delete an artifact and erase its stored bytes.

deployments artifact delete <id>
  • Calls DELETE /v1/artifacts/{artifactId} (SDK deleteArtifact).
  • Needs an environment: --env or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments artifact retention

Set or clear artifact retention.

deployments artifact retention <id> --expected-version <number> --retention-expires-at <json>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--expected-versionstring (number)yesExpected artifact version
--retention-expires-atstring (json)yesCanonical retention expiration string or null

Also accepts the global flags.

On this page