Create a journey

POST

projects

{projectId}

goals

Create a journey

curl --request POST \
  --url https://app.mcpjam.com/api/v1/projects/{projectId}/goals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "goal": "<string>",
  "personaId": "<string>",
  "iterations": 50,
  "maxTurns": 100,
  "name": "<string>",
  "swarmId": "<string>",
  "environmentIds": [
    "<string>"
  ],
  "serverAttachmentId": "<string>",
  "hostIds": [
    "<string>"
  ],
  "judge": {
    "enabled": true,
    "autoRun": true,
    "model": "<string>",
    "modelSelection": {
      "modelId": "<string>",
      "fallback": {
        "model": "none"
      },
      "nativeModelId": "<string>",
      "settings": {
        "temperature": 1
      }
    },
    "modelSelectionOrigin": "backfill",
    "threshold": 0.5
  }
}
'

import requests

url = "https://app.mcpjam.com/api/v1/projects/{projectId}/goals"

payload = {
    "goal": "<string>",
    "personaId": "<string>",
    "iterations": 50,
    "maxTurns": 100,
    "name": "<string>",
    "swarmId": "<string>",
    "environmentIds": ["<string>"],
    "serverAttachmentId": "<string>",
    "hostIds": ["<string>"],
    "judge": {
        "enabled": True,
        "autoRun": True,
        "model": "<string>",
        "modelSelection": {
            "modelId": "<string>",
            "fallback": { "model": "none" },
            "nativeModelId": "<string>",
            "settings": { "temperature": 1 }
        },
        "modelSelectionOrigin": "backfill",
        "threshold": 0.5
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    goal: '<string>',
    personaId: '<string>',
    iterations: 50,
    maxTurns: 100,
    name: '<string>',
    swarmId: '<string>',
    environmentIds: ['<string>'],
    serverAttachmentId: '<string>',
    hostIds: ['<string>'],
    judge: {
      enabled: true,
      autoRun: true,
      model: '<string>',
      modelSelection: {
        modelId: '<string>',
        fallback: {model: 'none'},
        nativeModelId: '<string>',
        settings: {temperature: 1}
      },
      modelSelectionOrigin: 'backfill',
      threshold: 0.5
    }
  })
};

fetch('https://app.mcpjam.com/api/v1/projects/{projectId}/goals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.mcpjam.com/api/v1/projects/{projectId}/goals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'goal' => '<string>',
    'personaId' => '<string>',
    'iterations' => 50,
    'maxTurns' => 100,
    'name' => '<string>',
    'swarmId' => '<string>',
    'environmentIds' => [
        '<string>'
    ],
    'serverAttachmentId' => '<string>',
    'hostIds' => [
        '<string>'
    ],
    'judge' => [
        'enabled' => true,
        'autoRun' => true,
        'model' => '<string>',
        'modelSelection' => [
                'modelId' => '<string>',
                'fallback' => [
                                'model' => 'none'
                ],
                'nativeModelId' => '<string>',
                'settings' => [
                                'temperature' => 1
                ]
        ],
        'modelSelectionOrigin' => 'backfill',
        'threshold' => 0.5
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.mcpjam.com/api/v1/projects/{projectId}/goals"

	payload := strings.NewReader("{\n  \"goal\": \"<string>\",\n  \"personaId\": \"<string>\",\n  \"iterations\": 50,\n  \"maxTurns\": 100,\n  \"name\": \"<string>\",\n  \"swarmId\": \"<string>\",\n  \"environmentIds\": [\n    \"<string>\"\n  ],\n  \"serverAttachmentId\": \"<string>\",\n  \"hostIds\": [\n    \"<string>\"\n  ],\n  \"judge\": {\n    \"enabled\": true,\n    \"autoRun\": true,\n    \"model\": \"<string>\",\n    \"modelSelection\": {\n      \"modelId\": \"<string>\",\n      \"fallback\": {\n        \"model\": \"none\"\n      },\n      \"nativeModelId\": \"<string>\",\n      \"settings\": {\n        \"temperature\": 1\n      }\n    },\n    \"modelSelectionOrigin\": \"backfill\",\n    \"threshold\": 0.5\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.mcpjam.com/api/v1/projects/{projectId}/goals")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"goal\": \"<string>\",\n  \"personaId\": \"<string>\",\n  \"iterations\": 50,\n  \"maxTurns\": 100,\n  \"name\": \"<string>\",\n  \"swarmId\": \"<string>\",\n  \"environmentIds\": [\n    \"<string>\"\n  ],\n  \"serverAttachmentId\": \"<string>\",\n  \"hostIds\": [\n    \"<string>\"\n  ],\n  \"judge\": {\n    \"enabled\": true,\n    \"autoRun\": true,\n    \"model\": \"<string>\",\n    \"modelSelection\": {\n      \"modelId\": \"<string>\",\n      \"fallback\": {\n        \"model\": \"none\"\n      },\n      \"nativeModelId\": \"<string>\",\n      \"settings\": {\n        \"temperature\": 1\n      }\n    },\n    \"modelSelectionOrigin\": \"backfill\",\n    \"threshold\": 0.5\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.mcpjam.com/api/v1/projects/{projectId}/goals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"goal\": \"<string>\",\n  \"personaId\": \"<string>\",\n  \"iterations\": 50,\n  \"maxTurns\": 100,\n  \"name\": \"<string>\",\n  \"swarmId\": \"<string>\",\n  \"environmentIds\": [\n    \"<string>\"\n  ],\n  \"serverAttachmentId\": \"<string>\",\n  \"hostIds\": [\n    \"<string>\"\n  ],\n  \"judge\": {\n    \"enabled\": true,\n    \"autoRun\": true,\n    \"model\": \"<string>\",\n    \"modelSelection\": {\n      \"modelId\": \"<string>\",\n      \"fallback\": {\n        \"model\": \"none\"\n      },\n      \"nativeModelId\": \"<string>\",\n      \"settings\": {\n        \"temperature\": 1\n      }\n    },\n    \"modelSelectionOrigin\": \"backfill\",\n    \"threshold\": 0.5\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "projectId": "<string>",
  "name": "<string>",
  "goal": "<string>",
  "personaId": "<string>",
  "swarmId": "<string>",
  "environmentIds": [
    "<string>"
  ],
  "iterations": 123,
  "maxTurns": 123,
  "createdAt": 123,
  "updatedAt": 123,
  "serverAttachmentId": "<string>",
  "setupWrites": true,
  "judge": {
    "enabled": true,
    "model": "<string>",
    "autoRun": true,
    "threshold": 0.5,
    "modelSelection": {
      "modelId": "<string>",
      "source": "hosted",
      "fallback": {
        "provider": "none",
        "model": "none"
      },
      "connectionRef": {
        "kind": "orgProvider",
        "id": "<string>",
        "providerKey": "<string>",
        "customProviderName": "<string>"
      },
      "nativeModelId": "<string>",
      "settings": {
        "reasoningEffort": "none",
        "temperature": 1
      }
    },
    "modelSelectionOrigin": "backfill"
  }
}

Authorizations

Authorization

string

header

required

MCPJam API key (sk_…). Create one at Settings → API keys. Guest sessions cannot use the API, and API keys cannot manage other API keys.

Headers

Idempotency-Key

string

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.

Path Parameters

projectId

string

required

ID of the hosted project that contains the server.

Body

application/json

The goal to create.

goal

string

required

1–4000 characters.

Maximum string length: 4000

personaId

string

required

An existing persona in this project.

iterations

integer

required

Required range: 1 <= x <= 100

maxTurns

integer

required

Required range: 1 <= x <= 200

name

string

Maximum string length: 200

swarmId

string

Authoring provenance only — which swarm container this was made in.

environmentIds

string[]

The environments to fan out across. NON-EMPTY when present: [] reads as "these, naming none", and would silently fall back to something else.

Minimum array length: 1

serverAttachmentId

string

Legacy host-pinned grounding.

hostIds

string[]

judge

object

The goal-completion judge. Omit it for the managed defaults: enabled, automatic, the default judge model.

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

Response

The created goal.

A persona's task: what they are trying to accomplish, and across which targets. Launching one is POST /projects/{projectId}/goals/{goalId}/runs.

string

required

projectId

string

required

name

string

required

goal

string

required

What the persona is trying to accomplish. This drives the whole run.

personaId

string

required

swarmId

string | null

required

The swarm container this goal was authored under. Provenance only — nothing resolves through it at run time, and a goal created outside a swarm has none.

environmentIds

string[]

required

Environments this goal fans out across. EMPTY on a host-pinned goal — that is a different execution model, not a goal with no targets.

iterations

integer | null

required

Sessions run against EACH target. Total sessions = targets × this.

maxTurns

integer | null

required

createdAt

number

required

Epoch milliseconds.

updatedAt

number

required

Epoch milliseconds.

serverAttachmentId

string

Legacy host-pinned grounding. Absent on an environment-based goal.

setupWrites

boolean

Whether prerequisite setup may create or modify workspace data before sessions run. Defaults to false.

judge

object

The goal-completion judge that grades each session against the goal, RESOLVED over the managed defaults the way EvalSuiteDetail.settings.judge is — so this is what a run would actually grade with, and what to echo back on a write.

Show child attributes

⌘I

Create a journey

curl --request POST \
  --url https://app.mcpjam.com/api/v1/projects/{projectId}/goals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "goal": "<string>",
  "personaId": "<string>",
  "iterations": 50,
  "maxTurns": 100,
  "name": "<string>",
  "swarmId": "<string>",
  "environmentIds": [
    "<string>"
  ],
  "serverAttachmentId": "<string>",
  "hostIds": [
    "<string>"
  ],
  "judge": {
    "enabled": true,
    "autoRun": true,
    "model": "<string>",
    "modelSelection": {
      "modelId": "<string>",
      "fallback": {
        "model": "none"
      },
      "nativeModelId": "<string>",
      "settings": {
        "temperature": 1
      }
    },
    "modelSelectionOrigin": "backfill",
    "threshold": 0.5
  }
}
'

import requests

url = "https://app.mcpjam.com/api/v1/projects/{projectId}/goals"

payload = {
    "goal": "<string>",
    "personaId": "<string>",
    "iterations": 50,
    "maxTurns": 100,
    "name": "<string>",
    "swarmId": "<string>",
    "environmentIds": ["<string>"],
    "serverAttachmentId": "<string>",
    "hostIds": ["<string>"],
    "judge": {
        "enabled": True,
        "autoRun": True,
        "model": "<string>",
        "modelSelection": {
            "modelId": "<string>",
            "fallback": { "model": "none" },
            "nativeModelId": "<string>",
            "settings": { "temperature": 1 }
        },
        "modelSelectionOrigin": "backfill",
        "threshold": 0.5
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    goal: '<string>',
    personaId: '<string>',
    iterations: 50,
    maxTurns: 100,
    name: '<string>',
    swarmId: '<string>',
    environmentIds: ['<string>'],
    serverAttachmentId: '<string>',
    hostIds: ['<string>'],
    judge: {
      enabled: true,
      autoRun: true,
      model: '<string>',
      modelSelection: {
        modelId: '<string>',
        fallback: {model: 'none'},
        nativeModelId: '<string>',
        settings: {temperature: 1}
      },
      modelSelectionOrigin: 'backfill',
      threshold: 0.5
    }
  })
};

fetch('https://app.mcpjam.com/api/v1/projects/{projectId}/goals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.mcpjam.com/api/v1/projects/{projectId}/goals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'goal' => '<string>',
    'personaId' => '<string>',
    'iterations' => 50,
    'maxTurns' => 100,
    'name' => '<string>',
    'swarmId' => '<string>',
    'environmentIds' => [
        '<string>'
    ],
    'serverAttachmentId' => '<string>',
    'hostIds' => [
        '<string>'
    ],
    'judge' => [
        'enabled' => true,
        'autoRun' => true,
        'model' => '<string>',
        'modelSelection' => [
                'modelId' => '<string>',
                'fallback' => [
                                'model' => 'none'
                ],
                'nativeModelId' => '<string>',
                'settings' => [
                                'temperature' => 1
                ]
        ],
        'modelSelectionOrigin' => 'backfill',
        'threshold' => 0.5
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.mcpjam.com/api/v1/projects/{projectId}/goals"

	payload := strings.NewReader("{\n  \"goal\": \"<string>\",\n  \"personaId\": \"<string>\",\n  \"iterations\": 50,\n  \"maxTurns\": 100,\n  \"name\": \"<string>\",\n  \"swarmId\": \"<string>\",\n  \"environmentIds\": [\n    \"<string>\"\n  ],\n  \"serverAttachmentId\": \"<string>\",\n  \"hostIds\": [\n    \"<string>\"\n  ],\n  \"judge\": {\n    \"enabled\": true,\n    \"autoRun\": true,\n    \"model\": \"<string>\",\n    \"modelSelection\": {\n      \"modelId\": \"<string>\",\n      \"fallback\": {\n        \"model\": \"none\"\n      },\n      \"nativeModelId\": \"<string>\",\n      \"settings\": {\n        \"temperature\": 1\n      }\n    },\n    \"modelSelectionOrigin\": \"backfill\",\n    \"threshold\": 0.5\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.mcpjam.com/api/v1/projects/{projectId}/goals")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"goal\": \"<string>\",\n  \"personaId\": \"<string>\",\n  \"iterations\": 50,\n  \"maxTurns\": 100,\n  \"name\": \"<string>\",\n  \"swarmId\": \"<string>\",\n  \"environmentIds\": [\n    \"<string>\"\n  ],\n  \"serverAttachmentId\": \"<string>\",\n  \"hostIds\": [\n    \"<string>\"\n  ],\n  \"judge\": {\n    \"enabled\": true,\n    \"autoRun\": true,\n    \"model\": \"<string>\",\n    \"modelSelection\": {\n      \"modelId\": \"<string>\",\n      \"fallback\": {\n        \"model\": \"none\"\n      },\n      \"nativeModelId\": \"<string>\",\n      \"settings\": {\n        \"temperature\": 1\n      }\n    },\n    \"modelSelectionOrigin\": \"backfill\",\n    \"threshold\": 0.5\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.mcpjam.com/api/v1/projects/{projectId}/goals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"goal\": \"<string>\",\n  \"personaId\": \"<string>\",\n  \"iterations\": 50,\n  \"maxTurns\": 100,\n  \"name\": \"<string>\",\n  \"swarmId\": \"<string>\",\n  \"environmentIds\": [\n    \"<string>\"\n  ],\n  \"serverAttachmentId\": \"<string>\",\n  \"hostIds\": [\n    \"<string>\"\n  ],\n  \"judge\": {\n    \"enabled\": true,\n    \"autoRun\": true,\n    \"model\": \"<string>\",\n    \"modelSelection\": {\n      \"modelId\": \"<string>\",\n      \"fallback\": {\n        \"model\": \"none\"\n      },\n      \"nativeModelId\": \"<string>\",\n      \"settings\": {\n        \"temperature\": 1\n      }\n    },\n    \"modelSelectionOrigin\": \"backfill\",\n    \"threshold\": 0.5\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "projectId": "<string>",
  "name": "<string>",
  "goal": "<string>",
  "personaId": "<string>",
  "swarmId": "<string>",
  "environmentIds": [
    "<string>"
  ],
  "iterations": 123,
  "maxTurns": 123,
  "createdAt": 123,
  "updatedAt": 123,
  "serverAttachmentId": "<string>",
  "setupWrites": true,
  "judge": {
    "enabled": true,
    "model": "<string>",
    "autoRun": true,
    "threshold": 0.5,
    "modelSelection": {
      "modelId": "<string>",
      "source": "hosted",
      "fallback": {
        "provider": "none",
        "model": "none"
      },
      "connectionRef": {
        "kind": "orgProvider",
        "id": "<string>",
        "providerKey": "<string>",
        "customProviderName": "<string>"
      },
      "nativeModelId": "<string>",
      "settings": {
        "reasoningEffort": "none",
        "temperature": 1
      }
    },
    "modelSelectionOrigin": "backfill"
  }
}

API Guides

Endpoints

Authorizations

Headers

Path Parameters

Body

Response