SPB Git

Repository Public

attachments.md 5.9 KB


# title: Attachments url: https://platform.claude.com/docs/en/api/compliance/apps/projects/attachments

# Attachments

# List project attachments

GET /v1/compliance/apps/projects/{project_id}/attachments

List files and documents attached to a project.

List files and project documents attached to the project referenced by project_id. This includes the IDs of attached files, and attached project documents.

The raw binary content of attached files can be downloaded using the GET /v1/compliance/apps/chats/files/{claude_file_id}/content endpoint.

The text content of attached project documents can be fetched using the GET /v1/compliance/apps/projects/documents/{claude_proj_doc_id} endpoint.

# Path parameters

  • project_id: string

    The project ID (tagged ID, e.g., claude_proj_abc123)

# Query parameters

  • limit: optional number

    Maximum results (default: 20, max: 100)

    default: 20, maximum: 100, minimum: 1

  • page: optional string

    Opaque pagination token from a previous response's next_page field. Pass this to retrieve the next page of results. Clients should treat this value as an opaque string and not attempt to parse or interpret its contents, as the format may change without notice.

# Headers

  • "x-api-key": optional string

# Returns

  • data: array of ComplianceProjectFileReference or ComplianceProjectDocReference

    List of attachments sorted chronologically by created_at, tie break by id

    • ComplianceProjectFileReference object

      File attachment reference for compliance responses.

      • type: "project_file"

        Discriminator marking this as a binary file

        default: project_file

      • id: string

        File identifier (e.g., 'claude_file_abcd')

      • created_at: string

        Creation timestamp (RFC 3339 format)

        format: date-time

      • filename: string

        Display name of the file (e.g., 'document.pdf')

      • md5: string or null

        Lowercase hex MD5 of the file's preferred downloadable variant, when recorded. Null otherwise. Use the per-file /metadata endpoint for the authoritative value.

      • mime_type: string

        MIME type of the file's preferred downloadable variant when one is recorded, else 'application/octet-stream'. Use the per-file /metadata endpoint for the authoritative value.

      • size_bytes: number or null

        Size in bytes of the file's preferred downloadable variant, when recorded. Null otherwise. Use the per-file /metadata endpoint for the authoritative value.

    • ComplianceProjectDocReference object

      Project document attachment reference for compliance responses.

      • type: "project_doc"

        Discriminator marking this as a plain text document

        default: project_doc

      • id: string

        Project document identifier (e.g., 'claude_proj_doc_abcd')

      • created_at: string

        Creation timestamp (RFC 3339 format)

        format: date-time

      • filename: string

        Display name of the document (e.g., 'document.txt')

      • mime_type: "text/plain"

        MIME type of the project document, always set to plain text

        default: text/plain

      • updated_at: string or null

        Last-modified timestamp of the document. Reserved for future use — currently always null.

        format: date-time

  • has_more: boolean

    Whether more records exist beyond the current result set

  • next_page: string or null

    To get the next page, use the 'next_page' from the current response as the 'page' in your next request

# Example

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

# Response (200)

json
{
  "data": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "filename": "filename",
      "md5": "md5",
      "mime_type": "mime_type",
      "size_bytes": 0,
      "type": "project_file"
    }
  ],
  "has_more": true,
  "next_page": "next_page"
}

# Domain types

# Attachment List Response

  • AttachmentListResponse = ComplianceProjectFileReference or ComplianceProjectDocReference

    • ComplianceProjectFileReference object

      File attachment reference for compliance responses.

      • type: "project_file"

        Discriminator marking this as a binary file

        default: project_file

      • id: string

        File identifier (e.g., 'claude_file_abcd')

      • created_at: string

        Creation timestamp (RFC 3339 format)

        format: date-time

      • filename: string

        Display name of the file (e.g., 'document.pdf')

      • md5: string or null

        Lowercase hex MD5 of the file's preferred downloadable variant, when recorded. Null otherwise. Use the per-file /metadata endpoint for the authoritative value.

      • mime_type: string

        MIME type of the file's preferred downloadable variant when one is recorded, else 'application/octet-stream'. Use the per-file /metadata endpoint for the authoritative value.

      • size_bytes: number or null

        Size in bytes of the file's preferred downloadable variant, when recorded. Null otherwise. Use the per-file /metadata endpoint for the authoritative value.

    • ComplianceProjectDocReference object

      Project document attachment reference for compliance responses.

      • type: "project_doc"

        Discriminator marking this as a plain text document

        default: project_doc

      • id: string

        Project document identifier (e.g., 'claude_proj_doc_abcd')

      • created_at: string

        Creation timestamp (RFC 3339 format)

        format: date-time

      • filename: string

        Display name of the document (e.g., 'document.txt')

      • mime_type: "text/plain"

        MIME type of the project document, always set to plain text

        default: text/plain

      • updated_at: string or null

        Last-modified timestamp of the document. Reserved for future use — currently always null.

        format: date-time

Files main
Menu

Theme