Start an agent connect session

curl --request POST \
  --url https://api.spreadjam.com/v1/agent-connect \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "acme.com",
  "email": "jsmith@example.com",
  "agentName": "Claude Code",
  "onboarding": {
    "site": "acme.com",
    "brandName": "Acme",
    "description": "<string>",
    "audience": [
      {
        "title": "<string>",
        "blurb": "<string>"
      }
    ],
    "competitors": [
      {
        "name": "<string>",
        "domain": "<string>",
        "aliases": [
          "<string>"
        ]
      }
    ],
    "prompts": [
      {
        "text": "<string>",
        "topic": "<string>",
        "intent": "<string>",
        "audience": "<string>"
      }
    ]
  }
}
'

import requests

url = "https://api.spreadjam.com/v1/agent-connect"

payload = {
    "domain": "acme.com",
    "email": "jsmith@example.com",
    "agentName": "Claude Code",
    "onboarding": {
        "site": "acme.com",
        "brandName": "Acme",
        "description": "<string>",
        "audience": [
            {
                "title": "<string>",
                "blurb": "<string>"
            }
        ],
        "competitors": [
            {
                "name": "<string>",
                "domain": "<string>",
                "aliases": ["<string>"]
            }
        ],
        "prompts": [
            {
                "text": "<string>",
                "topic": "<string>",
                "intent": "<string>",
                "audience": "<string>"
            }
        ]
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    domain: 'acme.com',
    email: 'jsmith@example.com',
    agentName: 'Claude Code',
    onboarding: {
      site: 'acme.com',
      brandName: 'Acme',
      description: '<string>',
      audience: [{title: '<string>', blurb: '<string>'}],
      competitors: [{name: '<string>', domain: '<string>', aliases: ['<string>']}],
      prompts: [
        {text: '<string>', topic: '<string>', intent: '<string>', audience: '<string>'}
      ]
    }
  })
};

fetch('https://api.spreadjam.com/v1/agent-connect', 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://api.spreadjam.com/v1/agent-connect",
  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([
    'domain' => 'acme.com',
    'email' => 'jsmith@example.com',
    'agentName' => 'Claude Code',
    'onboarding' => [
        'site' => 'acme.com',
        'brandName' => 'Acme',
        'description' => '<string>',
        'audience' => [
                [
                                'title' => '<string>',
                                'blurb' => '<string>'
                ]
        ],
        'competitors' => [
                [
                                'name' => '<string>',
                                'domain' => '<string>',
                                'aliases' => [
                                                                '<string>'
                                ]
                ]
        ],
        'prompts' => [
                [
                                'text' => '<string>',
                                'topic' => '<string>',
                                'intent' => '<string>',
                                'audience' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.spreadjam.com/v1/agent-connect"

	payload := strings.NewReader("{\n  \"domain\": \"acme.com\",\n  \"email\": \"jsmith@example.com\",\n  \"agentName\": \"Claude Code\",\n  \"onboarding\": {\n    \"site\": \"acme.com\",\n    \"brandName\": \"Acme\",\n    \"description\": \"<string>\",\n    \"audience\": [\n      {\n        \"title\": \"<string>\",\n        \"blurb\": \"<string>\"\n      }\n    ],\n    \"competitors\": [\n      {\n        \"name\": \"<string>\",\n        \"domain\": \"<string>\",\n        \"aliases\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"prompts\": [\n      {\n        \"text\": \"<string>\",\n        \"topic\": \"<string>\",\n        \"intent\": \"<string>\",\n        \"audience\": \"<string>\"\n      }\n    ]\n  }\n}")

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

	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://api.spreadjam.com/v1/agent-connect")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"acme.com\",\n  \"email\": \"jsmith@example.com\",\n  \"agentName\": \"Claude Code\",\n  \"onboarding\": {\n    \"site\": \"acme.com\",\n    \"brandName\": \"Acme\",\n    \"description\": \"<string>\",\n    \"audience\": [\n      {\n        \"title\": \"<string>\",\n        \"blurb\": \"<string>\"\n      }\n    ],\n    \"competitors\": [\n      {\n        \"name\": \"<string>\",\n        \"domain\": \"<string>\",\n        \"aliases\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"prompts\": [\n      {\n        \"text\": \"<string>\",\n        \"topic\": \"<string>\",\n        \"intent\": \"<string>\",\n        \"audience\": \"<string>\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.spreadjam.com/v1/agent-connect")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"acme.com\",\n  \"email\": \"jsmith@example.com\",\n  \"agentName\": \"Claude Code\",\n  \"onboarding\": {\n    \"site\": \"acme.com\",\n    \"brandName\": \"Acme\",\n    \"description\": \"<string>\",\n    \"audience\": [\n      {\n        \"title\": \"<string>\",\n        \"blurb\": \"<string>\"\n      }\n    ],\n    \"competitors\": [\n      {\n        \"name\": \"<string>\",\n        \"domain\": \"<string>\",\n        \"aliases\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"prompts\": [\n      {\n        \"text\": \"<string>\",\n        \"topic\": \"<string>\",\n        \"intent\": \"<string>\",\n        \"audience\": \"<string>\"\n      }\n    ]\n  }\n}"

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

{
  "connectUrl": "https://www.spreadjam.com/connect/ABCD234567",
  "userCode": "K7M-Q2X",
  "pollToken": "<string>",
  "expiresAt": "<string>",
  "intervalSeconds": 123,
  "reviewUrl": "<string>",
  "plan": {
    "configuration": {
      "promptCapacity": 123,
      "cadence": "weekly",
      "platforms": [
        "chatgpt"
      ],
      "workCredits": 123
    },
    "currency": "usd",
    "monthlyCents": 39900,
    "monthlyUsd": 123
  },
  "prompts": {
    "count": 123,
    "suggestedByJam": true
  }
}

Agent connect

Start an agent connect session

No API key needed. Returns a link for the human to sign up, onboard and approve, a short userCode to show the human beside the link (the approval page shows the same code), and a poll token for the agent. Send onboarding (site, name, description, audiences, competitors, prompts, plan) and the human reviews it on one page and approves with one button that starts the trial, instead of walking the onboarding steps; the answer then adds reviewUrl and the quoted plan. An empty or unprintable agentName, a domain that is not a hostname, or an onboarding field that breaks an onboarding rule is a 400 with details. Rate limited per IP.

POST

agent-connect

curl --request POST \
  --url https://api.spreadjam.com/v1/agent-connect \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "acme.com",
  "email": "jsmith@example.com",
  "agentName": "Claude Code",
  "onboarding": {
    "site": "acme.com",
    "brandName": "Acme",
    "description": "<string>",
    "audience": [
      {
        "title": "<string>",
        "blurb": "<string>"
      }
    ],
    "competitors": [
      {
        "name": "<string>",
        "domain": "<string>",
        "aliases": [
          "<string>"
        ]
      }
    ],
    "prompts": [
      {
        "text": "<string>",
        "topic": "<string>",
        "intent": "<string>",
        "audience": "<string>"
      }
    ]
  }
}
'

import requests

url = "https://api.spreadjam.com/v1/agent-connect"

payload = {
    "domain": "acme.com",
    "email": "jsmith@example.com",
    "agentName": "Claude Code",
    "onboarding": {
        "site": "acme.com",
        "brandName": "Acme",
        "description": "<string>",
        "audience": [
            {
                "title": "<string>",
                "blurb": "<string>"
            }
        ],
        "competitors": [
            {
                "name": "<string>",
                "domain": "<string>",
                "aliases": ["<string>"]
            }
        ],
        "prompts": [
            {
                "text": "<string>",
                "topic": "<string>",
                "intent": "<string>",
                "audience": "<string>"
            }
        ]
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    domain: 'acme.com',
    email: 'jsmith@example.com',
    agentName: 'Claude Code',
    onboarding: {
      site: 'acme.com',
      brandName: 'Acme',
      description: '<string>',
      audience: [{title: '<string>', blurb: '<string>'}],
      competitors: [{name: '<string>', domain: '<string>', aliases: ['<string>']}],
      prompts: [
        {text: '<string>', topic: '<string>', intent: '<string>', audience: '<string>'}
      ]
    }
  })
};

fetch('https://api.spreadjam.com/v1/agent-connect', 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://api.spreadjam.com/v1/agent-connect",
  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([
    'domain' => 'acme.com',
    'email' => 'jsmith@example.com',
    'agentName' => 'Claude Code',
    'onboarding' => [
        'site' => 'acme.com',
        'brandName' => 'Acme',
        'description' => '<string>',
        'audience' => [
                [
                                'title' => '<string>',
                                'blurb' => '<string>'
                ]
        ],
        'competitors' => [
                [
                                'name' => '<string>',
                                'domain' => '<string>',
                                'aliases' => [
                                                                '<string>'
                                ]
                ]
        ],
        'prompts' => [
                [
                                'text' => '<string>',
                                'topic' => '<string>',
                                'intent' => '<string>',
                                'audience' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.spreadjam.com/v1/agent-connect"

	payload := strings.NewReader("{\n  \"domain\": \"acme.com\",\n  \"email\": \"jsmith@example.com\",\n  \"agentName\": \"Claude Code\",\n  \"onboarding\": {\n    \"site\": \"acme.com\",\n    \"brandName\": \"Acme\",\n    \"description\": \"<string>\",\n    \"audience\": [\n      {\n        \"title\": \"<string>\",\n        \"blurb\": \"<string>\"\n      }\n    ],\n    \"competitors\": [\n      {\n        \"name\": \"<string>\",\n        \"domain\": \"<string>\",\n        \"aliases\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"prompts\": [\n      {\n        \"text\": \"<string>\",\n        \"topic\": \"<string>\",\n        \"intent\": \"<string>\",\n        \"audience\": \"<string>\"\n      }\n    ]\n  }\n}")

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

	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://api.spreadjam.com/v1/agent-connect")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"acme.com\",\n  \"email\": \"jsmith@example.com\",\n  \"agentName\": \"Claude Code\",\n  \"onboarding\": {\n    \"site\": \"acme.com\",\n    \"brandName\": \"Acme\",\n    \"description\": \"<string>\",\n    \"audience\": [\n      {\n        \"title\": \"<string>\",\n        \"blurb\": \"<string>\"\n      }\n    ],\n    \"competitors\": [\n      {\n        \"name\": \"<string>\",\n        \"domain\": \"<string>\",\n        \"aliases\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"prompts\": [\n      {\n        \"text\": \"<string>\",\n        \"topic\": \"<string>\",\n        \"intent\": \"<string>\",\n        \"audience\": \"<string>\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.spreadjam.com/v1/agent-connect")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"acme.com\",\n  \"email\": \"jsmith@example.com\",\n  \"agentName\": \"Claude Code\",\n  \"onboarding\": {\n    \"site\": \"acme.com\",\n    \"brandName\": \"Acme\",\n    \"description\": \"<string>\",\n    \"audience\": [\n      {\n        \"title\": \"<string>\",\n        \"blurb\": \"<string>\"\n      }\n    ],\n    \"competitors\": [\n      {\n        \"name\": \"<string>\",\n        \"domain\": \"<string>\",\n        \"aliases\": [\n          \"<string>\"\n        ]\n      }\n    ],\n    \"prompts\": [\n      {\n        \"text\": \"<string>\",\n        \"topic\": \"<string>\",\n        \"intent\": \"<string>\",\n        \"audience\": \"<string>\"\n      }\n    ]\n  }\n}"

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

{
  "connectUrl": "https://www.spreadjam.com/connect/ABCD234567",
  "userCode": "K7M-Q2X",
  "pollToken": "<string>",
  "expiresAt": "<string>",
  "intervalSeconds": 123,
  "reviewUrl": "<string>",
  "plan": {
    "configuration": {
      "promptCapacity": 123,
      "cadence": "weekly",
      "platforms": [
        "chatgpt"
      ],
      "workCredits": 123
    },
    "currency": "usd",
    "monthlyCents": 39900,
    "monthlyUsd": 123
  },
  "prompts": {
    "count": 123,
    "suggestedByJam": true
  }
}

Body

application/json

domain

string

The human's website hostname (for example acme.com), prefilled in onboarding. A value that is not a hostname is a 400.

Maximum string length: 253

Example:

"acme.com"

string<email>

The human's email, if the agent knows it.

Maximum string length: 254

agentName

string

Shown to the human on the approval step and used to name the key: 1 to 60 printable characters. Omit it and the page says "Your agent".

Example:

"Claude Code"

onboarding

object

The setup you prepared for the human. With it, the link opens ONE review page (site, description, audiences, competitors, prompts, plan and price) instead of the onboarding steps; the human approves and starts the trial with one button. Validated with the rules onboarding applies; each problem is a 400 entry in details. If the human already has a set-up workspace (an active plan or a finished project), they approve for it as it is and this setup is not applied; a workspace left from an earlier attempt that was approved but never paid takes this setup.

Show child attributes

Response

201 - application/json

The session.

connectUrl

string

required

Give this link to the human. It signs them up, onboards and asks them to approve.

Example:

"https://www.spreadjam.com/connect/ABCD234567"

userCode

string

required

Show this code to the human with the link. The approval page shows the same code, so they can check the request came from you.

Example:

"K7M-Q2X"

pollToken

string

required

Secret. Poll GET /v1/agent-connect/{pollToken} with it. Never show it to anyone.

expiresAt

string

required

When the session ends if nobody approves it.

intervalSeconds

integer

required

Poll no more often than this.

reviewUrl

string

With onboarding: the page where the human reviews your setup, pays and approves. The same link as connectUrl.

plan

object

With onboarding: the plan the review page opens on and its monthly price, as the plan page prices it.

Show child attributes

prompts

object

With onboarding: how many prompts you sent, or that Jam will suggest them.

Show child attributes

Meta

Analytics

Keywords

Brand

Prompts

API keys

Opportunities

Planning

Content

Revisions

Publishing

Deliveries

Publications

Destinations

Visibility runs

Credits

Actions

Agent connect

Pricing

Site changes

Research

Answers

Projects

Billing

Webhooks

Notifications

Start an agent connect session

Body

Response