Get a journey

GET

projects

{projectId}

goals

{goalId}

Get a journey

curl --request GET \
  --url https://app.mcpjam.com/api/v1/projects/{projectId}/goals/{goalId} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.mcpjam.com/api/v1/projects/{projectId}/goals/{goalId}', 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/{goalId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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.

Path Parameters

projectId

string

required

ID of the hosted project that contains the server.

goalId

string

required

Goal ID, as returned by the project's goal list.

Response

The 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

Get a journey

curl --request GET \
  --url https://app.mcpjam.com/api/v1/projects/{projectId}/goals/{goalId} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.mcpjam.com/api/v1/projects/{projectId}/goals/{goalId}', 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/{goalId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

Path Parameters

Response