# Capture Sweet

> Video as a programmable platform. Record, share, and monetize screen captures with customizable video pages, modular surfaces, and built-in analytics.

## Documentation Index

- [Quickstart](https://capturesweet.com/docs/quickstart.md): Install SDK, create first capture, upload video - 5 minutes
- [API Reference](https://capturesweet.com/docs/api-reference.md): Every SDK method with parameters, return types, examples, and error codes
- [Core Concepts](https://capturesweet.com/docs/core-concepts.md): Capture lifecycle, modules, privacy levels, personalization, page config
- [Agent Integration](https://capturesweet.com/docs/agent-integration.md): AI agent setup guide - patterns, error handling, framework examples
- [OpenAPI Spec](https://capturesweet.com/docs/openapi): Machine-readable OpenAPI 3.0 specification for all REST endpoints

## Feature Guides (how-to, for users)

- [Loom alternative comparison](https://capturesweet.com/resources/loom-alternative): Pricing, privacy defaults, share pages, AI capabilities side-by-side
- [AI action items from recordings](https://capturesweet.com/resources/ai-action-items-from-screen-recordings): Run Flows to produce action items/SOPs/summaries deep-linked to video moments
- [Custom-branded share pages](https://capturesweet.com/resources/custom-branded-video-share-pages): Page builder, layouts, the full module list, white-labeling, personalization
- [Video privacy settings](https://capturesweet.com/resources/video-privacy-settings): Five privacy levels + folder defaults
- [Interactive video checkpoints](https://capturesweet.com/resources/interactive-video-checkpoints): Email gates, Stripe payments, quizzes, forms at chosen timestamps
- [Navigation log recording](https://capturesweet.com/resources/screen-recording-with-navigation-log): Page + click capture alongside video, click-to-jump playback
- [Password-protect a video](https://capturesweet.com/resources/how-to-password-protect-a-video): The password privacy level + folder defaults; when to use it vs email gate / link-only
- [Paywall a video with Stripe](https://capturesweet.com/resources/paywall-a-video-with-stripe): Sell access via a payment checkpoint or on-page Stripe checkout
- [Screen recording for bug reports](https://capturesweet.com/resources/screen-recording-for-bug-reports): Navigation log + screenshots → a repro engineers can follow
- [Searchable video transcripts](https://capturesweet.com/resources/searchable-video-transcripts): Auto transcript, searchable + click-to-jump on the share page
- [Personalized video pages](https://capturesweet.com/resources/personalized-video-pages): One recording, many tailored pages via ?name= URL params

## SDK

- Package: `@capturesweet/sdk` (npm)
- Source: `packages/sdk/`
- Zero dependencies, native fetch, TypeScript-first
- One import: `import CaptureSweet from '@capturesweet/sdk'`
- One env var: `CAPTURE_SWEET_API_KEY`

## API Base URL

- Production: `https://capturesweet.com`
- Auth: Bearer token via `Authorization` header

## Key Endpoints

- POST   /api/captures                      - Create capture + get upload URL
- GET    /api/captures                      - List captures (paginated)
- GET    /api/captures/:id                  - Get capture with screenshots
- PATCH  /api/captures/:id                  - Update capture
- DELETE /api/captures/:id                  - Soft-delete capture
- POST   /api/captures/:id/upload-url       - Regenerate upload URL
- POST   /api/captures/:id/screenshots      - Upload screenshot (multipart)
- GET    /api/folders                       - List folders
- POST   /api/folders                       - Create folder
- PATCH  /api/folders/:id                   - Update folder
- DELETE /api/folders/:id                   - Delete folder
- POST   /api/folders/:id/captures          - Add captures to folder
- DELETE /api/folders/:id/captures          - Remove capture from folder
- POST   /api/analytics                     - Record analytics event (public)
- GET    /api/analytics/:captureId          - Get analytics (owner only)
- GET    /api/comments/:captureId           - List comments (public)
- POST   /api/comments/:captureId           - Create comment

## Error Codes

unauthorized | forbidden | not_found | bad_request | rate_limited | server_error | network_error

## Data Model (key entities)

- Capture: video recording with metadata, privacy, page_config, modules
- Folder: organizational container with color and sort_order
- Screenshot: image attached to a capture with timestamp and xpath
- Comment: timestamped comment with optional threading (parent_id)
- AnalyticsEvent: viewer interaction (view_start, play, cta_click, etc.)
- PageConfig: branding, modules[], personalization, sharing settings
- Module types: transcript, comments, cta, stripe, embed, document, contact_form, download, navigation_log, screenshots