### Manage guide hosting Source: https://gosummer.ai/docs/agent-setup Get, save, or verify guide hosting configuration. Follow returned DNS instructions and verify ownership, provider setup, and HTTPS separately. ```bash guides hosting get/save/verify ``` -------------------------------- ### Get guide details with guides get Source: https://gosummer.ai/docs/agent-setup Use this command to retrieve guide information. Part of the guide authoring workflow. ```bash guides get ``` -------------------------------- ### Get specific guide article with guides article get Source: https://gosummer.ai/docs/agent-setup Use this command to retrieve a specific guide article by ID. ```bash guides article get ID ``` -------------------------------- ### GET /v1/companies/{company}/guides/hosting Source: https://gosummer.ai/docs/api-reference Reads the optional custom guide domain, DNS instructions and verified HTTPS status. Summer-hosted guide URLs need no customer DNS setup. ```APIDOC ## [GET] /v1/companies/{company}/guides/hosting ### Description Reads the optional custom guide domain, DNS instructions and verified HTTPS status. Summer-hosted guide URLs need no customer DNS setup. ### Method GET ### Endpoint /v1/companies/{company}/guides/hosting ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID ### Request Example {} ### Response #### Success Response (200) - **No response body documented** #### Response Example {} ``` -------------------------------- ### GET /v1/companies/{company}/environments/{environment}/setup Source: https://gosummer.ai/docs/api-reference Retrieves the saved, verified, pending, unavailable, and enabled state for each setup item. Requires setup or capabilities.read access. ```APIDOC ## GET /v1/companies/{company}/environments/{environment}/setup ### Description Retrieves the saved, verified, pending, unavailable, and enabled state for each setup item. ### Method GET ### Endpoint /v1/companies/{company}/environments/{environment}/setup ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID - **environment** (`staging`, `production`) - Required - Environment that owns the resource ### Response #### Success Response (200) - **setup** (array) - List of setup items with their states #### Response Example { "setup": [] } ``` -------------------------------- ### summer.setup.json configuration file Source: https://gosummer.ai/docs/developer-platform Defines the project setup configuration, including messenger installation, credentials, and knowledge. It holds no secret values. ```json { "version": 1, "company": "YOUR_COMPANY_ID", "environment": "staging", "messenger": { "installations": [ { "key": "website", "signing_key_destination": ".env.local:SUMMER_MESSENGER_SIGNING_KEY", "settings": { "enabled": true, "guests_enabled": true, "display_name": "Support", "allowed_origins": [ "http://localhost:3000" ], "privacy_url": "", "fallback_url": "", "office_hours": "" } } ] }, "credentials": [ { "name": "STRIPE_READ_KEY", "from_env": "STRIPE_READ_KEY" } ], "knowledge": [ { "id": "ops.company-profile", "file": "summer/company-profile.md", "reason": "Initial setup" } ] } ``` -------------------------------- ### Login with publish scope Source: https://gosummer.ai/docs/agent-setup Log in to Summer with the `setup` and `guides.publish` scopes to obtain authorization for publishing guides. Use `--json` for JSON output. ```bash summer login --scope setup,guides.publish --json ``` -------------------------------- ### Open guide preview with guides preview Source: https://gosummer.ai/docs/agent-setup Use this command to preview the guide. Check media, downloads, search, section links, layout, and product links. ```bash guides preview ``` -------------------------------- ### GET /v1/companies/{company}/guides/authoring Source: https://gosummer.ai/docs/api-reference Gets the reviewed company-specific guide-building instructions for your native coding agent. Requires setup access. ```APIDOC ## GET /v1/companies/{company}/guides/authoring ### Description Gets the reviewed company-specific guide-building instructions for your native coding agent. Requires setup access. ### Method GET ### Endpoint /v1/companies/{company}/guides/authoring ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID ### Response #### Success Response (200) - **instructions** (string) - The authoring instructions #### Response Example { "instructions": "Instructions text" } ``` -------------------------------- ### GET /v1/companies/{company}/environments/{environment}/messenger/installations Source: https://gosummer.ai/docs/api-reference Lists all Messenger installations in the specified environment. Signing keys are never returned. Requires setup access (owner or admin). ```APIDOC ## [GET] /v1/companies/{company}/environments/{environment}/messenger/installations ### Description Lists all Messenger installations in the specified environment. Signing keys are never returned. Requires setup access (owner or admin). ### Method GET ### Endpoint /v1/companies/{company}/environments/{environment}/messenger/installations ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID - **environment** (`staging`, `production`) - Required - Environment that owns the resource ### Response #### Success Response (200) - **installations** (array) - List of Messenger installations (details not specified) #### Response Example ```json { "installations": [] } ``` ``` -------------------------------- ### Plan and apply Summer setup Source: https://gosummer.ai/docs/developer-platform Commands to plan and apply the setup defined in summer.setup.json. The plan compares with Summer and lists changes; applying again after interruption replays finished steps. ```sh summer setup plan --file summer.setup.json --out summer.plan.json --json summer setup apply --plan summer.plan.json --file summer.setup.json --json ``` -------------------------------- ### GET /v1/companies/{company}/guides/articles/{article} Source: https://gosummer.ai/docs/api-reference Reads an editable guide article and its current knowledge revision. Requires setup access. ```APIDOC ## GET /v1/companies/{company}/guides/articles/{article} ### Description Reads an editable guide article and its current knowledge revision. Requires setup access. ### Method GET ### Endpoint /v1/companies/{company}/guides/articles/{article} ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID - **article** (string) - Required - Article identifier, at most 100 characters. ### Response #### Success Response (200) - **article** (object) - The article details - **revision** (integer) - Current knowledge revision #### Response Example { "article": {}, "revision": 1 } ``` -------------------------------- ### Save guide configuration with guides save Source: https://gosummer.ai/docs/agent-setup Use this command to save guide configuration at the current version. ```bash guides save ``` -------------------------------- ### Publish guide Source: https://gosummer.ai/docs/agent-setup Publish a guide using a release file and expected version. Requires human authority and separate `guides.publish` consent. Use exact article revisions. ```bash guides publish --from-file release.json --expected-version N --reason TEXT ``` -------------------------------- ### Read customer guides authoring instructions Source: https://gosummer.ai/docs/agent-setup Retrieve instructions, schemas, media syntax, and draft context for authoring customer guides. Use the MCP tool `summer_guides_authoring` for the same purpose. Requires CLI version 0.2.0+ and matching deployment. ```bash summer guides authoring --company YOUR_COMPANY_ID --json ``` -------------------------------- ### POST /v1/companies/{company}/environments/{environment}/messenger/installations Source: https://gosummer.ai/docs/api-reference Creates a new Messenger installation with a client-chosen ID. The one-time signing key is sent to a trusted local helper, not to model-visible output. Requires setup access (owner or admin) and an Idempotency-Key header. ```APIDOC ## [POST] /v1/companies/{company}/environments/{environment}/messenger/installations ### Description Creates a new Messenger installation with a client-chosen ID. The one-time signing key is sent to a trusted local helper, not to model-visible output. Requires setup access (owner or admin) and an Idempotency-Key header. ### Method POST ### Endpoint /v1/companies/{company}/environments/{environment}/messenger/installations ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID - **environment** (`staging`, `production`) - Required - Environment that owns the resource #### Request Body - **id** (UUID) - Required - New installation ID chosen by the client, so a retry cannot create a duplicate - **settings** (object) - Required - Settings for the installation - **settings.enabled** (boolean) - Required - Live widget. The approved setup grant includes production installation and activation. - **settings.guests_enabled** (boolean) - Required - Whether guests are enabled - **settings.display_name** (string) - Required - Company name shown in the Messenger header. At most 80 characters. - **settings.logo_url** (string) - Optional - Public company logo shown in the header. At most 1024 characters. - **settings.identity** (object) - Optional - Agent name and AI disclosure. Defaults to named support with a neutral first name and last initial. - **settings.identity.mode** (`human`, `ai`) - Optional - Named support persona (default) or a visible AI assistant label. Default `"human"`. - **settings.identity.name_style** (`neutral`, `female`) - Optional - Default `"neutral"`. - **settings.identity.custom_name** (string) - Optional - At most 80 characters. Default `""`. - **settings.allowed_origins** (array of string) - Required - Exact website origins, https (http://localhost allowed in staging) - **settings.privacy_url** (string) - Required - At most 512 characters. - **settings.fallback_url** (string) - Required - At most 512 characters. - **settings.office_hours** (string) - Required - At most 200 characters. - **settings.presentation** (object) - Optional - Company chat colors, welcome and chat copy, home/chat links and contact form labels. Plain text only; links use HTTPS. Scoped to this installation. - **settings.presentation.colors** (object) - Optional - Default `{}`. - **settings.presentation.colors.accent** (string) - Optional - At most 7 characters. Default `"#a95424"`. - **settings.presentation.colors.customer_bubble** (string) - Optional - At most 7 characters. Default `"#eef1e7"`. - **settings.presentation.welcome_title** (string) - Optional - At most 100 characters. Default `"How can we help?"`. - **settings.presentation.welcome_description** (string) - Optional - At most 300 characters. Default `""`. - **settings.presentation.chat_label** (string) - Optional - At most 60 characters. Default `"Message support"`. - **settings.presentation.header_description** (string) - Optional - At most 100 characters. Default `"Support team"`. - **settings.presentation.thread_title** (string) - Optional - At most 100 characters. Default `"What's on your mind?"`. - **settings.presentation.thread_description** (string) - Optional - At most 300 characters. Default `"Ask a question here. We can help you find the next step."`. - **settings.presentation.actions** (array of object or object) - Optional - Default `[{"type":"lead_capture","label":"Request follow-up","show_on_home":false,"show_in_chat":true}]`. - **settings.presentation.lead_capture** (object) - Optional - Default `{}`. - **settings.presentation.lead_capture.title** (string) - Optional - At most 100 characters. Default `"Request follow-up"`. - **settings.presentation.lead_capture.description** (string) - Optional - At most 300 characters. Default `"Leave your details so our team can contact you."`. - **settings.presentation.lead_capture.name_label** (string) - Optional - At most 60 characters. Default `"Name"`. - **settings.presentation.lead_capture.email_label** (string) - Optional - At most 60 characters. Default `"Email"`. - **settings.presentation.lead_capture.company_label** (string) - Optional - At most 60 characters. Default `"Company"`. - **settings.presentation.lead_capture.phone_label** (string) - Optional - At most 60 characters. Default `"Phone number"`. - **settings.presentation.lead_capture.show_phone** (boolean) - Optional - Default `false`. - **settings.presentation.lead_capture.phone_required** (boolean) - Optional - Default `false`. - **settings.presentation.lead_capture.message_label** (string) - Optional - At most 60 characters. Default `"Message"`. ### Request Example ```json { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "settings": { "enabled": true, "guests_enabled": true, "display_name": "Example Company", "allowed_origins": ["https://example.com"], "privacy_url": "https://example.com/privacy", "fallback_url": "https://example.com/contact", "office_hours": "Mon-Fri 9am-5pm" } } ``` ### Response #### Success Response (201) - **installation** (object) - The created installation (details not specified) #### Response Example ```json { "installation": {} } ``` ``` -------------------------------- ### GET /v1/companies/{company}/guides/history Source: https://gosummer.ai/docs/api-reference Reads the company's guide edits, upload and publication history. Requires setup or guides.publish access. ```APIDOC ## [GET] /v1/companies/{company}/guides/history ### Description Reads the company's guide edits, upload and publication history. Requires setup or guides.publish access. ### Method GET ### Endpoint /v1/companies/{company}/guides/history ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID ### Request Example {} ### Response #### Success Response (200) - **No response body documented** #### Response Example {} ``` -------------------------------- ### GET /v1/companies/{company}/environments/{environment}/messenger/voice Source: https://gosummer.ai/docs/api-reference Reads voice chat settings per installation, the voice services and their voices, published help article count, and the voice assistant's update status. Requires setup access (owner or admin) and applies to one environment. ```APIDOC ## [GET] /v1/companies/{company}/environments/{environment}/messenger/voice ### Description Reads voice chat settings per installation, the voice services and their voices, published help article count, and the voice assistant's update status. ### Method GET ### Endpoint /v1/companies/{company}/environments/{environment}/messenger/voice ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID - **environment** (`staging`, `production`) - Required - Environment that owns the resource ### Response #### Success Response (200) No response body documented. ``` -------------------------------- ### GET /v1/companies/{company}/environments/{environment}/messenger/assistant Source: https://gosummer.ai/docs/api-reference Reads assistant settings per installation and whether the managed runtime is enabled. ```APIDOC ## GET /v1/companies/{company}/environments/{environment}/messenger/assistant ### Description Reads assistant settings per installation and whether the managed runtime is enabled. ### Method GET ### Endpoint /v1/companies/{company}/environments/{environment}/messenger/assistant ### Parameters #### Path Parameters - `company` (UUID) - Required - Summer company ID - `environment` (`staging`, `production`) - Required - Environment that owns the resource ### Response #### Success Response (200) No response body details provided. #### Response Example No response example provided. ``` -------------------------------- ### Save guide article Source: https://gosummer.ai/docs/agent-setup Save a Markdown guide article with metadata and revision. New articles use revision 0. The `--reason` field is required. ```bash summer guides article save ID --from-file article.md --metadata-file article.json --revision N --reason TEXT ``` -------------------------------- ### PATCH /v1/companies/{company}/environments/{environment}/messenger/installations/{installation} Source: https://gosummer.ai/docs/api-reference Updates installation settings with the expected version. Keeps the signing key. Requires setup access (owner or admin) and applies to one environment. ```APIDOC ## [PATCH] /v1/companies/{company}/environments/{environment}/messenger/installations/{installation} ### Description Updates installation settings with the expected version. Keeps the signing key. ### Method PATCH ### Endpoint /v1/companies/{company}/environments/{environment}/messenger/installations/{installation} ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID - **environment** (`staging`, `production`) - Required - Environment that owns the resource - **installation** (UUID) - Required #### Request Body - **expected_version** (integer) - Required - **settings** (object) - Required - **settings.enabled** (boolean) - Required - Live widget. The approved setup grant includes production installation and activation. - **settings.guests_enabled** (boolean) - Required - **settings.display_name** (string) - Required - Company name shown in the Messenger header. At most 80 characters. - **settings.logo_url** (string) - Optional - Public company logo shown in the header. At most 1024 characters. - **settings.identity** (object) - Optional - Agent name and AI disclosure. Defaults to named support with a neutral first name and last initial. - **settings.identity.mode** (`human`, `ai`) - Optional - Named support persona (default) or a visible AI assistant label. Default `"human"`. - **settings.identity.name_style** (`neutral`, `female`) - Optional - Default `"neutral"`. - **settings.identity.custom_name** (string) - Optional - At most 80 characters. Default `""`. - **settings.allowed_origins** (array of string) - Required - Exact website origins, https (http://localhost allowed in staging) - **settings.privacy_url** (string) - Required - At most 512 characters. - **settings.fallback_url** (string) - Required - At most 512 characters. - **settings.office_hours** (string) - Required - At most 200 characters. - **settings.presentation** (object) - Optional - Company chat colors, welcome and chat copy, home/chat links and contact form labels. Plain text only; links use HTTPS. Scoped to this installation. - **settings.presentation.colors** (object) - Optional - Default `{}`. - **settings.presentation.colors.accent** (string) - Optional - At most 7 characters. Default `"#a95424"`. - **settings.presentation.colors.customer_bubble** (string) - Optional - At most 7 characters. Default `"#eef1e7"`. - **settings.presentation.welcome_title** (string) - Optional - At most 100 characters. Default `"How can we help?"`. - **settings.presentation.welcome_description** (string) - Optional - At most 300 characters. Default `""`. - **settings.presentation.chat_label** (string) - Optional - At most 60 characters. Default `"Message support"`. - **settings.presentation.header_description** (string) - Optional - At most 100 characters. Default `"Support team"`. - **settings.presentation.thread_title** (string) - Optional - At most 100 characters. Default `"What's on your mind?"`. - **settings.presentation.thread_description** (string) - Optional - At most 300 characters. Default `"Ask a question here. We can help you find the next step."`. - **settings.presentation.actions** (array of object or object) - Optional - Default `[{"type":"lead_capture","label":"Request follow-up","show_on_home":false,"show_in_chat":true}]`. - **settings.presentation.lead_capture** (object) - Optional - Default `{}`. - **settings.presentation.lead_capture.title** (string) - Optional - At most 100 characters. Default `"Request follow-up"`. - **settings.presentation.lead_capture.description** (string) - Optional - At most 300 characters. Default `"Leave your details so our team can contact you."`. - **settings.presentation.lead_capture.show_message** (boolean) - Optional - Default `true`. - **settings.presentation.lead_capture.show_company** (boolean) - Optional - Default `true`. - **settings.presentation.lead_capture.company_required** (boolean) - Optional - Default `false`. - **settings.presentation.lead_capture.consent_text** (string) - Optional - At most 500 characters. Default `"I agree that this team may contact me using these details."`. - **settings.presentation.lead_capture.submit_label** (string) - Optional - At most 60 characters. Default `"Send my details"`. - **settings.presentation.lead_capture.success_message** (string) - Optional - At most 200 characters. Default `"Your details are saved for our team."`. - **settings.presentation.lead_capture.follow_up_label** (string) - Optional - At most 60 characters. Default `"Book a call"`. - **settings.presentation.lead_capture.follow_up_url** (string or ``) - Optional - Default `""`. - **settings.routing** (object) - Optional - **settings.routing.clinician_url** (string) - Optional - At most 512 characters. - **settings.routing.sign_in_url** (string) - Optional - At most 512 characters. - **settings.routing.catalog_url** (string) - Optional - At most 512 characters. - **settings.routing.offer_url** (string) - Optional - At most 512 characters. - **settings.routing.offer_label** (string) - Optional - At most 80 characters. - **settings.routing.destination_origins** (array of string) - Optional ### Access - `setup` (owner or admin) ### Applies to - One environment ### MCP - `summer_messenger_installations_update` ### Idempotency-Key - Recommended ``` -------------------------------- ### PUT /v1/companies/{company}/environments/{environment}/messenger/installations/{installation}/assistant Source: https://gosummer.ai/docs/api-reference Updates assistant instructions and escalation permission with the expected revision. Requires setup access (owner or admin) and applies to one environment. ```APIDOC ## [PUT] /v1/companies/{company}/environments/{environment}/messenger/installations/{installation}/assistant ### Description Updates assistant instructions and escalation permission with the expected revision. Company facts live in shared knowledge. Cannot raise the spending limit. ### Method PUT ### Endpoint /v1/companies/{company}/environments/{environment}/messenger/installations/{installation}/assistant ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID - **environment** (`staging`, `production`) - Required - Environment that owns the resource - **installation** (UUID) - Required - #### Request Body - **revision** (integer) - Required - - **settings** (object) - Required - - **settings.enabled** (boolean) - Required - Automatic replies. The approved setup grant includes production activation within the current spending limit. - **settings.instructions** (string) - Required - At most 50000 characters. - **settings.lead_capture_enabled** (boolean) - Optional - Offer an optional consent-based contact form in chat. - **settings.escalation_enabled** (boolean) - Optional - Allow investigation handoffs. Set false for a product and sales chat. - **settings.budget_cents** (integer) - Required - Cannot exceed the current limit through the API ### Response #### Success Response (200) No response body documented. ``` -------------------------------- ### GET /v1/companies/{company}/guide-assets/{asset} Source: https://gosummer.ai/docs/api-reference Reads one guide asset, checksum and resumable chunk receipts. No secret upload capability is returned. ```APIDOC ## [GET] /v1/companies/{company}/guide-assets/{asset} ### Description Reads one guide asset, checksum and resumable chunk receipts. No secret upload capability is returned. ### Method GET ### Endpoint /v1/companies/{company}/guide-assets/{asset} ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID - **asset** (UUID) - Required - ### Request Example {} ### Response #### Success Response (200) - **No response body documented** #### Response Example {} ``` -------------------------------- ### GET /v1/companies/{company}/settings Source: https://gosummer.ai/docs/api-reference Reads company-wide settings that affect every environment. Requires setup access. ```APIDOC ## [GET] /v1/companies/{company}/settings ### Description Reads company-wide settings that affect every environment. Requires setup access. ### Method GET ### Endpoint /v1/companies/{company}/settings ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID ### Request Example {} ### Response #### Success Response (200) - **No response fields documented** #### Response Example {} ``` -------------------------------- ### Messenger installation settings JSON Source: https://gosummer.ai/docs/install-messenger Shared installation settings for UI, API, CLI, and MCP. Include these fields alongside other installation settings. Use "mode": "ai" for AI label and "name_style": "female" for female default. Empty custom_name uses default name; omitting identity or logo_url during update keeps saved value. ```json { "display_name": "Example Care", "logo_url": "https://example.com/logo.png", "identity": { "mode": "human", "name_style": "neutral", "custom_name": "Jamie L." } } ``` -------------------------------- ### Summer setup prompt for AI agent Source: https://gosummer.ai/docs/agent-setup Generic setup prompt for configuring Summer in a project. Includes company ID placeholder, API endpoint, CLI usage, MCP server, secrets management, and consent scope. Use when setup is enabled or via 'Copy setup prompt'. ```markdown # Set up Summer in this project Set up Summer for this business in this repository. Use authorized company knowledge and tools to understand workflows and test them. Configure Summer through its API, CLI or MCP. Keep service credentials separate; Summer tokens are only for Summer. Test how Summer handles the business's support cases. A capability passes when Summer can find and use its API, browser, knowledge or connected-tool path. Tool names are hints. Complete available setup and record precise blockers. Summer details: - API: https://api.gosummer.ai - Company ID: YOUR_COMPANY_ID - Environment for this setup: staging - Summer CLI: run `npx --yes @gosummerai/cli@0.1.1 `. The steps below write this as `summer `. Add `--api https://api.gosummer.ai` to each command if that is not `https://api.gosummer.ai`. - Optional MCP server: https://api.gosummer.ai/mcp If the Company ID is `YOUR_COMPANY_ID`, run `summer companies --json` after sign-in and use the selected company's ID in every command and setup file. If more than one company is available and the project does not identify one, ask me to choose. Use Summer's built-in secrets manager for provider credentials. Customers can save values in Settings → Integrations with **Store in Summer**, or through the CLI using `--from-env`, `--from-file` or `--from-stdin`. If using MCP, list credential metadata there and use `summer_credentials_set` with `source: local_value` for a local CLI handoff. Never put secret values in MCP arguments or chat. Doppler is optional. Do not ask me to create a Doppler account or connect a vault unless I choose that option. The original setup consent covers normal Messenger installation, embed changes and activation within the selected company/environment and current spending limit. Do not add a separate installation approval or escalate routine setup to another agent. A setup grant does not approve customer business actions, investigations, budget increases or clinical directions. ## Write for the reader Address the reader: customers for customer guides, staff for internal procedures. Follow ASD-STE100 Simplified Technical English about 80% for human-facing text. Aim for instructions under 20 words and descriptions under 25 words. Use active voice, one idea per sentence, simple present-tense verbs and consistent terms. Avoid metaphors, idioms and technical slang. Keep necessary facts and uncertainty. ## Steps 1. Inspect this project and relevant company guidance first. Identify products, customer requests, care and fulfillment flows, billing, refunds, subscriptions, support channels, policies, promises and existing tools. Find where operational facts live and how an agent can discover them. Identify the framework, sign-in and server-side secret configuration too. Do not print or dump environment files or secret values. Use only relevant company material; keep patient records in their authorized case. 2. Run `summer doctor --json` to check the API address and sign-in service. If it reports a failed check, explain the returned reason before continuing. Check access with `summer whoami --json`. If you are not signed in, run `summer login --scope setup --json` and ask me to approve the connection in my browser. Wait for the browser consent or my explicit approval of that connection. Use an existing authorized connection without asking again. If the result says access is pending, stop and tell me. ``` -------------------------------- ### GET /v1/companies/{company}/guides Source: https://gosummer.ai/docs/api-reference Reads the company's editable guidebook, draft articles, assets, and publication state. Requires setup or guides.publish access. ```APIDOC ## GET /v1/companies/{company}/guides ### Description Reads the company's editable guidebook, draft articles, assets, and publication state. Requires setup or guides.publish access. ### Method GET ### Endpoint /v1/companies/{company}/guides ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID ### Response #### Success Response (200) - **guidebook** (object) - The guidebook details - **articles** (array) - List of draft articles - **assets** (array) - List of assets - **publication_state** (object) - Current publication state #### Response Example { "guidebook": {}, "articles": [], "assets": [], "publication_state": {} } ``` -------------------------------- ### GET /v1/companies/{company}/environments/{environment}/capabilities Source: https://gosummer.ai/docs/api-reference Retrieves the capabilities available for a specific company environment. Requires setup or capabilities.read access. ```APIDOC ## GET /v1/companies/{company}/environments/{environment}/capabilities ### Description Retrieves the capabilities available for a specific company environment. ### Method GET ### Endpoint /v1/companies/{company}/environments/{environment}/capabilities ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID - **environment** (`staging`, `production`) - Required - Environment that owns the resource ### Response #### Success Response (200) - **capabilities** (array) - List of capabilities #### Response Example { "capabilities": [] } ``` -------------------------------- ### GET /v1/companies/{company}/guide-assets Source: https://gosummer.ai/docs/api-reference Lists the company's private guide media, metadata and upload status. Uploading does not make a file public. ```APIDOC ## [GET] /v1/companies/{company}/guide-assets ### Description Lists the company's private guide media, metadata and upload status. Uploading does not make a file public. ### Method GET ### Endpoint /v1/companies/{company}/guide-assets ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID ### Request Example {} ### Response #### Success Response (200) - **No response body documented** #### Response Example {} ``` -------------------------------- ### Save guide article with guides article save Source: https://gosummer.ai/docs/agent-setup Use this command to save Markdown content for a guide article. New articles use revision 0. ```bash guides article save ID --from-file article.md --metadata-file article.json --revision N --reason TEXT ``` -------------------------------- ### Configure branding with summer guides save Source: https://gosummer.ai/docs/company-knowledge Use this CLI command to configure branding for a customer guide. Requires --company COMPANY_ID; add --json for structured results. The settings file includes slug, title, description, accent, portal_url, and optional logo_asset_id. ```bash summer guides save --from-file settings.json --expected-version N --reason TEXT ``` -------------------------------- ### POST /v1/companies/{company}/guide-assets/{asset}/complete Source: https://gosummer.ai/docs/api-reference Verifies the original size, content signature and SHA-256 against saved private bytes, then marks a guide upload ready. A ready file remains private until published in a guide. ```APIDOC ## [POST] /v1/companies/{company}/guide-assets/{asset}/complete ### Description Verifies the original size, content signature and SHA-256 against saved private bytes, then marks a guide upload ready. A ready file remains private until published in a guide. ### Method POST ### Endpoint /v1/companies/{company}/guide-assets/{asset}/complete ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID - **asset** (UUID) - Required - ### Request Example (No request example provided) ### Response #### Success Response (200) (No response fields provided) #### Response Example (No response example provided) ``` -------------------------------- ### GET /v1/companies/{company}/environments/{environment}/integrations Source: https://gosummer.ai/docs/api-reference Lists provider integrations, their required fields and saved metadata. Never returns values and requires setup access. ```APIDOC ## [GET] /v1/companies/{company}/environments/{environment}/integrations ### Description Lists provider integrations, their required fields and saved metadata. Never returns values and requires setup access. ### Method GET ### Endpoint /v1/companies/{company}/environments/{environment}/integrations ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID - **environment** (`staging`, `production`) - Required - Environment that owns the resource ### Request Example {} ### Response #### Success Response (200) - **No response fields documented** #### Response Example {} ``` -------------------------------- ### MCP tool for guides authoring Source: https://gosummer.ai/docs/agent-setup MCP tool name for accessing guides authoring instructions. ```text summer_guides_authoring ``` -------------------------------- ### boot(config) Source: https://gosummer.ai/docs/verified-identity Boots the widget with the given configuration. Used to show a visitor widget after logout, only if your installation allows visitors. ```APIDOC ## boot(config) ### Description Boots the widget with the given configuration. Used to show a visitor widget after logout, only if your installation allows visitors. ### Method `window.SummerMessenger.boot(window.summerMessengerConfig)` ### Parameters - **config** (object) - Required - The widget configuration, typically `window.summerMessengerConfig`. ### Example ```javascript window.SummerMessenger.boot(window.summerMessengerConfig); ``` ``` -------------------------------- ### GET /v1/companies/{company}/environments/{environment}/credentials Source: https://gosummer.ai/docs/api-reference Lists saved credential names, sources and versions. Never returns values and requires setup access. ```APIDOC ## [GET] /v1/companies/{company}/environments/{environment}/credentials ### Description Lists saved credential names, sources and versions. Never returns values and requires setup access. ### Method GET ### Endpoint /v1/companies/{company}/environments/{environment}/credentials ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID - **environment** (`staging`, `production`) - Required - Environment that owns the resource ### Request Example {} ### Response #### Success Response (200) - **No response fields documented** #### Response Example {} ``` -------------------------------- ### POST /v1/companies/{company}/environments/{environment}/capability-checks/{capability}/reports Source: https://gosummer.ai/docs/api-reference Records the setup agent's capability assessment with original evidence and the path Summer can discover and use. Requires setup access. ```APIDOC ## POST /v1/companies/{company}/environments/{environment}/capability-checks/{capability}/reports ### Description Records the setup agent's capability assessment with original evidence and the path Summer can discover and use. Reports are labeled as agent-reported, never human approval or independently verified execution. ### Method POST ### Endpoint /v1/companies/{company}/environments/{environment}/capability-checks/{capability}/reports ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID - **environment** (`staging`, `production`) - Required - Environment that owns the resource - **capability** (string) - Required - The capability identifier #### Request Body - **expected_version** (integer) - Required - Current version you expect; 0 when the resource does not exist yet - **state** (`not_checked`, `passed`, `failed`, `blocked`, `not_applicable`) - Required - The state of the capability - **notes** (string) - Required - At most 2000 characters. - **evidence** (string) - Required - At most 2000 characters. - **fulfillment** (object) - Optional - The fulfillment details - **fulfillment.kind** (`api`, `browser`, `knowledge`, `other`, `combined`) - Required - The kind of fulfillment - **fulfillment.discovery** (string) - Required - How Summer can discover this path. At most 1000 characters. - **fulfillment.location** (string) - Required - Guide, tool, API documentation or portal location; never a secret. At most 1000 characters. ### Request Example { "expected_version": 0, "state": "passed", "notes": "", "evidence": "", "fulfillment": { "kind": "api", "discovery": "", "location": "" } } ### Response #### Success Response (200) - **report** (object) - The created report #### Response Example { "report": {} } ``` -------------------------------- ### Install and sign in to Summer CLI Source: https://gosummer.ai/docs/developer-platform Run this command with Node.js 22 or newer to install and sign in to the Summer CLI. It opens a consent page in your browser; after signing in and choosing companies, environments, and permissions, the CLI stores the credential in your operating system's credential store, never in a plain file. ```sh npx --yes @gosummerai/cli@0.1.0 login --scope setup --json ``` -------------------------------- ### Add Summer Messenger configuration and loader Source: https://gosummer.ai/docs/install-messenger Place this configuration before the asynchronous loader, replacing YOUR_INSTALLATION_UUID with your installation ID. The installation ID is public; the signing key is private and must not be included. If your site uses Content Security Policy, allow the Summer host for script, frame, and connection requests, and apply your normal nonce or hash to the inline configuration. ```html ``` -------------------------------- ### GET /v1/companies/{company}/environments/{environment}/capability-checks/{capability} Source: https://gosummer.ai/docs/api-reference Reads one capability, its concrete test, evidence, and latest 20 review records. Requires capabilities.read or setup access. ```APIDOC ## GET /v1/companies/{company}/environments/{environment}/capability-checks/{capability} ### Description Reads one capability, its concrete test, evidence, and latest 20 review records. ### Method GET ### Endpoint /v1/companies/{company}/environments/{environment}/capability-checks/{capability} ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID - **environment** (`staging`, `production`) - Required - Environment that owns the resource - **capability** (string) - Required - The capability identifier ### Response #### Success Response (200) - **capability** (object) - The capability details - **test** (string) - The concrete test - **evidence** (string) - The evidence - **reviews** (array) - Latest 20 review records #### Response Example { "capability": {}, "test": "", "evidence": "", "reviews": [] } ``` -------------------------------- ### GET /v1/companies/{company}/guides/preview Source: https://gosummer.ai/docs/api-reference Reads the exact current draft, article revisions, and authenticated preview URL before publishing. No public access token is issued. Requires setup or guides.publish access. ```APIDOC ## GET /v1/companies/{company}/guides/preview ### Description Reads the exact current draft, article revisions, and authenticated preview URL before publishing. No public access token is issued. Requires setup or guides.publish access. ### Method GET ### Endpoint /v1/companies/{company}/guides/preview ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID ### Response #### Success Response (200) - **draft** (object) - The current draft - **article_revisions** (array) - List of article revisions - **preview_url** (string) - Authenticated preview URL #### Response Example { "draft": {}, "article_revisions": [], "preview_url": "https://preview.example.com" } ``` -------------------------------- ### PUT /v1/companies/{company}/guides/hosting Source: https://gosummer.ai/docs/api-reference Saves or removes a custom guide hostname at the expected version. Saving a name does not verify ownership or provision HTTPS. ```APIDOC ## [PUT] /v1/companies/{company}/guides/hosting ### Description Saves or removes a custom guide hostname at the expected version. Saving a name does not verify ownership or provision HTTPS. ### Method PUT ### Endpoint /v1/companies/{company}/guides/hosting ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID #### Request Body - **expected_version** (integer) - Required - - **hostname** (string or null) - Required - ### Request Example { "expected_version": 0, "hostname": "string" } ### Response #### Success Response (200) - **No response body documented** #### Response Example {} ``` -------------------------------- ### Save capability check definition Source: https://gosummer.ai/docs/agent-setup Save a business-specific capability definition with the Summer CLI. The definition must include an id starting with `custom_`, title, group, mode (`read` or `approval`), expectation, test, and examples (discovery hints or empty string). Use `--expected-version 0` for new definitions and specify company and environment. ```bash summer capability-checks save ID --from-file definition.json --expected-version 0 --reason TEXT --company YOUR_COMPANY_ID --environment staging --json ``` -------------------------------- ### PUT /v1/companies/{company}/guides Source: https://gosummer.ai/docs/api-reference Creates or edits guidebook details at the expected version. Saves a private draft without publishing. Requires setup access. ```APIDOC ## PUT /v1/companies/{company}/guides ### Description Creates or edits guidebook details at the expected version. Saves a private draft without publishing. Requires setup access. ### Method PUT ### Endpoint /v1/companies/{company}/guides ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID #### Request Body - **expected_version** (integer) - Required - Expected version of the guidebook - **settings** (object) - Required - Guidebook settings - **settings.slug** (string) - Required - At most 100 characters. - **settings.title** (string) - Required - At most 160 characters. - **settings.description** (string) - Required - At most 1000 characters. - **settings.accent** (string) - Required - Accent color - **settings.hero_background** (string) - Optional - Hero background image - **settings.portal_url** (string) - Required - Portal URL (empty string allowed) - **settings.logo_asset_id** (UUID or null) - Optional - Logo asset ID - **reason** (string) - Required - Reason for change, at most 2000 characters. ### Request Example { "expected_version": 1, "settings": { "slug": "guide", "title": "Guide", "description": "Description", "accent": "#000000", "portal_url": "https://example.com" }, "reason": "Update guidebook" } ### Response #### Success Response (200) - **guidebook** (object) - The updated guidebook #### Response Example { "guidebook": {} } ``` -------------------------------- ### GET /v1/companies/{company}/environments/{environment}/events Source: https://gosummer.ai/docs/api-reference Read configuration and activity events after a cursor. Resume from next_cursor. ```APIDOC ## [GET] /v1/companies/{company}/environments/{environment}/events ### Description Read configuration and activity events after a cursor. Resume from next_cursor. ### Method GET ### Endpoint /v1/companies/{company}/environments/{environment}/events ### Parameters #### Path Parameters - **company** (UUID) - Required - Summer company ID - **environment** (`staging`, `production`) - Required - Environment that owns the resource #### Query Parameters - **after** (string) - Optional - - **limit** (integer) - Optional - ### Response #### Success Response (200) - **next_cursor** (string) - Cursor to resume from #### Response Example { "next_cursor": "string" } ``` -------------------------------- ### Set chat colors via presentation.colors Source: https://gosummer.ai/docs/install-messenger Configure accent and customer message bubble colors in installation settings. Use six-digit hex values and include other presentation settings when updating this object. ```json { "presentation": { "colors": { "accent": "#2457c5", "customer_bubble": "#e3ecff" } } } ```