> ## Documentation Index > Fetch the complete documentation index at: https://docs.mcpjam.com/llms.txt > Use this file to discover all available pages before exploring further. # Search or list unified sessions > The unified, cross-surface sessions feed for one project: Playground, user-testing, eval, and swarm transcripts in one list, newest first. Project-NESTED (unlike `/chat-sessions`) because `projectId` owns the scope here rather than filtering it. Supplying `q` at all switches to relevance-ordered search; `scope` then chooses what is searched. Row-level visibility applies in every mode: a caller never receives another member's private Playground session. The response echoes the honored `scope`. A deployment predating that parameter omits the echo — clients requesting a non-default scope MUST treat its absence as "unsupported" rather than accepting the results. ## OpenAPI ````yaml /reference/openapi.json get /projects/{projectId}/sessions openapi: 3.1.0 info: title: MCPJam API version: 1.0.0-preview description: >- Programmatic access to MCP servers saved in your MCPJam projects — live diagnostics (validate, inspect, export) and operations: call tools, render prompts, run eval suites asynchronously and poll their results, and import OAuth tokens. **The API is in preview**: the surface may change while we finish the design. Error `code` values are stable; error `message` strings are not. Write clients that ignore unknown response fields. contact: name: MCPJam url: https://github.com/MCPJam/inspector/issues servers: - url: https://app.mcpjam.com/api/v1 description: Hosted MCPJam security: - bearerAuth: [] tags: - name: Hosts description: >- Project hosts: named model + capability profiles you run chats and eval suites against. - name: Environments description: >- Project environments: named, live-editable execution bundles (one host, an optional standalone server group, optionally pinned skills and plugin versions) that eval suites and journeys run against. Distinct from Sandbox images, which are Computer base images. Reads require project membership; every write requires project admin. - name: Plugins description: >- Agent Plugins imported into a project — read-only inventory and version detail. - name: Sandbox images description: >- Custom Computer images: a digest-pinned Dockerfile built into an immutable image your project's computers boot from. - name: Server diagnostics description: Connect-level health checks against a saved MCP server. - name: Primitives description: 'The server''s MCP primitives: tools, prompts, and resources.' - name: Export description: Full-server snapshots for diffing and CI. - name: Execution description: 'Run the server''s primitives: call tools, render prompts.' - name: Eval runs description: >- Asynchronous eval suite runs: create with 202, poll status, iterations, and traces. - name: Server connections description: >- Connect an MCP server URL to a project, authorizing in a browser when the server requires it. - name: OAuth description: 'Bring-your-own OAuth: import externally obtained tokens for a server.' - name: Chatboxes description: >- Read-only access to the chatboxes published from a project: listing, settings, attached servers, and share links. - name: Catalog description: >- Discover the resources the other routes operate on: your account, projects, servers, eval suites, and chat sessions. - name: Tunnels description: >- Relay tunnels that expose local MCP servers through a public URL, registered as first-class project servers (the `mcpjam tunnel` CLI flow). - name: Agent description: >- Headless agent turns over the public API: send a message history, the server runs one assistant turn with project-scoped workspace tools (eval reads + suite creation) on a pinned hosted model, and returns the reply plus created-resource references. - name: Swarms description: >- Personas, journeys and swarm containers — the authoring half of Swarms — plus the model-backed generation that drafts them. - name: Swarm runs description: >- Launching journeys and reading what they produced. Launching SPENDS — see the per-operation notes. - name: Swarm insights description: >- What a swarm run revealed. The scorecard and findings are deterministic and free; requesting wave insights runs models and draws on your shared daily ledger. - name: User testing description: >- Publishing an environment for real visitors, and controlling who can reach it. Several of these NARROW access and take effect immediately. paths: /projects/{projectId}/sessions: get: tags: - Catalog summary: Search or list unified sessions description: >- The unified, cross-surface sessions feed for one project: Playground, user-testing, eval, and swarm transcripts in one list, newest first. Project-NESTED (unlike `/chat-sessions`) because `projectId` owns the scope here rather than filtering it. Supplying `q` at all switches to relevance-ordered search; `scope` then chooses what is searched. Row-level visibility applies in every mode: a caller never receives another member's private Playground session. The response echoes the honored `scope`. A deployment predating that parameter omits the echo — clients requesting a non-default scope MUST treat its absence as "unsupported" rather than accepting the results. operationId: listSessions parameters: - $ref: '#/components/parameters/projectId' - name: q in: query required: false description: >- Search terms. Supplying this at all switches from the recency feed to relevance-ordered search; `q=` (blank) is an empty search, not "no filter". schema: type: string - name: scope in: query required: false description: >- What to search. `titles` (default) matches titles and opening messages; `transcripts` matches conversation content. Requires `q`; an unknown value is a 400. schema: type: string enum: - titles - transcripts default: titles - name: sourceType in: query required: false description: >- Comma-separated surfaces to include: `direct`, `chatbox`, `eval`, `swarm`. Omit for all. An unknown value is a 400 rather than a silent widening. schema: type: string - name: status in: query required: false description: '`active` (default) or `archived`.' schema: type: string enum: - active - archived default: active - name: limit in: query required: false description: Page size, 1–200. Defaults to 50. schema: type: integer minimum: 1 maximum: 200 default: 50 - name: cursor in: query required: false description: >- Opaque cursor: echo back the previous page's `nextCursor`. Never construct one, and never assume it encodes a timestamp. Cursors do not cross scopes — page with the parameters you opened with. schema: type: string responses: '200': description: >- One page of sessions — newest first when listing, most relevant first when searching. content: application/json: schema: $ref: '#/components/schemas/SessionSummaryPage' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' '502': $ref: '#/components/responses/ServerUnreachable' components: parameters: projectId: name: projectId in: path required: true description: ID of the hosted project that contains the server. schema: type: string schemas: SessionSummaryPage: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/SessionSummary' nextCursor: type: string description: Pass as `cursor` to fetch the next page. Omitted on the last page. scope: type: string enum: - titles - transcripts description: >- The scope the server actually honored. ABSENT from deployments predating the parameter — treat its absence as "transcript search unsupported". SessionSummary: type: object required: - id - chatSessionId - projectId - sourceType - origin - status - synthetic - lockReason - title - firstMessagePreview - visibility - ownedByViewer - startedAt - lastActivityAt - modelId - messageCount - parentRef - link properties: id: type: string chatSessionId: type: string description: Wire id used by the Playground restore; distinct from `id`. projectId: type: string nullable: true sourceType: type: string enum: - direct - chatbox - eval - swarm origin: type: string nullable: true status: type: string synthetic: type: boolean lockReason: type: string nullable: true title: type: string nullable: true firstMessagePreview: type: string visibility: type: string nullable: true description: 'Direct sessions only: `private` or `project`. Null elsewhere.' ownedByViewer: type: boolean startedAt: type: integer lastActivityAt: type: integer modelId: type: string nullable: true messageCount: type: integer cumulativeUserMessageCount: type: integer description: Absent (not 0) when the session never reported the counter. cumulativeToolCallCount: type: integer cumulativeInputTokens: type: integer cumulativeOutputTokens: type: integer parentRef: allOf: - $ref: '#/components/schemas/SessionParentRef' nullable: true link: $ref: '#/components/schemas/SessionLink' matchPreview: type: string nullable: true description: >- `scope=transcripts` only: a window of the transcript around the match. Null when no window could be located; absent entirely on title-scope results. Error: type: object required: - code - message properties: code: type: string description: >- Stable, machine-readable error code. New codes may be added over time; treat unknown codes as non-retryable failures unless the HTTP status says otherwise. enum: - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - CONFLICT - VALIDATION_ERROR - RATE_LIMITED - FEATURE_NOT_SUPPORTED - SERVER_UNREACHABLE - TIMEOUT - OAUTH_REQUIRED - INTERNAL_ERROR message: type: string description: >- Human-readable description. May change between releases — don't match on it. details: type: object description: Optional, unstructured context bag. additionalProperties: true SessionParentRef: type: object required: - kind - label description: >- The session's parent run, discriminated on `kind`. Additive: switch on `kind` and tolerate an unknown value. properties: kind: type: string enum: - evalRun - journeyRun - chatbox label: type: string nullable: true description: Human-readable parent name; null when the parent row is gone. iterationId: type: string suiteRunId: type: string nullable: true description: eval only; null means Quick Run (no suite run exists). suiteId: type: string nullable: true journeyRunId: type: string journeyRefId: type: string nullable: true chatboxId: type: string SessionLink: type: object required: - path - url description: >- Where a human goes to read this session. Prefers the surface-native page; falls back to `/sessions?session=` when the session has none (an eval Quick Run, or a deleted parent run). properties: path: type: string description: App-relative path, including `?project=`. url: type: string description: Absolute URL for the same target. responses: ValidationError: description: Malformed body or parameters. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: VALIDATION_ERROR message: Invalid JSON body Unauthorized: description: >- Missing, invalid, revoked, or orphaned key (`UNAUTHORIZED`) — or the **target MCP server** needs an OAuth grant (`OAUTH_REQUIRED`), which is a property of the server, not your key. content: application/json: schema: $ref: '#/components/schemas/Error' examples: badKey: summary: Invalid or revoked key value: code: UNAUTHORIZED message: Invalid API key oauthRequired: summary: Target server needs an OAuth grant value: code: OAUTH_REQUIRED message: Server requires OAuth authorization Forbidden: description: Key is valid but not allowed to do this. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: FORBIDDEN message: You do not have access to this project NotFound: description: Unknown project, server, or resource. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: NOT_FOUND message: Server not found RateLimited: description: >- Per-key rate limit exceeded (60 requests/minute sustained, bursts up to 10). Honor `Retry-After` and back off with jitter. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/Error' example: code: RATE_LIMITED message: API key rate limit exceeded. Slow down and retry. InternalError: description: Something failed on MCPJam's side. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: INTERNAL_ERROR message: Unexpected internal error ServerUnreachable: description: Could not connect to the target MCP server. content: application/json: schema: $ref: '#/components/schemas/Error' example: code: SERVER_UNREACHABLE message: Failed to connect to server securitySchemes: bearerAuth: type: http scheme: bearer description: >- MCPJam API key (`sk_…`). Create one at [Settings → API keys](https://app.mcpjam.com/settings/api-keys). Guest sessions cannot use the API, and API keys cannot manage other API keys. ````