---
canonical_url: "https://docs.composio.dev/toolkits/jam"
markdown_url: "https://docs.composio.dev/toolkits/jam.md"
product: "platform"
version: null
last_updated: null
---

# Jam

Jam helps teams capture, inspect, organize, and collaborate on browser bug reports and recordings through its hosted MCP API.

- **Category:** model context protocol
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 16
- **Triggers:** 0
- **Slug:** `JAM`
- **Version:** 00000000_00

## Tools

### Analyze Jam Video

**Slug:** `JAM_ANALYZE_VIDEO`

Extract structured user goals, reported issues, feedback, visual observations, interactions, and technical indicators from a video Jam.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jam_id` | string | Yes | Video Jam UUID or jam.dev URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Console Logs

**Slug:** `JAM_GET_CONSOLE_LOGS`

Get captured browser console errors, warnings, information, debug output, and stack traces from a Jam.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Maximum console events to return on this page. |
| `cursor` | number | No | Numeric next_cursor from a previous response. |
| `jam_id` | string | Yes | Jam UUID or jam.dev URL. |
| `log_levels` | array | No | Log levels to include, such as ['error', 'warn']. An empty list is a no-op that returns every level. Filtering on 'info' is correct, but Jam reports those rows back with console_level 'log'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Jam Details

**Slug:** `JAM_GET_JAM_DETAILS`

Get the core details and debugging context for a Jam. Call this first before requesting logs, events, screenshots, frames, or transcripts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jam_id` | string | Yes | Jam UUID or jam.dev URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Jam Metadata

**Slug:** `JAM_GET_JAM_METADATA`

Get custom application debugging context attached through the jam.metadata() SDK, such as user IDs, versions, and feature flags.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jam_id` | string | Yes | Jam UUID or jam.dev URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Network Requests

**Slug:** `JAM_GET_NETWORK_REQUESTS`

Get captured HTTP requests and WebSocket frames from a Jam, with filters for failures, hosts, methods, content types, and response bodies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `hosts` | array | No | Host substrings to include; values are ORed. |
| `limit` | number | No | Maximum matching events to return on this page. |
| `bodies` | string ("errors" | "all") | No | Return response bodies only for failures, or for all requests; bodies are truncated upstream to 4 KB each. |
| `cursor` | number | No | Numeric next_cursor from a previous response. |
| `jam_id` | string | Yes | Jam UUID or jam.dev URL. |
| `methods` | array | No | HTTP methods to include, such as ['POST', 'PUT', 'PATCH', 'DELETE']. |
| `status_codes` | array | No | Status codes or classes to include, such as ['500'] or ['4xx', '5xx']; values are ORed. |
| `content_types` | array | No | Content-type substrings to include; values are ORed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Recording Link

**Slug:** `JAM_GET_RECORDING_LINK`

Get one Recording Link's settings and submitted-Jam count by public ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `public_id` | string | Yes | Recording Link public ID from List Recording Links. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Jam Screenshots

**Slug:** `JAM_GET_SCREENSHOTS`

Get screenshots and image attachments from a screenshot-type Jam for visual inspection.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jam_id` | string | Yes | Screenshot-type Jam UUID or jam.dev URL; use Get Jam Details to confirm the type first. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Events

**Slug:** `JAM_GET_USER_EVENTS`

Get the chronological user interaction timeline from a Jam, including clicks, inputs, submissions, navigation, and scrolling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Optional cap on timeline events; omit to request the full normally-small timeline. |
| `cursor` | number | No | Numeric next_cursor from a capped previous response. |
| `jam_id` | string | Yes | Jam UUID or jam.dev URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Jam Video Frames

**Slug:** `JAM_GET_VIDEO_FRAMES`

Get still frames from a video Jam as an overview grid, exact timestamps, or an evenly sampled time window. Exactly one of those three modes is required: set overview=true, timestamps_ms, or from_ms with to_ms and count.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | string ("small" | "medium" | "large") | No | Individual frame height: small is 360p, medium is 720p, and large is 1080p. This does not affect overview grids. |
| `count` | integer | No | Number of evenly spaced frames in the window (1-30); requires from_ms and to_ms. |
| `to_ms` | integer | No | Window end in milliseconds; requires from_ms and count. |
| `jam_id` | string | Yes | Video Jam UUID or jam.dev URL. |
| `from_ms` | integer | No | Window start in milliseconds; requires to_ms and count. |
| `overview` | boolean | No | Set true for one timestamp-labeled overview grid. Use instead of timestamps or a time window. |
| `timestamps_ms` | array | No | One to 30 exact non-negative timestamps in milliseconds. Use instead of overview or a time window. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Jam Video Transcript

**Slug:** `JAM_GET_VIDEO_TRANSCRIPT`

Get the timestamped WebVTT speech transcript from a microphone-enabled video Jam when available; otherwise return Jam's explanation that it is pending or unavailable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jam_id` | string | Yes | Video Jam UUID or jam.dev URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Jam Folders

**Slug:** `JAM_LIST_FOLDERS`

Browse or search one page of workspace folders and return their IDs, names, Jam counts, and timestamps; pass next_cursor as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum folders on this page (1-250). |
| `query` | string | No | Folder name search text. |
| `cursor` | string | No | next_cursor from the previous List Jam Folders response. |
| `order_by` | string ("createdAt" | "updatedAt") | No | Timestamp field used to order results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Jams

**Slug:** `JAM_LIST_JAMS`

Search and browse workspace Jams by text, type, folder, author, source URL, or creation date. Returns one page; pass next_cursor as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Case-insensitive partial match on the original page URL. |
| `limit` | integer | No | Maximum Jams on this page (1-250). |
| `query` | string | No | Text to match in Jam titles or descriptions (max 200 characters). |
| `author` | string | No | Author as 'me', name, email, or user ID. |
| `cursor` | string | No | Jam ID cursor from the previous page. |
| `folder` | string | No | Folder name, ID, short ID, or 'root' for unfiled Jams. |
| `jam_type` | string ("video" | "screenshot" | "replay") | No | Only return this Jam type. |
| `order_by` | string ("createdAt" | "updatedAt") | No | Timestamp field used to order results. |
| `created_at` | string | No | ISO date or ISO 8601 relative duration, such as -P7D for the last seven days. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Jam Members

**Slug:** `JAM_LIST_MEMBERS`

Browse or search one page of workspace members by name or email for author discovery and attribution; pass next_cursor as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum users on this page (1-250). |
| `query` | string | No | Member name or email search text. |
| `cursor` | string | No | next_cursor from the previous List Jam Members response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Recording Domains

**Slug:** `JAM_LIST_RECORDING_DOMAINS`

List the workspace's connected recording domains and whether each is verified to capture console and network logs.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Recording Link Jams

**Slug:** `JAM_LIST_RECORDING_LINK_JAMS`

List Jams submitted through one Recording Link, newest first. Returns one page; pass next_cursor as cursor to continue when has_more is true.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum submitted Jams on this page (1-100). |
| `cursor` | string | No | Jam-ID cursor from the prior page's next_cursor. |
| `public_id` | string | Yes | Recording Link public ID from List Recording Links. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Recording Links

**Slug:** `JAM_LIST_RECORDING_LINKS`

List workspace Recording Links newest first, optionally including revoked links. Returns one page; when has_more is true, pass next_cursor as cursor to continue.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum links on this page (1-100). |
| `cursor` | string | No | Public-ID next_cursor from the previous List Recording Links response. |
| `include_revoked` | boolean | No | Include revoked Recording Links. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |