SPB Git

Repository Public

artifacts.md 3.3 KB


# title: Artifacts url: https://platform.claude.com/docs/en/api/compliance/apps/artifacts

# Artifacts

# Get artifact metadata

GET /v1/compliance/apps/artifacts/{artifact_version_id}

Returns metadata for an artifact version, without the content body.

Use the sibling /content endpoint to fetch the artifact text. The md5 and size_bytes fields here are computed over the UTF-8 encoding of that text, so a DLP consumer can dedupe or match hashes without downloading every artifact.

# Path parameters

  • artifact_version_id: string

    The artifact version ID (tagged ID, e.g., claude_artifact_version_abc123)

# Headers

  • "x-api-key": optional string

# Returns

  • id: string

    Artifact ID e.g. 'claude_artifact_abc123'

  • artifact_type: string or null

    MIME-like artifact type e.g. 'application/vnd.ant.code'

  • claude_chat_id: string

    The chat this artifact belongs to

  • created_at: string

    Artifact version creation timestamp

    format: date-time

  • md5: string

    Lowercase hex MD5 of the artifact content (UTF-8 encoded). Matches the content field returned by the sibling /content endpoint.

  • size_bytes: number

    Size in bytes of the artifact content (UTF-8 encoded)

  • title: string or null

    Artifact title

  • version_id: string

    Artifact version ID e.g. 'claude_artifact_version_abc123'

# Example

bash
curl https://api.anthropic.com/v1/compliance/apps/artifacts/$ARTIFACT_VERSION_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

# Response (200)

json
{
  "id": "id",
  "artifact_type": "artifact_type",
  "claude_chat_id": "claude_chat_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "md5": "md5",
  "size_bytes": 0,
  "title": "title",
  "version_id": "version_id"
}

# Download artifact content

GET /v1/compliance/apps/artifacts/{artifact_version_id}/content

Download the content of an artifact version for compliance purposes.

Returns the full text content of the artifact version.

# Path parameters

  • artifact_version_id: string

    The artifact version ID (tagged ID, e.g., claude_artifact_version_abc123)

# Headers

  • "x-api-key": optional string

# Example

bash
curl https://api.anthropic.com/v1/compliance/apps/artifacts/$ARTIFACT_VERSION_ID/content \
    -H 'anthropic-version: 2023-06-01' \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

# Domain types

# Artifact Retrieve Response

  • ArtifactRetrieveResponse object

    Artifact version metadata for GET /v1/compliance/apps/artifacts/{artifact_version_id}.

    Returns metadata only. Use the sibling /content endpoint to fetch the artifact body.

    • id: string

      Artifact ID e.g. 'claude_artifact_abc123'

    • artifact_type: string or null

      MIME-like artifact type e.g. 'application/vnd.ant.code'

    • claude_chat_id: string

      The chat this artifact belongs to

    • created_at: string

      Artifact version creation timestamp

      format: date-time

    • md5: string

      Lowercase hex MD5 of the artifact content (UTF-8 encoded). Matches the content field returned by the sibling /content endpoint.

    • size_bytes: number

      Size in bytes of the artifact content (UTF-8 encoded)

    • title: string or null

      Artifact title

    • version_id: string

      Artifact version ID e.g. 'claude_artifact_version_abc123'

Files main
Menu

Theme