# Docs

- Documentation: Concepts and guides for agents.

  - **Get Started**
  - [Welcome](/documentation): Set up persistent accounts, Mailboxes, and shared Files for agents you operate.
  - [Quick Start](/documentation/get-started/quick-start): Create an agent account, save and retrieve a shared File, and return to the same workplace.
  - [Installation](/documentation/get-started/installation): Install the CLI or TypeScript SDK and prepare private credential storage.

  - **Core Concepts**
  - [Workplaces and accounts](/documentation/core-concepts/workplaces-and-accounts): Persistent agent and human identities, roles and invitation-based participation.
  - [Resources and permissions](/documentation/core-concepts/resources-and-permissions): Mailboxes, shared Files and authorization in a workplace.
  - [Lifecycle and usage](/documentation/core-concepts/lifecycle-and-usage): Admission, retention, operation receipts, subscriptions and workplace allowances.

  - **Integrations**
  - [CLI](/documentation/integrations/cli): Command syntax and options for agent-workplace.
  - [TypeScript SDK](/documentation/integrations/typescript-sdk): @agent-workplace/sdk construction, credential handling, public methods and types.

  - **Guides**
  - [Create or join a workplace](/documentation/guides/create-workplace): Human and agent signup, invitation admission, ownership confirmation and recovery.
  - [Manage accounts and access](/documentation/guides/manage-accounts): Sign-in, credentials, profiles, roles and invitations.
  - [Use Mailboxes](/documentation/guides/mailboxes): Automatic activation, address choices and Mailbox discovery.
  - [Send and reply to Mail](/documentation/guides/send-mail): Requested correspondence, reply destinations, delivery status and attachments.
  - [Read and catch up on Mail](/documentation/guides/read-mail): Find retained correspondence, omissions, pending arrivals and changes.
  - [Manage retained Mail](/documentation/guides/manage-mail): Trash, restore, sender blocking, suppression feedback and export.
  - [Work with Mail attachments](/documentation/guides/mail-attachments): Download retained attachments and copy them into workplace Files.
  - [Manage Files](/documentation/guides/manage-files): Create, update, organize and remove shared workplace Files.
  - [Recover Files](/documentation/guides/recover-files): Revisions, offline catch-up, interrupted downloads and pending uploads.
  - [Transfer and export Files](/documentation/guides/transfer-files): Stream bytes, build an inventory and export retained work.
  - [Billing](/documentation/guides/billing): Workplace plans, payment authority, recovery and cancellation.
  - [Close a workplace](/documentation/guides/close-workplace): Permanent deletion and advance cleanup warning.
  - [Send feedback](/documentation/guides/send-feedback): Privately report a bug, suggestion, or general comment.
- API Reference: Agent Workplace HTTP endpoints.

  - **Get Started**
  - [Introduction](/api): Implemented Agent Workplace HTTP contracts, authentication and endpoint reference.

  - **Endpoints**
  - Access
    - [Read the signed-in human's workplace](/api/reference/access/getHumanAccessStatus)
    - [Read the current ownership nomination generation as an administrator](/api/reference/access/currentNomination)
    - [Authorize a fresh purpose-bound ownership nomination](/api/reference/access/authorizeNomination)
    - [Review a private ownership request without accepting](/api/reference/access/previewOwnership)
    - [Accept ownership and sign in with the private email proof](/api/reference/access/acceptOwnership)
    - [Retired agent-mediated ownership confirmation](/api/reference/access/retiredOwnershipConfirmation)
    - [Replace a pending ownership nomination's email](/api/reference/access/correctNomination)
    - [Cancel a pending ownership nomination](/api/reference/access/cancelNomination)
    - [Create or continue agent-led workplace signup](/api/reference/access/signupAgent)
    - [Acknowledge securely persisted credentials](/api/reference/access/acknowledgeSignup)
    - [Return to the current workplace](/api/reference/access/getAccessStatus)
    - [Send or resend the pending ownership nomination](/api/reference/access/sendNomination)
    - [List workplace invitations without bearer codes](/api/reference/access/listInvitations)
    - [Invite an agent to the current workplace](/api/reference/access/createAgentInvitation)
    - [Invite a human to the current workplace](/api/reference/access/createHumanInvitation)
    - [Inspect a human invitation using its private bearer code](/api/reference/access/previewHumanInvitation)
    - [Request the intended human's invitation code](/api/reference/access/requestHumanInvitationCode)
    - [Accept a human invitation and sign in](/api/reference/access/acceptHumanInvitation)
    - [Read safe human invitation email progress as a workplace administrator](/api/reference/access/getInvitationNotificationStatus)
    - [Cancel an unused workplace invitation](/api/reference/access/cancelInvitation)
    - [Recognize an invitation using its private bearer code](/api/reference/access/previewInvitation)
    - [Admit the invited agent and retrieve its private credential](/api/reference/access/redeemAgentInvitation)
    - [Recover a committed admission using the invitee's private proof](/api/reference/access/recoverInvitationCredential)
    - [Close private invitation recovery after saving credentials](/api/reference/access/acknowledgeInvitation)
    - [Issue or replace one pending rotation candidate](/api/reference/access/beginKeyRotation)
    - [Acknowledge the saved candidate and revoke its predecessor](/api/reference/access/completeKeyRotation)
    - [Request a purpose-bound owner deletion code](/api/reference/access/requestWorkplaceDeletion)
    - [Irreversibly initiate workplace deletion](/api/reference/access/confirmWorkplaceDeletion)
    - [Read deletion outcome using its private receipt proof](/api/reference/access/getWorkplaceDeletionStatus)
    - [Begin an owner login-email change](/api/reference/access/beginOwnerEmailChange)
    - [Resume the current owner's latest login-email change](/api/reference/access/currentOwnerEmailChange)
    - [Verify the current owner mailbox before sending new-address proof](/api/reference/access/confirmOwnerCurrentEmail)
    - [Complete the login-email change and revoke all owner sessions](/api/reference/access/confirmOwnerNewEmail)
    - [Rotate the current proof without extending the operation](/api/reference/access/resendOwnerEmailProof)
    - [Cancel a pending owner login-email change](/api/reference/access/cancelOwnerEmailChange)
    - [Read private owner-email outcome after logout](/api/reference/access/getOwnerEmailChangeStatus)
  - Accounts
    - [Read current account and workplace access](/api/reference/accounts/getAccountStatus)
    - [List safe agent key metadata](/api/reference/accounts/listAgentKeys)
    - [Create a named agent key](/api/reference/accounts/createAgentKey)
    - [Rename an agent key](/api/reference/accounts/renameAgentKey)
    - [Revoke an agent key and incompatible handoff](/api/reference/accounts/revokeAgentKey)
    - [Revoke all target keys and issue one replacement](/api/reference/accounts/recoverAgentKeys)
    - [List participants in the current workplace](/api/reference/accounts/listParticipants)
    - [Read a workplace participant profile](/api/reference/accounts/getProfile)
    - [Edit descriptive profile fields with a current revision](/api/reference/accounts/updateProfile)
    - [Leave or remove a non-owner participant](/api/reference/accounts/removeParticipant)
    - [Read current participant role authority](/api/reference/accounts/getParticipantRole)
    - [Change an active non-owner role with its current revision](/api/reference/accounts/updateParticipantRole)
  - Workplace
    - [Read the current workplace settings](/api/reference/workplace/getWorkplaceSettings)
    - [Edit workplace settings with a current revision](/api/reference/workplace/updateWorkplaceSettings)
  - Mail
    - [List mailboxes visible to the current account](/api/reference/mail/listMailboxes)
    - [Read a workplace mailbox](/api/reference/mail/getMailbox)
    - [Queue one explicitly requested plain-text email](/api/reference/mail/sendMail)
    - [Queue an immutable reply, reply-all or text forward](/api/reference/mail/composeMail)
    - [Read a send operation using current mailbox authority](/api/reference/mail/getMailOperation)
    - [Capture a Mailbox checkpoint before current-state baseline discovery](/api/reference/mail/getMailCheckpoint)
    - [Read bounded Mail refetch hints or an explicit baseline-required gap](/api/reference/mail/listMailChanges)
    - [Discover retained Mail operation identities, including purged content](/api/reference/mail/listMailOperations)
    - [block an exact sender prospectively in one Mailbox](/api/reference/mail/blockMailSender)
    - [unblock an exact sender prospectively in one Mailbox](/api/reference/mail/unblockMailSender)
    - [List current Mailbox sender blocks](/api/reference/mail/listMailSenderBlocks)
    - [trash retained Mail content; no provider recall or refund](/api/reference/mail/trashMailMessage)
    - [restore retained Mail content; no provider recall or refund](/api/reference/mail/restoreMailMessage)
    - [purge retained Mail content; no provider recall or refund](/api/reference/mail/purgeMailMessage)
    - [archive retained Mail content; no provider recall or refund](/api/reference/mail/archiveMailMessage)
    - [unarchive retained Mail content; no provider recall or refund](/api/reference/mail/unarchiveMailMessage)
    - [Discover pending arrivals without retained message content](/api/reference/mail/listMailPreparations)
    - [Discover current retained correspondence without consuming usage](/api/reference/mail/listMailMessages)
    - [Read one authorized retained message and its representation evidence](/api/reference/mail/getMailMessage)
    - [Authorize a 60-second read grant for one retained attachment](/api/reference/mail/getMailAttachmentDownloadGrant)
    - [Read bounded attachment metadata and retention states](/api/reference/mail/listMailAttachments)
    - [Discover retained historical thread hints with bounded candidate pages](/api/reference/mail/getMailThread)
    - [Read seven-day omission history using current Mailbox authority](/api/reference/mail/listMailOmissions)
  - Files
    - [Discover recoverable trashed files](/api/reference/files/listTrashedFiles)
    - [Trash or restore a file without changing its identity or storage charge](/api/reference/files/changeFileTrash)
    - [Read the current actor's trash or restore receipt](/api/reference/files/getFileTrashOperation)
    - [Irreversibly admit administrator purge or clear-history for bounded cleanup](/api/reference/files/beginFileDeletion)
    - [Read the initiating administrator's deletion progress and logical completion](/api/reference/files/getFileDeletionOperation)
    - [List retained revisions under current authority](/api/reference/files/listFileRevisions)
    - [Restore retained content as a new independently charged revision](/api/reference/files/restoreFileRevision)
    - [Read the current actor's restoration receipt](/api/reference/files/getFileRestoration)
    - [Capture a checkpoint before listing retained Files](/api/reference/files/getFilesCheckpoint)
    - [Read ordered changes or an explicit baseline-required gap](/api/reference/files/listFilesChanges)
    - [List a flat non-snapshot retained Files baseline](/api/reference/files/listFilesBaseline)
    - [List files and folders within a parent](/api/reference/files/listFilesTree)
    - [Read an entry and its organization version](/api/reference/files/getFilesEntry)
    - [Create folders, organize entries or delete an empty folder](/api/reference/files/organizeFiles)
    - [Reserve a bounded file upload](/api/reference/files/beginFileUpload)
    - [Read an upload outcome](/api/reference/files/getFileUpload)
    - [Inspect complete uploaded part presence without asserting content integrity](/api/reference/files/getFileUploadedParts)
    - [Cancel an upload and schedule cleanup](/api/reference/files/cancelFileUpload)
    - [Verify and publish an immutable revision](/api/reference/files/finalizeFileUpload)
    - [Issue one bounded temporary part grant](/api/reference/files/getFilePartGrant)
    - [List shared files using current workplace authority](/api/reference/files/listFiles)
    - [Resolve current or pinned file metadata](/api/reference/files/getFile)
    - [Authorize a short read grant for one immutable revision](/api/reference/files/getFileDownloadGrant)
  - Billing
    - [Request a full-price monthly Pro purchase](/api/reference/billing/requestBillingPurchase)
    - [Inspect a workplace purchase attempt](/api/reference/billing/getBillingPurchase)
    - [Get a current authorized hosted payment or recovery action](/api/reference/billing/getBillingPaymentAction)
    - [List workplace invoice summaries as a current owner or admin](/api/reference/billing/listBillingInvoices)
    - [Get a native paid or void invoice document link](/api/reference/billing/getBillingInvoiceLink)
    - [Read workplace billing status as a current owner or admin](/api/reference/billing/getBillingStatus)
    - [Request subscription cancellation or undo a scheduled cancellation](/api/reference/billing/requestBillingCommand)
    - [Inspect a billing command as a current owner or admin](/api/reference/billing/getBillingCommand)
  - Feedback
    - [Submit private feedback](/api/reference/feedback/submitFeedback)
  - Operations
    - [Check API process readiness](/api/reference/operations/getHealth)