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

# Draft journeys for a persona

> Returns DRAFTS and persists nothing — see `POST /projects/{projectId}/personas/generate` for why, and for what this spends.



## OpenAPI

````yaml /reference/openapi.json post /projects/{projectId}/journeys/generate
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}/journeys/generate:
    parameters:
      - $ref: '#/components/parameters/projectId'
    post:
      tags:
        - Swarms
      summary: Draft journeys for a persona
      description: >-
        Returns DRAFTS and persists nothing — see `POST
        /projects/{projectId}/personas/generate` for why, and for what this
        spends.
      operationId: generateJourneys
      requestBody:
        required: true
        description: Grounding source and the persona to draft for.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JourneyGenerateRequest'
      responses:
        '200':
          description: Draft journeys.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerationDrafts'
        '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'
components:
  parameters:
    projectId:
      name: projectId
      in: path
      required: true
      description: ID of the hosted project that contains the server.
      schema:
        type: string
  schemas:
    JourneyGenerateRequest:
      type: object
      description: >-
        Exactly ONE grounding source: `serverAttachmentId` or `environmentId`.
        Sending both is a 400 — a request that is already confused about what it
        wants should not have a winner picked for it.
      required:
        - persona
      additionalProperties: false
      properties:
        serverAttachmentId:
          type: string
        environmentId:
          type: string
        journeyCount:
          type: integer
        persona:
          type: object
          description: >-
            The persona to draft journeys FOR, passed BY VALUE rather than by
            id. Not an oversight: the create flow drafts a persona and its
            journeys before either exists, so requiring a persisted persona
            would force you to save a draft you may discard.
          required:
            - name
            - role
          properties:
            name:
              type: string
            role:
              type: string
            notes:
              type: string
        description:
          type: string
          maxLength: 2000
    GenerationDrafts:
      type: object
      description: >-
        DRAFTS. Nothing here is persisted — feed what you want to keep to `POST
        /projects/{projectId}/personas` or `POST
        /projects/{projectId}/journeys`.


        The shape depends on the request: `POST /personas/generate` returns
        `{persona, journeys}` without `personaCount` and `{personas: [{persona,
        journeys}]}` with it; `POST /journeys/generate` returns `{journeys}`.
      additionalProperties: true
      properties:
        persona:
          $ref: '#/components/schemas/PersonaDraft'
        personas:
          type: array
          items:
            type: object
            properties:
              persona:
                $ref: '#/components/schemas/PersonaDraft'
              journeys:
                type: array
                items:
                  $ref: '#/components/schemas/JourneyDraft'
        journeys:
          type: array
          items:
            $ref: '#/components/schemas/JourneyDraft'
    PersonaDraft:
      type: object
      description: A generated persona draft. Nothing is persisted until you create it.
      required:
        - name
        - role
      additionalProperties: true
      properties:
        name:
          type: string
        role:
          type: string
        notes:
          type: string
    JourneyDraft:
      type: object
      required:
        - goal
      additionalProperties: true
      properties:
        name:
          type: string
        goal:
          type: string
        suggestedChecks:
          type: array
          description: >-
            Deterministic checks the backend suggests. Only
            `toolCalledAtLeastOnce` is ever suggested — it is the one kind whose
            validity the grounding snapshot can prove, because the tool provably
            exists.
          items:
            type: object
            required:
              - type
              - toolName
            properties:
              type:
                type: string
                enum:
                  - toolCalledAtLeastOnce
              toolName:
                type: string
    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
  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
  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.

````