Summer

https://gosummer.ai/docs/
Admin
Summer is an AI assistant platform that connects a company's tools and knowledge to automate...
Tokens:50,828
Snippets:366
Trust Score:2.3
Update:12 hours ago
Show doc for...
Tokens:
Raw
### 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 in the environment.

```APIDOC
## GET /v1/companies/{company}/environments/{environment}/setup

### Description
Retrieves the saved, verified, pending, unavailable, and enabled state for each setup item in the environment.

### 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_items** (array) - List of setup items with their states

#### Response Example
{
  "setup_items": [
    {
      "id": "example_item",
      "state": "saved"
    }
  ]
}
```

--------------------------------

### 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"
    }
  ]
}
```

--------------------------------

### PUT /v1/companies/{company}/environments/{environment}/messenger/installations/{installation}/assistant

Source: https://gosummer.ai/docs/api-reference

Updates the assistant instructions and knowledge for a specific installation, with a revision for concurrency control. Cannot raise the spending limit. Requires setup access (owner or admin).

```APIDOC
## PUT /v1/companies/{company}/environments/{environment}/messenger/installations/{installation}/assistant

### Description
Updates the assistant instructions and knowledge for a specific installation, with a revision for concurrency control. Cannot raise the spending limit. Requires setup access (owner or admin).

### 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 - Installation identifier

#### Request Body
- **revision** (integer) - Required - Expected revision for optimistic concurrency
- **settings** (object) - Required - Assistant settings
- **settings.enabled** (boolean) - Required - Automatic replies. Production enable needs messaging.activate.
- **settings.instructions** (string) - Required - At most 50000 characters.
- **settings.knowledge** (string) - Required - At most 200000 characters.
- **settings.budget_cents** (integer) - Required - Cannot exceed the current limit through the API

### Request Example
{
  "revision": 3,
  "settings": {
    "enabled": true,
    "instructions": "...",
    "knowledge": "...",
    "budget_cents": 1000
  }
}

### Response
#### Success Response (200)
- **revision** (integer) - Updated revision
- **settings** (object) - Updated assistant settings

#### Response Example
{
  "revision": 4,
  "settings": {
    "enabled": true,
    "instructions": "...",
    "knowledge": "...",
    "budget_cents": 1000
  }
}
```

--------------------------------

### 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}/environments/{environment}/messenger/installations

Source: https://gosummer.ai/docs/api-reference

Lists all Messenger installations in the specified environment. Signing keys are never returned.

```APIDOC
## GET /v1/companies/{company}/environments/{environment}/messenger/installations

### Description
Lists all Messenger installations in the specified environment. Signing keys are never returned.

### 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

### Access
`setup` (owner or admin)

### Applies to
one environment

### MCP
`summer_messenger_installations_list`
```

--------------------------------

### GET /v1/companies/{company}/environments/{environment}/messenger/assistant

Source: https://gosummer.ai/docs/api-reference

Reads the assistant settings for a specific environment and installation. Requires setup access (owner or admin).

```APIDOC
## GET /v1/companies/{company}/environments/{environment}/messenger/assistant

### Description
Reads the assistant settings for a specific environment and installation. Requires setup access (owner or admin).

### 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)
- **settings** (object) - Assistant settings
- **settings.enabled** (boolean) - Automatic replies enabled
- **settings.instructions** (string) - Instructions for the assistant
- **settings.knowledge** (string) - Knowledge base for the assistant
- **settings.budget_cents** (integer) - Spending limit in cents

#### Response Example
{
  "settings": {
    "enabled": true,
    "instructions": "...",
    "knowledge": "...",
    "budget_cents": 1000
  }
}
```

--------------------------------

### Apply Summer Setup Plan

Source: https://gosummer.ai/docs/agent-setup

Applies the setup plan using the summer.setup.json file. Credentials are read from environment variables and sent directly to Summer; the Messenger signing key is written to the server-side file. If a step is stale, plan again; if uncertain, read current state and follow the returned next step.

```bash
summer setup apply --plan summer.plan.json --file summer.setup.json --json
```

--------------------------------

### Summer Agent Setup Prompt

Source: https://gosummer.ai/docs/agent-setup

Generic setup prompt to copy into an AI agent chat. Includes company ID placeholder, API endpoint, and instructions for using the Summer CLI and MCP. Use with 'Copy setup prompt' or when opening ChatGPT Desktop or Claude Code.

```markdown
# Set up Summer in this project

Onboard this business to Summer, our support and operations platform. Work in this repository with the company knowledge and tools I have authorized you to use. Use Summer's own API, CLI or MCP to configure Summer. Use this business's authorized systems to understand its workflows and test operational paths. Keep each service's credentials separate; Summer sign-in tokens are only for Summer.

Your goal is to make Summer useful for this business's actual support cases. A capability is fulfilled when Summer can discover and use a working path: API, browser, current knowledge lookup, another connected tool or a combination. Tool names are hints. Identify gaps, complete the setup you can, test the result and leave precise blockers for the rest.

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 <command>`. The steps below write this as `summer <command>`. 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.

## 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 my approval; do not try to complete sign-in or consent yourself. If the result says access is pending, stop and tell me.
3. Read `summer capabilities --company YOUR_COMPANY_ID --environment staging --json`, `summer status --company YOUR_COMPANY_ID --environment staging --json` and `summer capability-checks list --company YOUR_COMPANY_ID --environment staging --json`. `operational_readiness` is the same checklist shown in Company setup → What Summer can do. Read each expectation, concrete test, prior evidence and discovery hints. Treat unavailable permissions as real. A missing named provider tool can have an available browser or knowledge alternative; discover and test those within your authority.
```

--------------------------------

### GET /v1/companies/{company}/team

Source: https://gosummer.ai/docs/api-reference

Lists company members and pending invitations. Requires setup permission and applies to the whole company.

```APIDOC
## GET /v1/companies/{company}/team

### Description
Lists company members and pending invitations. Role changes and invitations stay in Summer. Requires setup permission.

### Method
GET

### Endpoint
/v1/companies/{company}/team

### Parameters
#### Path Parameters
- **company** (UUID) - Required - Summer company ID

### Request Example
GET /v1/companies/{company}/team

### Response
#### Success Response (200)
- **members** (array) - List of company members
- **invitations** (array) - List of pending invitations

#### Response Example
{
  "members": [],
  "invitations": []
}
```

--------------------------------

### Inspect Integrations and Credentials

Source: https://gosummer.ai/docs/agent-setup

Lists integrations and credentials metadata to inspect the current setup. Useful for reviewing what is configured.

```bash
summer integrations
```

```bash
summer credentials list
```

--------------------------------

### Add the Summer messenger snippet with installation ID

Source: https://gosummer.ai/docs/install-messenger

Place this configuration before the asynchronous loader. Replace YOUR_INSTALLATION_UUID with your installation ID. The installation ID is public; the signing key is private and must not be included.

```html
<script>
window.summerMessengerConfig = {
  installationId: "YOUR_INSTALLATION_UUID"
};
</script>
<script src="https://gosummer.ai/messenger/v1/loader.js" async></script>
```

--------------------------------

### Check Messenger Installation

Source: https://gosummer.ai/docs/agent-setup

Tests a Messenger installation locally with synthetic accounts, including guest use, sign-in, sign-out, account switching, and Content-Security-Policy. A check reported as 'unsupported' has not passed.

```bash
summer messenger check --url <local page> --installation <id> --json
```

--------------------------------

### 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
```

--------------------------------

### Save Custom Capability Definition

Source: https://gosummer.ai/docs/agent-setup

Creates a definition file for a custom capability. The file has 'id' (starting 'custom_'), 'title', 'group', 'mode' ('read' or 'approval'), 'expectation', 'test', and 'examples' (optional discovery hints, use empty string if none). Save with expected-version 0.

```bash
summer capability-checks save ID --from-file definition.json --expected-version 0 --reason TEXT --company YOUR_COMPANY_ID --environment staging --json
```

--------------------------------

### PATCH /v1/companies/{company}/environments/{environment}/messenger/installations/{installation}

Source: https://gosummer.ai/docs/api-reference

Updates installation settings with the expected version for optimistic concurrency. The signing key is preserved.

```APIDOC
## PATCH /v1/companies/{company}/environments/{environment}/messenger/installations/{installation}

### Description
Updates installation settings with the expected version for optimistic concurrency. The signing key is preserved.

### 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. Production enable needs messaging.activate.
- **settings.guests_enabled** (boolean) - Required
- **settings.display_name** (string) - Required - At most 80 characters.
- **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.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
```

--------------------------------

### POST /v1/companies/{company}/environments/{environment}/messenger/installations/{installation}/rotate-key

Source: https://gosummer.ai/docs/api-reference

Issues a new signing key for the installation. Existing signed sessions end. The key is delivered to the trusted local helper only.

```APIDOC
## POST /v1/companies/{company}/environments/{environment}/messenger/installations/{installation}/rotate-key

### Description
Issues a new signing key for the installation. Existing signed sessions end. The key is delivered to the trusted local helper only.

### Method
POST

### Endpoint
/v1/companies/{company}/environments/{environment}/messenger/installations/{installation}/rotate-key

### 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

### Access
`setup` (owner or admin)

### Applies to
one environment

### MCP
`summer_messenger_installations_rotate_key` returns a local CLI command instead of moving a secret

### Idempotency-Key
required
```

--------------------------------

### GET /v1/companies/{company}/knowledge/{document}

Source: https://gosummer.ai/docs/api-reference

Reads one company knowledge document and its current revision. Requires setup access.

```APIDOC
## GET /v1/companies/{company}/knowledge/{document}

### Description
Read one company knowledge document and its current revision.

### Method
GET

### Endpoint
/v1/companies/{company}/knowledge/{document}

### Parameters
#### Path Parameters
- **company** (UUID) - Required - Summer company ID
- **document** (string) - Required - Knowledge document ID At most 120 characters.

### Response
#### Success Response (200)
- **document** (object) - The knowledge document with current revision

#### Response Example
{
  "document": {}
}
```

--------------------------------

### 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 delivered to a trusted local helper, not to model-visible output. Requires an Idempotency-Key.

```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 delivered to a trusted local helper, not to model-visible output. Requires an Idempotency-Key.

### 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.enabled** (boolean) - Required - Live widget. Production enable needs messaging.activate.
- **settings.guests_enabled** (boolean) - Required
- **settings.display_name** (string) - Required - At most 80 characters.
- **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.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_create` returns a local CLI command instead of moving a secret

### Idempotency-Key
required
```

--------------------------------

### GET /v1/companies/{company}/knowledge/{document}/history

Source: https://gosummer.ai/docs/api-reference

Reads the edit history of a company knowledge document. Requires setup access.

```APIDOC
## GET /v1/companies/{company}/knowledge/{document}/history

### Description
Read the edit history of a company knowledge document.

### Method
GET

### Endpoint
/v1/companies/{company}/knowledge/{document}/history

### Parameters
#### Path Parameters
- **company** (UUID) - Required - Summer company ID
- **document** (string) - Required - Knowledge document ID At most 120 characters.

#### Query Parameters
- **offset** (integer) - Optional - 

### Response
#### Success Response (200)
- **history** (array) - List of revisions

#### Response Example
{
  "history": []
}
```

--------------------------------

### window.SummerMessenger.boot(config)

Source: https://gosummer.ai/docs/verified-identity

Boots the widget with the given configuration. Used to show a visitor widget after logout.

```APIDOC
## window.SummerMessenger.boot(config)

### Description
Boots the widget with the provided configuration. This is used to show a visitor widget after logout, if allowed.

### Method
N/A (JavaScript API method)

### Endpoint
N/A

### Parameters
#### Parameters
- **config** (object) - Required - The widget configuration object, typically `window.summerMessengerConfig`.

### Request Example
```javascript
window.SummerMessenger.boot(window.summerMessengerConfig);
```

### Response
No specific return value documented.

### Notes
- Only call this if your installation allows visitors.
- Do not call `refreshIdentity()` after `shutdown()`; instead, use `boot()` to reinitialize.
```

--------------------------------

### Verify Configured Connections

Source: https://gosummer.ai/docs/agent-setup

Runs verification for configured connections in the staging environment. Use this to confirm the connections are working as expected.

```bash
summer verify --company YOUR_COMPANY_ID --environment staging --json
```

--------------------------------

### GET /v1/companies/{company}/knowledge

Source: https://gosummer.ai/docs/api-reference

Lists the current company knowledge documents. Knowledge is company-wide and applies to every environment. Requires setup access.

```APIDOC
## GET /v1/companies/{company}/knowledge

### Description
List current company knowledge documents. Knowledge is company-wide, not per environment.

### Method
GET

### Endpoint
/v1/companies/{company}/knowledge

### Parameters
#### Path Parameters
- **company** (UUID) - Required - Summer company ID

#### Query Parameters
- **query** (string) - Optional - At most 200 characters.
- **offset** (integer) - Optional - 

### Response
#### Success Response (200)
- **documents** (array) - List of knowledge documents

#### Response Example
{
  "documents": []
}
```

--------------------------------

### JWT payload for authenticated response

Source: https://gosummer.ai/docs/verified-identity

The JWT payload includes issuer, audience, installation ID, identity namespace, subject, session reference, expiry, parent origin, frame nonce, and timestamps. The timestamps are examples; generate current Unix timestamps in seconds: iat is now, exp is now plus 60 seconds, and host_session_expires_at comes from your actual login. Use a cryptographic random UUID for each jti. sub must be a stable opaque account ID (1-256 characters), host_session_ref is a lowercase SHA-256 hex digest of installation ID and session ID, and parent_origin must exactly match an allowed website origin. Validate the browser's nonce against ^[A-Za-z0-9_-]{32,128}$ before signing.

```json
{
  "iss": "summer-installation:YOUR_INSTALLATION_UUID",
  "aud": "summer-messenger:customer-session:v1",
  "installation_id": "YOUR_INSTALLATION_UUID",
  "identity_namespace": "host-account",
  "sub": "YOUR_STABLE_ACCOUNT_ID",
  "host_session_ref": "SHA256_OF_INSTALLATION_AND_SESSION_ID",
  "host_session_expires_at": 1792458000,
  "parent_origin": "https://www.example.com",
  "frame_nonce": "THE_NONCE_FROM_THE_WIDGET",
  "iat": 1792454400,
  "exp": 1792454460,
  "jti": "A_FRESH_RANDOM_UUID"
}
```

--------------------------------

### 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.

```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. A pass needs evidence and a discovery path. 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": {
    "id": "example",
    "state": "passed"
  }
}
```

--------------------------------

### Upload Additional Guidance

Source: https://gosummer.ai/docs/agent-setup

Uploads additional guidance as a knowledge document. Use this to provide extra instructions or context for the agent.

```bash
summer knowledge create ID --from-file guide.md --path company/guide.md --reason TEXT --company YOUR_COMPANY_ID --json
```

--------------------------------

### GET /v1/companies/{company}/environments/{environment}/cases/{case}/attachments/{attachment}

Source: https://gosummer.ai/docs/api-reference

Get a short-lived download for an attachment that belongs to this case.

```APIDOC
## GET /v1/companies/{company}/environments/{environment}/cases/{case}/attachments/{attachment}

### Description
Get a short-lived download for an attachment that belongs to this case.

### Method
GET

### Endpoint
/v1/companies/{company}/environments/{environment}/cases/{case}/attachments/{attachment}

### Parameters
#### Path Parameters
- **company** (UUID) - Required - Summer company ID
- **environment** (`staging`, `production`) - Required - Environment that owns the resource
- **case** (UUID) - Required - 
- **attachment** (UUID) - Required - 

### Access
- `cases.read`

### Applies to
- one environment

### MCP
- `summer_cases_attachment`
```

--------------------------------

### Sign In with summer login

Source: https://gosummer.ai/docs/agent-setup

Run after doctor check to sign in with setup scope. Approve the connection in your browser. Use --json for structured output.

```bash
summer login --scope setup --json
```

--------------------------------

### POST /v1/companies/{company}/environments/{environment}/cases/{case}/actions/prepare

Source: https://gosummer.ai/docs/api-reference

Prepare the exact work in the current saved plan for human approval in Summer. Does not approve or execute.

```APIDOC
## POST /v1/companies/{company}/environments/{environment}/cases/{case}/actions/prepare

### Description
Prepare the exact work in the current saved plan for human approval in Summer. Does not approve or execute.

### Method
POST

### Endpoint
/v1/companies/{company}/environments/{environment}/cases/{case}/actions/prepare

### Parameters
#### Path Parameters
- **company** (UUID) - Required - Summer company ID
- **environment** (`staging`, `production`) - Required - Environment that owns the resource
- **case** (UUID) - Required - 

#### Request Body
- **plan_request_id** (UUID) - Required - 

### Access
- `actions.prepare`

### Applies to
- one environment

### MCP
- `summer_actions_prepare`

### Idempotency-Key
- required
```

--------------------------------

### Setup prompt for AI agent

Source: https://gosummer.ai/docs/agent-setup

A prompt to give to a coding agent to set up Summer in a project. It includes Summer API details, CLI usage, and steps for configuration. The prompt instructs the agent to use Summer's API, CLI, or MCP, and to keep credentials separate.

```markdown
# Set up Summer in this project

Onboard this business to Summer, our support and operations platform. Work in this repository with the company knowledge and tools I have authorized you to use. Use Summer's own API, CLI or MCP to configure Summer. Use this business's authorized systems to understand its workflows and test operational paths. Keep each service's credentials separate; Summer sign-in tokens are only for Summer.

Your goal is to make Summer useful for this business's actual support cases. A capability is fulfilled when Summer can discover and use a working path: API, browser, current knowledge lookup, another connected tool or a combination. Tool names are hints. Identify gaps, complete the setup you can, test the result and leave precise blockers for the rest.

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 <command>`. The steps below write this as `summer <command>`. 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.

## 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 my approval; do not try to complete sign-in or consent yourself. If the result says access is pending, stop and tell me.
3. Read `summer capabilities --company YOUR_COMPANY_ID --environment staging --json`, `summer status --company YOUR_COMPANY_ID --environment staging --json` and `summer capability-checks list --company YOUR_COMPANY_ID --environment staging --json`. `operational_readiness` is the same checklist shown in Company setup → What Summer can do. Read each expectation, concrete test, prior evidence and discovery hints. Treat unavailable permissions as real. A missing named provider tool can have an available browser or knowledge alternative; discover and test those within your authority.
4. Match each checklist gap to useful setup work. Write a non-secret `summer.setup.json` with the company settings, Messenger installation (when needed), selected credential environment-variable names and knowledge files to create or edit. Each knowledge entry has `id`, `file` and `reason`; a new document can also set `path` under `company/` and `tags`. Reuse current documents rather than duplicate policies. Upload current policies, workflow guides, escalation contacts and discovery instructions that Summer needs. Explain original sources and known gaps. Keep unrelated files and existing setup; set `replace: true` on credentials only if I ask.
5. Run `summer setup plan --file summer.setup.json --out summer.plan.json --json` and show me the plan summary. Company settings and knowledge are company-wide: an edit there affects every environment, including production. Tell me before applying such a step.
```
Tokens:
Raw