中文 ← MyDocs

Documents

Get project document content

get /v1/compliance/apps/projects/documents/{document_id}

Get detailed information for a specific project document.

Returns: Project document information including content and metadata

Path Parameters

  • document_id: string

    The document ID (tagged ID, e.g., claude_proj_doc_abc123)

Header Parameters

  • "x-api-key": optional string

Returns

  • id: string

    Project document identifier (tagged ID)

  • content: string

    Document text content

  • created_at: string

    Document creation timestamp

  • filename: string

    Document filename

  • user: object { id, email_address }

    User information for project creator.

    • id: string

      User identifier (tagged ID)

    • email_address: string

      User's email address

Example

curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "id": "id",
  "content": "content",
  "created_at": "2019-12-27T18:11:19.117Z",
  "filename": "filename",
  "user": {
    "id": "id",
    "email_address": "email_address"
  }
}

Get project document metadata

get /v1/compliance/apps/projects/documents/{document_id}/metadata

Returns metadata for a project document, without the content body.

Use the sibling GET /v1/compliance/apps/projects/documents/{document_id} endpoint to fetch the document 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 document.

Path Parameters

  • document_id: string

    The document ID (tagged ID, e.g., claude_proj_doc_abc123)

Header Parameters

  • "x-api-key": optional string

Returns

  • id: string

    Project document identifier (tagged ID)

  • claude_project_id: string

    The project this document belongs to

  • created_at: string

    Document creation timestamp

  • filename: string

    Document filename

  • md5: string

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

  • mime_type: "text/plain"

    MIME type of the document content, always plain text

    • "text/plain"
  • size_bytes: number

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

  • user: object { id, email_address }

    User information for project creator.

    • id: string

      User identifier (tagged ID)

    • email_address: string

      User's email address

Example

curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID/metadata \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "id": "id",
  "claude_project_id": "claude_project_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "filename": "filename",
  "md5": "md5",
  "mime_type": "text/plain",
  "size_bytes": 0,
  "user": {
    "id": "id",
    "email_address": "email_address"
  }
}

Delete project document

delete /v1/compliance/apps/projects/documents/{document_id}

Delete a project document for compliance purposes.

Hard-deletes the project document permanently.

Returns: ComplianceProjectDocumentDeleteResponse confirming the deletion

Path Parameters

  • document_id: string

    The document ID (tagged ID, e.g., claude_proj_doc_abc123)

Header Parameters

  • "x-api-key": optional string

Returns

  • id: string

    The ID of the project document that was deleted

  • type: "claude_project_document_deleted"

    Constant string confirming deletion.

    • "claude_project_document_deleted"

Example

curl https://api.anthropic.com/v1/compliance/apps/projects/documents/$DOCUMENT_ID \
    -X DELETE \
    -H "Authorization: Bearer $ANTHROPIC_COMPLIANCE_API_KEY"

Response

{
  "id": "id",
  "type": "claude_project_document_deleted"
}

Domain Types

Document Retrieve Response

  • DocumentRetrieveResponse object { id, content, created_at, 2 more }

    Project document information for compliance responses.

    • id: string

      Project document identifier (tagged ID)

    • content: string

      Document text content

    • created_at: string

      Document creation timestamp

    • filename: string

      Document filename

    • user: object { id, email_address }

      User information for project creator.

      • id: string

        User identifier (tagged ID)

      • email_address: string

        User's email address

Document Metadata Response

  • DocumentMetadataResponse object { id, claude_project_id, created_at, 5 more }

    Project document metadata for GET /v1/compliance/apps/projects/documents/{document_id}/metadata.

    Returns metadata only. Use the sibling endpoint (without /metadata) to fetch the document text content.

    • id: string

      Project document identifier (tagged ID)

    • claude_project_id: string

      The project this document belongs to

    • created_at: string

      Document creation timestamp

    • filename: string

      Document filename

    • md5: string

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

    • mime_type: "text/plain"

      MIME type of the document content, always plain text

      • "text/plain"
    • size_bytes: number

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

    • user: object { id, email_address }

      User information for project creator.

      • id: string

        User identifier (tagged ID)

      • email_address: string

        User's email address

Document Delete Response

  • DocumentDeleteResponse object { id, type }

    Response for deleting a project document.

    • id: string

      The ID of the project document that was deleted

    • type: "claude_project_document_deleted"

      Constant string confirming deletion.

      • "claude_project_document_deleted"