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

# Create a journey

> Creates one journey: a persona pursuing a `goal` against one or more environments. To draft several with a model first, use `POST /projects/{projectId}/journeys/generate` — that route persists nothing.

`personaId` and `swarmId` must belong to THIS project. Naming one from another project is a `404`, not a silent cross-project reference.

Creating a journey does not run it. Launch it with `POST /projects/{projectId}/journeys/{journeyId}/runs`.



## OpenAPI

````yaml /reference/openapi.json post /projects/{projectId}/journeys
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:
    parameters:
      - $ref: '#/components/parameters/projectId'
    post:
      tags:
        - Swarms
      summary: Create a journey
      description: >-
        Creates one journey: a persona pursuing a `goal` against one or more
        environments. To draft several with a model first, use `POST
        /projects/{projectId}/journeys/generate` — that route persists nothing.


        `personaId` and `swarmId` must belong to THIS project. Naming one from
        another project is a `404`, not a silent cross-project reference.


        Creating a journey does not run it. Launch it with `POST
        /projects/{projectId}/journeys/{journeyId}/runs`.
      operationId: createJourney
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            Retry-safe create key. Replaying the SAME key with the SAME body
            returns the original resource instead of creating a second one;
            reusing it with a DIFFERENT body is a 409.
          schema:
            type: string
      requestBody:
        required: true
        description: The journey to create.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JourneyCreateRequest'
      responses:
        '201':
          description: The created journey.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Journey'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '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:
    JourneyCreateRequest:
      type: object
      required:
        - goal
        - personaId
        - sessionsPerTarget
        - maxTurns
      additionalProperties: false
      properties:
        name:
          type: string
          maxLength: 200
        goal:
          type: string
          maxLength: 4000
          description: 1–4000 characters.
        personaId:
          type: string
          description: An existing persona in this project.
        swarmId:
          type: string
          description: Authoring provenance only — which swarm container this was made in.
        environmentIds:
          type: array
          items:
            type: string
          minItems: 1
          description: >-
            The environments to fan out across. NON-EMPTY when present: `[]`
            reads as "these, naming none", and would silently fall back to
            something else.
        serverAttachmentId:
          type: string
          description: Legacy host-pinned grounding.
        hostIds:
          type: array
          items:
            type: string
        sessionsPerTarget:
          type: integer
          minimum: 1
          maximum: 100
        maxTurns:
          type: integer
          minimum: 1
          maximum: 200
    Journey:
      type: object
      description: >-
        A persona's task: what they are trying to accomplish, and across which
        targets. Launching one is `POST
        /projects/{projectId}/journeys/{journeyId}/runs`.
      required:
        - id
        - projectId
        - name
        - goal
        - personaId
        - swarmId
        - environmentIds
        - sessionsPerTarget
        - maxTurns
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
        projectId:
          type: string
        name:
          type: string
        goal:
          type: string
          description: What the persona is trying to accomplish. This drives the whole run.
        personaId:
          type: string
        swarmId:
          type:
            - string
            - 'null'
          description: >-
            The swarm container this journey was authored under. Provenance only
            — nothing resolves through it at run time, and a journey created
            outside a swarm has none.
        environmentIds:
          type: array
          items:
            type: string
          description: >-
            Environments this journey fans out across. EMPTY on a host-pinned
            journey — that is a different execution model, not a journey with no
            targets.
        serverAttachmentId:
          type: string
          description: >-
            Legacy host-pinned grounding. Absent on an environment-based
            journey.
        sessionsPerTarget:
          type:
            - integer
            - 'null'
          description: Sessions run against EACH target. Total sessions = targets × this.
        maxTurns:
          type:
            - integer
            - 'null'
        createdAt:
          type: number
          description: Epoch milliseconds.
        updatedAt:
          type: number
          description: Epoch milliseconds.
    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
    Conflict:
      description: >-
        The resource is not in a state that accepts this write — a stale
        `expectedRevision`, a duplicate name, or an environment that cannot
        currently be launched. The request was well-formed; re-read the resource
        and retry.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: CONFLICT
            message: >-
              Environment changed since you loaded it (expected revision 3,
              current 5). Reload and retry.
    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.

````