### Empty response examples Source: https://docs.heypocketai.com/docs/api/search/search-recordings Placeholder examples for various HTTP status codes. ```text null ``` ```text null ``` ```text null ``` ```text null ``` ```text null ``` ```text null ``` -------------------------------- ### Accept Invite Response Example Source: https://docs.heypocketai.com/docs/api/organization/invites Successful response after accepting an invitation. ```json { "org_id": "org_abc", "role": "viewer", "status": "active" } ``` -------------------------------- ### Example Analytics Request Source: https://docs.heypocketai.com/docs/api/organization/analytics A cURL request example demonstrating how to query analytics for a specific organization within a date range. ```bash curl -X GET "https://public.heypocketai.com/api/v1/organization/org_abc/analytics?start_date=2026-03-01&end_date=2026-03-31" \ -H "Authorization: Bearer pk_xxx" ``` -------------------------------- ### Send Invite Response Example Source: https://docs.heypocketai.com/docs/api/organization/invites Successful response containing the invite details. ```json { "id": "inv_abc123", "email": "carol@example.com", "role": "viewer", "status": "pending", "created_at": "2026-04-10T08:00:00.000Z", "expires_at": "2026-04-17T08:00:00.000Z" } ``` -------------------------------- ### Get API Key Response Source: https://docs.heypocketai.com/docs/api/organization/api-keys Example JSON response for a single API key retrieval. ```json { "id": "key_abc123", "name": "CI Pipeline", "scopes": ["recordings:read", "templates:read"], "created_at": "2026-01-15T10:00:00.000Z", "expires_at": "2026-07-15T10:00:00.000Z", "last_used_at": "2026-04-09T14:32:00.000Z" } ``` -------------------------------- ### Send Invite Request Example Source: https://docs.heypocketai.com/docs/api/organization/invites JSON payload for sending an invitation to a new member. ```json { "email": "carol@example.com", "role": "viewer" } ``` -------------------------------- ### Accept Invite Request Example Source: https://docs.heypocketai.com/docs/api/organization/invites JSON payload required to accept an invitation using a token. ```json { "token": "inv_token_xxxxxxxxxxxxxxxx" } ``` -------------------------------- ### Authenticate API Requests Source: https://docs.heypocketai.com/docs/api Example of how to authenticate a request using a Bearer token in the Authorization header. ```bash curl -X GET "https://public.heypocketai.com/api/v1/public/recordings" \ -H "Authorization: Bearer pk_xxx" ``` -------------------------------- ### Get Single Template Source: https://docs.heypocketai.com/docs/api/organization/templates Fetch details for a specific template by its ID. ```http GET /api/v1/organization/:orgId/templates/:templateId ``` ```json { "id": "tpl_abc123", "name": "Sales Call Debrief", "description": "Structured summary for sales conversations", "sections": [ { "title": "Key Takeaways", "prompt": "List the main outcomes" }, { "title": "Action Items", "prompt": "Extract follow-up tasks" } ], "created_at": "2026-03-01T09:00:00.000Z", "updated_at": "2026-03-15T14:00:00.000Z" } ``` -------------------------------- ### List API Keys Response Source: https://docs.heypocketai.com/docs/api/organization/api-keys Example JSON response containing a list of organization API keys. ```json { "keys": [ { "id": "key_abc123", "name": "CI Pipeline", "scopes": ["recordings:read", "templates:read"], "created_at": "2026-01-15T10:00:00.000Z", "expires_at": "2026-07-15T10:00:00.000Z", "last_used_at": "2026-04-09T14:32:00.000Z" } ] } ``` -------------------------------- ### Get Member Settings Endpoints Source: https://docs.heypocketai.com/docs/api/organization/users The available paths for retrieving member settings. ```http GET /api/v1/organization/:orgId/users/:userId/settings GET /api/v1/public/users/:user_id/settings ``` -------------------------------- ### Revoke Invite Response Example Source: https://docs.heypocketai.com/docs/api/organization/invites Confirmation response for a revoked invitation. ```json { "success": true } ``` -------------------------------- ### Create Upload URL Request Source: https://docs.heypocketai.com/docs/api/recordings/create-upload-url Example request for generating an upload URL using cURL. ```bash curl -X POST "https://public.heypocketai.com/api/v1/public/recordings/upload-url" \ -H "Authorization: " \ -H "Content-Type: application/json" \ -d '{}' ``` -------------------------------- ### Create API Key Response Source: https://docs.heypocketai.com/docs/api/organization/api-keys Example JSON response after creating an API key, including the full key value. ```json { "id": "key_abc123", "name": "CI Pipeline", "key": "pk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "scopes": ["recordings:read", "templates:read"], "created_at": "2026-04-10T08:00:00.000Z", "expires_at": "2026-07-15T10:00:00.000Z" } ``` -------------------------------- ### Patch user settings request Source: https://docs.heypocketai.com/docs/api/users/patch-an-organization-member-s-settings-bundle Example cURL request to update a user's settings bundle. ```bash curl -X PATCH "https://public.heypocketai.com/api/v1/public/users/string/settings" \ -H "Authorization: " ``` -------------------------------- ### GET /api/v1/organization/:orgId/api-keys Source: https://docs.heypocketai.com/docs/api/organization/api-keys Returns all API keys for the organization. Requires a minimum role of viewer. ```APIDOC ## GET /api/v1/organization/:orgId/api-keys ### Description Returns all API keys for the organization. ### Method GET ### Endpoint /api/v1/organization/:orgId/api-keys ### Response #### Success Response (200) - **keys** (array) - List of API key objects #### Response Example { "keys": [ { "id": "key_abc123", "name": "CI Pipeline", "scopes": ["recordings:read", "templates:read"], "created_at": "2026-01-15T10:00:00.000Z", "expires_at": "2026-07-15T10:00:00.000Z", "last_used_at": "2026-04-09T14:32:00.000Z" } ] } ``` -------------------------------- ### List Recordings Request Source: https://docs.heypocketai.com/docs/api/organization/recordings Example cURL request to list recordings with date range filtering and pagination limits. ```bash curl -X GET "https://public.heypocketai.com/api/v1/organization/org_abc/recordings?startDate=2026-03-01&endDate=2026-03-31&limit=10" \ -H "Authorization: Bearer pk_xxx" ``` -------------------------------- ### Create API Key Request Body Source: https://docs.heypocketai.com/docs/api/organization/api-keys Example JSON payload for creating a new API key. ```json { "name": "CI Pipeline", "scopes": ["recordings:read", "templates:read"], "expires_at": "2026-07-15T10:00:00.000Z" } ``` -------------------------------- ### Get Recording Endpoint Source: https://docs.heypocketai.com/docs/api/organization/recordings The endpoint path for retrieving details of a specific recording. ```http GET /api/v1/organization/:orgId/recordings/:recordingId ``` -------------------------------- ### GET /api/v1/organization/:orgId/recordings Source: https://docs.heypocketai.com/docs/api/organization/recordings Returns a paginated list of recordings belonging to the organization. ```APIDOC ## GET /api/v1/organization/:orgId/recordings ### Description Returns a paginated list of recordings belonging to the organization. Requires minimum role: viewer. ### Method GET ### Endpoint /api/v1/organization/:orgId/recordings ### Parameters #### Query Parameters - **date** (string) - Optional - Filter to a specific date (YYYY-MM-DD) - **startDate** (string) - Optional - Start of date range (YYYY-MM-DD) - **endDate** (string) - Optional - End of date range (YYYY-MM-DD) - **tagIds** (string) - Optional - Comma-separated tag IDs to filter by - **tagMode** (string) - Optional - any or all — match any or all provided tags - **recordedBy** (string) - Optional - Filter by user ID of the recorder - **recordedByEmail** (string) - Optional - Filter by email of the recorder - **page** (number) - Optional - Page number (1-indexed) - **limit** (number) - Optional - Results per page (max 100) - **cursor** (string) - Optional - Cursor for keyset pagination ### Response #### Success Response (200) - **recordings** (array) - List of recording objects - **pagination** (object) - Pagination metadata ``` -------------------------------- ### GET /api/v1/organization/:orgId/webhooks Source: https://docs.heypocketai.com/docs/api/webhooks List all webhook integrations configured for a specific organization. ```APIDOC ## GET /api/v1/organization/:orgId/webhooks ### Description List org webhook integrations. ### Method GET ### Endpoint /api/v1/organization/:orgId/webhooks ### Parameters #### Path Parameters - **orgId** (string) - Required - The unique identifier of the organization. ``` -------------------------------- ### Example segment-based response for get_pocket_conversation Source: https://docs.heypocketai.com/docs/mcp Shows the structure of the JSON response returned by the get_pocket_conversation tool, including transcript segments and audio URL details. ```json { "success": true, "data": [ { "recordingId": "rec_123", "recordingTitle": "Weekly Sync", "recordingDate": "2026-03-25T15:04:05Z", "recordingTags": ["meeting", "product"], "transcriptSegments": [ { "text": "Let's review the launch plan.", "start": 0.62, "end": 4.88, "speaker": "Alex" }, { "text": "We should finalize QA by Friday.", "start": 5.21, "end": 9.77, "speaker": "Unknown Speaker 2" } ], "summary": { "...": "AI-generated summary content (Notes tab)" }, "audioUrl": { "signedUrl": "https://...", "expiresIn": 3600, "expiresAt": "2026-03-25T16:04:05Z" } } ] } ``` -------------------------------- ### Signature Verification Source: https://docs.heypocketai.com/docs/api/webhooks Instructions and code example for verifying the authenticity of webhook deliveries using HMAC-SHA256. ```APIDOC ## Signature Verification ### Description Verify each webhook request by computing an HMAC-SHA256 hash of the timestamp and raw request body, then comparing it to the provided signature header. ### Headers - **X-HeyPocket-Signature**: HMAC-SHA256 of `{timestamp}.{rawBody}` using your secret. - **X-HeyPocket-Timestamp**: Unix timestamp (ms) of the delivery. ### Verification Logic Compute `HMAC-SHA256(secret, "${timestamp}.${rawBody}")` using the exact raw JSON request body bytes received. ### Implementation Example ```javascript const crypto = require('crypto'); function verifySignature(secret, timestamp, body, signature) { const expected = crypto .createHmac('sha256', secret) .update(`${timestamp}.${body}`) .digest('hex'); return crypto.timingSafeEqual( Buffer.from(expected), Buffer.from(signature) ); } ``` ``` -------------------------------- ### Webhook Payload Structure Source: https://docs.heypocketai.com/docs/api/webhooks Example JSON payload for a summary.completed event, including user, organization, recording, and summarization details. ```json { "event": "summary.completed", "timestamp": "2026-02-18T12:00:00.000Z", "user": { "id": "user_abc123", "email": "alice@example.com" }, "organization": { "id": "org_def456" }, "recording": { "id": "rec_abc123", "title": "Team Standup", "description": "Weekly sync", "duration": 1800, "language": "English", "createdAt": "2026-02-18T11:30:00.000Z" }, "summarizations": { "sum_456": { "id": "row_789", "summarizationId": "sum_456", "processingStatus": "completed", "v2": { "summary": { "title": "Team Standup", "emoji": "📋", "markdown": "## Key Decisions\n\n...", "bulletPoints": ["Ship v2 by Friday", "Review design docs"] }, "actionItems": { "version": "3", "actionItems": [ { "id": "subtask_1", "parentTaskId": "task_1", "title": "Ship v2 by Friday", "dueDate": "2026-02-20", "status": "TODO", "globalActionItemId": "gai_001", "isCompleted": false, "is_completed": false } ] }, "mindMap": { "nodes": [], "edges": [] }, "speakerMindMap": null, "clusterMindMap": null, "contextMindMap": null, "flowMindMap": null }, "settings": { "modelId": "gpt5", "themeId": "auto_detect", "language": "English" }, "autoInitiated": true, "createdAt": "2026-02-18T12:00:00.000Z", "updatedAt": "2026-02-18T12:00:05.000Z" } }, "transcript": [ { "speaker": "Alice", "text": "Let's go over this week's priorities.", "start": 0.0, "end": 3.5 } ] } ``` -------------------------------- ### Get audio download URL via cURL Source: https://docs.heypocketai.com/docs/api/recordings/get-audio-download-url Use this cURL command to request the audio download URL. Ensure the Authorization header is populated with your Bearer token. ```bash curl -X GET "https://public.heypocketai.com/api/v1/public/recordings/string/audio-url" \ -H "Authorization: " ``` -------------------------------- ### GET /public/recordings/{id}/audio-url Source: https://docs.heypocketai.com/docs/api/recordings/get-audio-download-url Generates a pre-signed S3 URL for downloading a specific audio recording. ```APIDOC ## GET /public/recordings/{id}/audio-url ### Description Generate a pre-signed S3 URL for audio download. ### Method GET ### Endpoint https://public.heypocketai.com/api/v1/public/recordings/{id}/audio-url ### Parameters #### Path Parameters - **id** (string) - Required - Recording ID #### Query Parameters - **expires_in** (integer) - Optional - URL expiration in seconds (Default: 3600, Range: 60-86400) ### Response #### Success Response (200) - **data** (null) - Response data - **error** (string) - Error message if applicable - **pagination** (object) - Pagination details - **success** (boolean) - Request success status #### Response Example { "data": null, "error": "string", "pagination": { "has_more": true, "limit": 0, "page": 0, "total": 0, "total_pages": 0 }, "success": true } ``` -------------------------------- ### List recordings cURL request Source: https://docs.heypocketai.com/docs/api/recordings/list-recordings Use this cURL command to perform a GET request to the recordings endpoint. Ensure the Authorization header is populated with a valid Bearer token. ```bash curl -X GET "https://public.heypocketai.com/api/v1/public/recordings" \ -H "Authorization: " ``` -------------------------------- ### Update Member Settings Request Body Source: https://docs.heypocketai.com/docs/api/organization/users Example JSON payload for updating member settings, notifications, profile, and preferences. ```json { "settings": { "selected_theme": "executive_summary", "selected_model": "gemini35Flash", "conversation_language": "English (US)", "auto_transcription": true }, "notifications": { "highlight_time": "22:00", "reminder_notifications_enabled": true }, "profile": { "profile": "Markdown profile that will be encrypted under the target user." }, "preferences": [ { "command": "Add follow-ups", "command_type": "manual", "preference_content": "Always include explicit follow-ups." }, { "id": "pref_005", "preference_content": "Updated wording" }, { "id": "pref_006", "delete": true } ] } ``` -------------------------------- ### Update Recording Request Body Source: https://docs.heypocketai.com/docs/api/organization/recordings Example JSON payload for updating a recording's title and tags. ```json { "title": "Team Standup — Week 12", "tags": ["tag_meeting", "tag_weekly"] } ``` -------------------------------- ### GET /public/recordings/{id} Source: https://docs.heypocketai.com/docs/api/recordings/get-recording-details Retrieves a single recording with full details including optional transcripts and summarizations. ```APIDOC ## GET /public/recordings/{id} ### Description Get a single recording with full details. ### Method GET ### Endpoint https://public.heypocketai.com/api/v1/public/recordings/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Recording ID #### Query Parameters - **include_transcript** (boolean) - Optional - Include transcript (Default: true) - **include_summarizations** (boolean) - Optional - Include summarizations (Default: true) - **summarization_id** (string) - Optional - Filter to a specific summarization ID ### Response #### Success Response (200) - **data** (object) - The recording details - **success** (boolean) - Indicates if the request was successful #### Response Example { "data": null, "error": "string", "pagination": { "has_more": true, "limit": 0, "page": 0, "total": 0, "total_pages": 0 }, "success": true } ``` -------------------------------- ### GET /public/users/{user_id}/settings Source: https://docs.heypocketai.com/docs/api/users/get-an-organization-member-s-settings-bundle Retrieves user_settings, notifications, and optionally the encrypted user profile and learned preferences for an active organization member. ```APIDOC ## GET /public/users/{user_id}/settings ### Description Returns user_settings, notifications, and (when requested via `include`) the encrypted user profile and learned preferences for an active org member. Requires an organization API key with the `users:read` scope. ### Method GET ### Endpoint https://public.heypocketai.com/api/v1/public/users/{user_id}/settings ### Parameters #### Path Parameters - **user_id** (string) - Required - Target user ID #### Query Parameters - **include** (string) - Optional - Comma-separated optional sections: profile, preferences, tags ### Response #### Success Response (200) - **data** (object) - The settings bundle data - **success** (boolean) - Indicates if the request was successful #### Response Example { "data": null, "error": "string", "pagination": { "has_more": true, "limit": 0, "page": 0, "total": 0, "total_pages": 0 }, "success": true } ``` -------------------------------- ### GET /api/v1/organization/:orgId/users/:userId/settings Source: https://docs.heypocketai.com/docs/api/organization/users Retrieves an admin-safe bundle of personal configuration for a single active member. Sensitive sections are optional and controlled via query parameters. ```APIDOC ## GET /api/v1/organization/:orgId/users/:userId/settings ### Description Returns an admin-safe bundle of personal configuration for a single active member. Sensitive sections (profile, preferences, tags) are only included when explicitly requested via the include query parameter. ### Method GET ### Endpoint /api/v1/organization/:orgId/users/:userId/settings ### Parameters #### Path Parameters - **orgId** (string) - Required - The organization identifier. - **userId** (string) - Required - The user identifier. #### Query Parameters - **include** (string) - Optional - Comma-separated list of optional sections: profile, preferences, tags. The notifications block is included by default; pass none to omit it. - **include_profile** (boolean) - Optional - Alternative per-section flag for profile. - **include_preferences** (boolean) - Optional - Alternative per-section flag for preferences. - **include_tags** (boolean) - Optional - Alternative per-section flag for tags. - **include_notifications** (boolean) - Optional - Alternative per-section flag for notifications. Defaults to true. - **preferences_page** (integer) - Optional - When preferences is included, 1-based page number. Defaults to 1. - **preferences_limit** (integer) - Optional - When preferences is included, page size (max 200). Defaults to 50. ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **data** (object) - The user configuration bundle containing user, settings, notifications, profile, preferences, and tags. ``` -------------------------------- ### GET /api/v1/organization/:orgId/api-keys/:keyId Source: https://docs.heypocketai.com/docs/api/organization/api-keys Returns details for a single API key. Requires a minimum role of viewer. ```APIDOC ## GET /api/v1/organization/:orgId/api-keys/:keyId ### Description Returns details for a single API key. ### Method GET ### Endpoint /api/v1/organization/:orgId/api-keys/:keyId ### Parameters #### Path Parameters - **keyId** (string) - Required - The API key identifier ### Response #### Success Response (200) - **id** (string) - The API key identifier - **name** (string) - Human-readable label - **scopes** (array) - List of granted permissions - **created_at** (string) - ISO 8601 creation date - **expires_at** (string) - ISO 8601 expiration date - **last_used_at** (string) - ISO 8601 last used date #### Response Example { "id": "key_abc123", "name": "CI Pipeline", "scopes": ["recordings:read", "templates:read"], "created_at": "2026-01-15T10:00:00.000Z", "expires_at": "2026-07-15T10:00:00.000Z", "last_used_at": "2026-04-09T14:32:00.000Z" } ``` -------------------------------- ### Get API Key Endpoint Source: https://docs.heypocketai.com/docs/api/organization/api-keys Retrieve details for a specific API key by its identifier. Requires a minimum role of viewer. ```http GET /api/v1/organization/:orgId/api-keys/:keyId ``` -------------------------------- ### Get Analytics Endpoint Source: https://docs.heypocketai.com/docs/api/organization/analytics The endpoint path for retrieving organization-level analytics. ```http GET /api/v1/organization/:orgId/analytics ``` -------------------------------- ### Configure MCP Client Source: https://docs.heypocketai.com/docs/api/organization/mcp Add this configuration to your MCP client's settings file, replacing the placeholder with your actual API key. ```json { "mcpServers": { "pocket": { "url": "https://public.heypocketai.com/mcp", "headers": { "Authorization": "Bearer pk_your_key_here" } } } } ``` -------------------------------- ### GET /api/v1/organization/:orgId/recordings/:recordingId Source: https://docs.heypocketai.com/docs/api/organization/recordings Returns full details for a single recording. ```APIDOC ## GET /api/v1/organization/:orgId/recordings/:recordingId ### Description Returns full details for a single recording. Requires minimum role: viewer. ### Method GET ### Endpoint /api/v1/organization/:orgId/recordings/:recordingId ### Parameters #### Path Parameters - **recordingId** (string) - Required - The recording identifier #### Query Parameters - **include** (string) - Optional - Comma-separated list of related resources to include (e.g. transcript,summary,action_items) ### Response #### Success Response (200) - **id** (string) - Recording ID - **title** (string) - Recording title - **transcript** (array) - Recording transcript data - **summary** (object) - Recording summary ``` -------------------------------- ### Retrieve recording details via cURL Source: https://docs.heypocketai.com/docs/api/recordings/get-recording-details Use this command to fetch recording details. Ensure the Authorization header is set with your API key. ```bash curl -X GET "https://public.heypocketai.com/api/v1/public/recordings/string" \ -H "Authorization: " ``` -------------------------------- ### Retrieve settings bundle via cURL Source: https://docs.heypocketai.com/docs/api/users/get-an-organization-member-s-settings-bundle Use this cURL command to fetch the settings bundle for a specific user ID. ```bash curl -X GET "https://public.heypocketai.com/api/v1/public/users/string/settings" \ -H "Authorization: " ``` -------------------------------- ### Create Organization Template Source: https://docs.heypocketai.com/docs/api/organization/templates Create a new template. Requires admin role. ```http POST /api/v1/organization/:orgId/templates ``` ```json { "name": "Sales Call Debrief", "description": "Structured summary for sales conversations", "sections": [ { "title": "Key Takeaways", "prompt": "List the main outcomes" }, { "title": "Action Items", "prompt": "Extract follow-up tasks" }, { "title": "Objections", "prompt": "Summarize any objections raised" } ] } ``` ```json { "id": "tpl_def456", "name": "Sales Call Debrief", "description": "Structured summary for sales conversations", "sections": [ { "title": "Key Takeaways", "prompt": "List the main outcomes" }, { "title": "Action Items", "prompt": "Extract follow-up tasks" }, { "title": "Objections", "prompt": "Summarize any objections raised" } ], "created_at": "2026-04-10T08:00:00.000Z", "updated_at": "2026-04-10T08:00:00.000Z" } ``` -------------------------------- ### Configure MCP for Claude Desktop Source: https://docs.heypocketai.com/docs/mcp Add this configuration to the Claude Desktop configuration file to enable the Pocket integration. ```json { "mcpServers": { "pocket": { "command": "npx", "args": [ "-y", "mcp-remote", "https://public.heypocketai.com/mcp", "--header", "Authorization:${AUTH_HEADER}" ], "env": { "AUTH_HEADER": "Bearer pk_your_api_key_here" } } } } ``` -------------------------------- ### GET /api/v1/organization/:orgId/webhooks/:id Source: https://docs.heypocketai.com/docs/api/webhooks Fetch details for a specific organization webhook integration. ```APIDOC ## GET /api/v1/organization/:orgId/webhooks/:id ### Description Fetch a specific org integration. ### Method GET ### Endpoint /api/v1/organization/:orgId/webhooks/:id ### Parameters #### Path Parameters - **orgId** (string) - Required - The unique identifier of the organization. - **id** (string) - Required - The unique identifier of the webhook integration. ``` -------------------------------- ### GET /public/tags Source: https://docs.heypocketai.com/docs/api/tags/list-tags Retrieves all tags with usage count. Requires Bearer token authentication. ```APIDOC ## GET /public/tags ### Description Get all tags with usage count. ### Method GET ### Endpoint https://public.heypocketai.com/api/v1/public/tags ### Authorization - **Authorization** (header) - Required - Use `Bearer pk_xxx` as the authorization header value. ### Response #### Success Response (200) - **data** (null) - The tag data. - **error** (string) - Error message if applicable. - **pagination** (object) - Pagination details including has_more, limit, page, total, and total_pages. - **success** (boolean) - Indicates if the request was successful. #### Response Example { "data": null, "error": "string", "pagination": { "has_more": true, "limit": 0, "page": 0, "total": 0, "total_pages": 0 }, "success": true } ``` -------------------------------- ### GET /api/v1/organization/:orgId/templates Source: https://docs.heypocketai.com/docs/api/organization/templates Retrieves all templates belonging to the organization. Requires a minimum role of member. ```APIDOC ## GET /api/v1/organization/:orgId/templates ### Description Returns all templates belonging to the organization. ### Method GET ### Endpoint /api/v1/organization/:orgId/templates ### Response #### Success Response (200) - **templates** (array) - List of organization templates #### Response Example { "templates": [ { "id": "tpl_abc123", "name": "Sales Call Debrief", "description": "Structured summary for sales conversations", "sections": [ { "title": "Key Takeaways", "prompt": "List the main outcomes" }, { "title": "Action Items", "prompt": "Extract follow-up tasks" } ], "created_at": "2026-03-01T09:00:00.000Z", "updated_at": "2026-03-15T14:00:00.000Z" } ] } ``` -------------------------------- ### POST /api/v1/organization/:orgId/api-keys Source: https://docs.heypocketai.com/docs/api/organization/api-keys Creates a new API key. Requires a minimum role of admin. ```APIDOC ## POST /api/v1/organization/:orgId/api-keys ### Description Creates a new API key. The full key value is returned only once in the response. ### Method POST ### Endpoint /api/v1/organization/:orgId/api-keys ### Parameters #### Request Body - **name** (string) - Required - A human-readable label for the key - **scopes** (string[]) - Optional - Permissions to grant - **expires_at** (string) - Optional - ISO 8601 expiration date ### Request Example { "name": "CI Pipeline", "scopes": ["recordings:read", "templates:read"], "expires_at": "2026-07-15T10:00:00.000Z" } ### Response #### Success Response (200) - **id** (string) - The API key identifier - **name** (string) - Human-readable label - **key** (string) - The full API key value - **scopes** (array) - Granted permissions - **created_at** (string) - ISO 8601 creation date - **expires_at** (string) - ISO 8601 expiration date #### Response Example { "id": "key_abc123", "name": "CI Pipeline", "key": "pk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "scopes": ["recordings:read", "templates:read"], "created_at": "2026-04-10T08:00:00.000Z", "expires_at": "2026-07-15T10:00:00.000Z" } ``` -------------------------------- ### GET /api/v1/organization/:orgId/analytics Source: https://docs.heypocketai.com/docs/api/organization/analytics Retrieves aggregated recording statistics for an organization, broken down by individual members. ```APIDOC ## GET /api/v1/organization/:orgId/analytics ### Description Returns aggregated recording statistics for your organization, broken down by member. Requires a minimum role of viewer. ### Method GET ### Endpoint /api/v1/organization/:orgId/analytics ### Parameters #### Path Parameters - **orgId** (string) - Required - The unique identifier of the organization. #### Query Parameters - **start_date** (string) - Optional - Start of the reporting period (YYYY-MM-DD). Defaults to 30 days ago. - **end_date** (string) - Optional - End of the reporting period (YYYY-MM-DD). Defaults to today. ### Request Example curl -X GET "https://public.heypocketai.com/api/v1/organization/org_abc/analytics?start_date=2026-03-01&end_date=2026-03-31" \ -H "Authorization: Bearer pk_xxx" ### Response #### Success Response (200) - **period.start_date** (string) - Inclusive start date of the period - **period.end_date** (string) - Inclusive end date of the period - **totals.recordings** (number) - Total recordings across all members - **totals.total_duration_seconds** (number) - Combined duration in seconds - **totals.summarizations** (number) - Total summarizations generated - **members[].user_id** (string) - Member's user ID - **members[].email** (string) - Member's email address - **members[].name** (string) - Member's display name - **members[].recordings** (number) - Recordings created by this member - **members[].total_duration_seconds** (number) - Combined duration for this member - **members[].summarizations** (number) - Summarizations generated for this member #### Response Example { "period": { "start_date": "2026-03-01", "end_date": "2026-03-31" }, "totals": { "recordings": 142, "total_duration_seconds": 256800, "summarizations": 138 }, "members": [ { "user_id": "usr_001", "email": "alice@example.com", "name": "Alice Chen", "recordings": 54, "total_duration_seconds": 97200, "summarizations": 52 }, { "user_id": "usr_002", "email": "bob@example.com", "name": "Bob Martinez", "recordings": 88, "total_duration_seconds": 159600, "summarizations": 86 } ] } ``` -------------------------------- ### Configure MCP for Cursor Source: https://docs.heypocketai.com/docs/mcp Add this configuration to the Cursor MCP settings to enable the Pocket integration. ```json { "pocket": { "command": "npx", "args": [ "-y", "mcp-remote", "https://public.heypocketai.com/mcp", "--header", "Authorization:${AUTH_HEADER}" ], "env": { "AUTH_HEADER": "Bearer pk_your_api_key_here" } } } ``` -------------------------------- ### GET /public/recordings Source: https://docs.heypocketai.com/docs/api/recordings/list-recordings Retrieves a paginated list of recordings. Supports filtering by date range and tags. ```APIDOC ## GET /public/recordings ### Description Get paginated list of recordings with optional filtering. Note: All dates are interpreted as UTC. ### Method GET ### Endpoint https://public.heypocketai.com/api/v1/public/recordings ### Parameters #### Query Parameters - **start_date** (string) - Optional - Filter from date (YYYY-MM-DD, interpreted as UTC midnight) - **end_date** (string) - Optional - Filter until date (YYYY-MM-DD, interpreted as UTC 23:59:59) - **tag_ids** (string) - Optional - Comma-separated tag IDs - **page** (integer) - Optional - Page number (Default: 1) - **limit** (integer) - Optional - Items per page (Default: 20, Max: 100) ### Response #### Success Response (200) - **data** (null) - The recording data - **error** (string) - Error message if applicable - **pagination** (object) - Pagination metadata including has_more, limit, page, total, and total_pages - **success** (boolean) - Indicates if the request was successful ### Response Example { "data": null, "error": "string", "pagination": { "has_more": true, "limit": 0, "page": 0, "total": 0, "total_pages": 0 }, "success": true } ``` -------------------------------- ### Create API Key Endpoint Source: https://docs.heypocketai.com/docs/api/organization/api-keys Create a new API key for the organization. Requires a minimum role of admin. ```http POST /api/v1/organization/:orgId/api-keys ``` -------------------------------- ### Search recordings via cURL Source: https://docs.heypocketai.com/docs/api/search/search-recordings Perform a search request using the cURL command-line tool. ```bash curl -X POST "https://public.heypocketai.com/api/v1/public/search" \ -H "Authorization: " \ -H "Content-Type: application/json" \ -d '{ "query": "string" }' ``` -------------------------------- ### GET /api/v1/organization/:orgId/templates/:templateId Source: https://docs.heypocketai.com/docs/api/organization/templates Retrieves a single template by its ID. Requires a minimum role of member. ```APIDOC ## GET /api/v1/organization/:orgId/templates/:templateId ### Description Returns a single template by ID. ### Method GET ### Endpoint /api/v1/organization/:orgId/templates/:templateId ### Parameters #### Path Parameters - **templateId** (string) - Required - The template identifier ### Response #### Success Response (200) - **id** (string) - Template ID - **name** (string) - Template name - **description** (string) - Template description - **sections** (array) - List of sections #### Response Example { "id": "tpl_abc123", "name": "Sales Call Debrief", "description": "Structured summary for sales conversations", "sections": [ { "title": "Key Takeaways", "prompt": "List the main outcomes" }, { "title": "Action Items", "prompt": "Extract follow-up tasks" } ], "created_at": "2026-03-01T09:00:00.000Z", "updated_at": "2026-03-15T14:00:00.000Z" } ``` -------------------------------- ### POST /public/search Source: https://docs.heypocketai.com/docs/api/search/search-recordings Search across recording transcripts, summaries, and action items. ```APIDOC ## POST /public/search ### Description Search across recording transcripts, summaries, and action items. ### Method POST ### Endpoint https://public.heypocketai.com/api/v1/public/search ### Parameters #### Request Body - **query** (string) - Required - The search query to find relevant content in recordings - **limit** (integer) - Optional - Maximum number of results to return (1-20). Default is 8. - **filters** (object) - Optional - Optional filters to narrow down search results ### Request Example { "query": "string", "limit": 8, "filters": {} } ### Response #### Success Response (200) - **results** (array) - List of search results ``` -------------------------------- ### List Organization Templates Source: https://docs.heypocketai.com/docs/api/organization/templates Retrieve all templates belonging to the organization. Requires at least member role. ```http GET /api/v1/organization/:orgId/templates ``` ```json { "templates": [ { "id": "tpl_abc123", "name": "Sales Call Debrief", "description": "Structured summary for sales conversations", "sections": [ { "title": "Key Takeaways", "prompt": "List the main outcomes" }, { "title": "Action Items", "prompt": "Extract follow-up tasks" } ], "created_at": "2026-03-01T09:00:00.000Z", "updated_at": "2026-03-15T14:00:00.000Z" } ] } ``` -------------------------------- ### Manually Test MCP Endpoint Source: https://docs.heypocketai.com/docs/api/organization/mcp Use curl to verify the MCP server connection and list available tools. ```bash curl -X POST https://public.heypocketai.com/mcp \ -H "Authorization: Bearer pk_xxx" \ -H "Content-Type: application/json" \ -H "Accept: application/json, text/event-stream" \ -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' ``` -------------------------------- ### create_org_template Source: https://docs.heypocketai.com/docs/api/organization/mcp Creates a new organization template. ```APIDOC ## create_org_template ### Description Create a new shared template for the organization. ### Parameters - **name** (string) - Required - **sections** (array) - Required - **description** (string) - Optional - **icon** (string) - Optional - **meeting_context** (string) - Optional - **generate_action_items** (boolean) - Optional - **generate_mind_map** (boolean) - Optional - **category** (string) - Optional - **routing_instructions** (string) - Optional ``` -------------------------------- ### GET /api/v1/organization/:orgId/users Source: https://docs.heypocketai.com/docs/api/organization/users Returns a paginated list of active members of the organization. Pending and removed members are excluded. ```APIDOC ## GET /api/v1/organization/:orgId/users ### Description Returns a paginated list of active members of the organization. Results are sorted by email ascending. ### Method GET ### Endpoint /api/v1/organization/:orgId/users ### Parameters #### Path Parameters - **orgId** (string) - Required - The unique identifier of the organization. #### Query Parameters - **q** (string) - Optional - Case-insensitive substring match on email or display name. - **page** (integer) - Optional - 1-based page number, default 1. - **limit** (integer) - Optional - Items per page (max 100), default 25. ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **data** (array) - List of user objects. - **pagination** (object) - Pagination metadata. #### Response Example { "success": true, "data": [ { "user_id": "usr_001", "email": "alice@example.com", "display_name": "Alice Liu", "role": "admin", "status": "active", "is_active": true, "created_at": "2025-12-01T18:42:11.000Z", "updated_at": "2026-04-08T10:14:22.000Z", "member_since": "2026-01-04T15:00:00.000Z", "recording_count": 42, "latest_recording_at": "2026-04-29T09:21:33.000Z" } ], "pagination": { "page": 1, "limit": 25, "total": 1, "total_pages": 1, "has_more": false } } ``` -------------------------------- ### POST /api/v1/organization/:orgId/templates Source: https://docs.heypocketai.com/docs/api/organization/templates Creates a new organization template. Requires a minimum role of admin. ```APIDOC ## POST /api/v1/organization/:orgId/templates ### Description Creates a new organization template. ### Method POST ### Endpoint /api/v1/organization/:orgId/templates ### Parameters #### Request Body - **name** (string) - Required - Template display name - **description** (string) - Optional - Short description of the template's purpose - **sections** (object[]) - Required - Ordered list of template sections ### Request Example { "name": "Sales Call Debrief", "description": "Structured summary for sales conversations", "sections": [ { "title": "Key Takeaways", "prompt": "List the main outcomes" }, { "title": "Action Items", "prompt": "Extract follow-up tasks" }, { "title": "Objections", "prompt": "Summarize any objections raised" } ] } ### Response #### Success Response (200) - **id** (string) - Created template ID #### Response Example { "id": "tpl_def456", "name": "Sales Call Debrief", "description": "Structured summary for sales conversations", "sections": [ { "title": "Key Takeaways", "prompt": "List the main outcomes" }, { "title": "Action Items", "prompt": "Extract follow-up tasks" }, { "title": "Objections", "prompt": "Summarize any objections raised" } ], "created_at": "2026-04-10T08:00:00.000Z", "updated_at": "2026-04-10T08:00:00.000Z" } ```