Skip to documentation
Documentation
Documentation
OverviewInstallationQuickstartYour first dayYou were sent a linkWorking with a customerConfigurationTroubleshootingFAQGlossary

Usage

Terminal interfaceCLIStatuslineDashboardAnalytics

Collaborate

DocumentsLessonsSession sharingPicking up tomorrow and handing work overFrom your phoneSession linksSession messagingAsksAsks privacy fact sheetFeedbackEmail from crewkitBlueprintsAgent identitiesMCP server

Configure

AgentsSkillsSkill and agent security scanningRulesCommandsInheritancePlaybooksExperimentsHooksCapture modesSensitive sessionsData residencyTeamSettings mapIntegrations

Workspaces

WorkspacesSet up a workspaceFix a ticket end to endShip a feature with approvalHand off work and set agent settings

API Reference

API OverviewAuthenticationSessions APIResources APIOrganizations APIProjects APIPlaybooks APIExperiments API
Need a hand?Find an answer in troubleshooting.
Loading docs…
CREWKIT / DOCUMENTATION

Data residency

What it means for an organization to keep its data resident, what moves to its own data plane, what stops, what keeps working, and who turns it on.

An organization that keeps its data resident runs its own data plane: session content goes there, and crewkit keeps counts and events without their text.


What moves to your data plane

  • Transcript and hook-event content. The CLI sends it to the organization's data plane, applying the capture mode there too. Under minimal it also withholds the first prompt.
  • What crewkit still receives: hook events reduced to the minimal shape, so session start and end, subagent start and stop, stop, notification, permission-request, compaction and model-switch events still arrive. crewkit stores no transcript text. For a plan, crewkit keeps its name and step count, not its text.
  • When the data plane cannot be reached, or the session is sensitive, the content goes nowhere. It never falls back to crewkit.

What stops

  • Session analysis, correction detection and convention override resolution: none of the analysis crewkit runs on hosted conversations runs on resident ones.
  • Project search: it is not available.
  • Feedback screenshots: never offered. Confirming a report creates no document.

What keeps working

  • Asks: no Ask code calls a model or embedding provider, so a resident organization can use them.
  • Each conversation still appears on the dashboard, recorded from the events crewkit receives.

Who turns it on

An organization admin, on a plan that includes data residency (see pricing). The dashboard shows whether the organization is resident, under Settings → Organization → Privacy & Telemetry; the notice and the change itself are made through the API:

  1. Point the organization at its data plane: Settings → Organization, the data plane card.
  2. Send the residency notice: POST /api/v1/:organization_id/telemetry/residency_notice. crewkit emails every current member, and its answer counts the members still to be notified.
  3. Turn residency on: PATCH /api/v1/:organization_id/telemetry/settings with data_residency: "resident". crewkit refuses until every current member has been sent the notice for this change.

Residency is set for the whole organization. There is no per-project setting.


Next steps

  • Capture modes
  • Sensitive sessions

Sensitive sessions

What starting a session with --sensitive changes, what it does not change, and how resuming a conversation affects it.

Team

Invite teammates, give each one a role, and see what each role can do.

On this page

What moves to your data planeWhat stopsWhat keeps workingWho turns it onNext steps