Setup

Propose a keyword setup for a scanned draft

Beta — behind the sonar-onboarding feature flag. Workspaces the flag is off for get 404 FEATURE_DISABLED.

Starts the setup agent on a draft returned by POST /api/v2/setup/scan: it proposes keyword candidates, measures each one’s monthly volume, scores a sample of real posts, and decides a setup of at most 5 keywords with scoping options, feeds and platforms — every decision with its reasons[] and a plain explanation. Asynchronous: answers 202 with the draft id and status at once; poll GET /api/v2/setup/proposals/{id} until the status is ready, needs_narrowing or failed (typically 40–75 s). A draft with a running or current proposal gets that one back (force: true starts over once it has finished; while a run is live it returns 409 SETUP_PROPOSAL_RUNNING). A run that stops mid-way is finished by the degradation ladder on the next poll (propose_interrupted). Rate-limited to 5 new proposals per workspace per day (429 RATE_LIMITED). Creates nothing in the workspace and consumes no mention quota.

POST

api

setup

propose

Propose a keyword setup for a scanned draft

curl --request POST \
  --url https://app.octolens.com/api/v2/setup/propose \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "draftId": "draft_k3v9x0q2m1",
  "force": true
}
'

import requests

url = "https://app.octolens.com/api/v2/setup/propose"

payload = {
    "draftId": "draft_k3v9x0q2m1",
    "force": True
}
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({draftId: 'draft_k3v9x0q2m1', force: true})
};

fetch('https://app.octolens.com/api/v2/setup/propose', 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.octolens.com/api/v2/setup/propose",
  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([
    'draftId' => 'draft_k3v9x0q2m1',
    'force' => true
  ]),
  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.octolens.com/api/v2/setup/propose"

	payload := strings.NewReader("{\n  \"draftId\": \"draft_k3v9x0q2m1\",\n  \"force\": true\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.octolens.com/api/v2/setup/propose")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"draftId\": \"draft_k3v9x0q2m1\",\n  \"force\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/setup/propose")

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  \"draftId\": \"draft_k3v9x0q2m1\",\n  \"force\": true\n}"

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

{
  "draftId": "<string>",
  "domain": "<string>",
  "status": "scanning",
  "stale": true,
  "tier": "balanced",
  "model": "<string>",
  "guideVersion": "<string>",
  "agentFallback": true,
  "startedAt": "<string>",
  "finishedAt": "<string>",
  "steps": [
    {
      "stage": "candidates",
      "status": "running",
      "line": "<string>",
      "startedAt": "<string>",
      "ms": 4503599627370495
    }
  ],
  "degraded": [
    {
      "code": "candidates_failed",
      "message": "<string>"
    }
  ],
  "timeline": [
    {
      "kind": "stage",
      "name": "<string>",
      "status": "<string>",
      "ms": 4503599627370495
    }
  ],
  "proposal": {
    "id": "<string>",
    "draftId": "<string>",
    "domain": "<string>",
    "skillVersion": "<string>",
    "model": "<string>",
    "archetype": "quiet",
    "archetypeReason": "<string>",
    "keywords": [
      {
        "ref": "<string>",
        "keyword": "<string>",
        "tag": "own_brand",
        "route": "bare",
        "exactMatch": true,
        "caseSensitive": false,
        "additionalTerms": [],
        "additionalTermsLogic": "any",
        "excludeWords": [],
        "wildcardExcludeWords": [],
        "excludeAuthors": [],
        "platforms": [
          "dev"
        ],
        "context": "<string>",
        "volume": {
          "low": 1,
          "high": 1,
          "band": "quiet",
          "basis": "analog",
          "window": "30d",
          "perSource": [],
          "unverifiedSources": [],
          "unmeasuredSources": []
        },
        "sample": {
          "scored": 4503599627370495,
          "relevanceRate": 0.5,
          "clusters": []
        },
        "feedRef": "<string>",
        "explanation": "<string>",
        "reasons": [],
        "confidence": 0.5,
        "flags": [],
        "selectedByDefault": true,
        "approvals": [],
        "approval": {},
        "optionGroup": "<string>"
      }
    ],
    "options": [],
    "feeds": [
      {
        "ref": "<string>",
        "name": "<string>",
        "purpose": "brand",
        "keywordRefs": [
          "<string>"
        ],
        "visible": true,
        "source": "setup",
        "gate": {
          "weeklySample": 1,
          "relevanceRate": 0.5,
          "dominantClusterShare": 0.5,
          "duplicateOf": "<string>"
        },
        "contentTerms": [
          "<string>"
        ],
        "mergedIntoRef": "<string>"
      }
    ],
    "platforms": {
      "on": [
        "<string>"
      ],
      "off": []
    },
    "totals": {
      "projectedMonthly": 1,
      "dedupedMonthly": 1,
      "allowance": 5000,
      "band": "pass",
      "narrowingApplied": []
    },
    "warnings": [],
    "measurement": {
      "measuredAt": "<string>",
      "sources": [
        "<string>"
      ],
      "unmeasured": []
    },
    "confidence": 0.5,
    "agentFallback": false
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

Authorizations

Authorization

string

header

required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>. Keys carry a scope — read, write (implies read) or admin (implies write) — chosen when the key is minted. Each operation's security requirement (and its x-required-scope extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.

Body

application/json

draftId

string

required

The draft_… id a scan returned.

Required string length: 1 - 64

Example:

"draft_k3v9x0q2m1"

force

boolean

Start a new proposal even when the draft already has a current one.

Response

202 response

draftId

string

required

The draft the proposal belongs to — also the {id} to poll.

domain

string

required

status

enum<string>

required

proposing → measuring → sampling → proposing (the agent) → ready | needs_narrowing | failed. Poll until it is one of the last three.

Available options:

scanning,

scanned,

proposing,

measuring,

sampling,

ready,

needs_narrowing,

failed,

applied

stale

boolean

required

The profile was edited after this proposal: propose again.

tier

enum<string> | null

required

Available options:

balanced,

thorough

model

string | null

required

guideVersion

string

required

agentFallback

boolean

required

startedAt

string | null

required

finishedAt

string | null

required

steps

object[]

required

Show child attributes

degraded

object[]

required

Show child attributes

timeline

object[]

required

Show child attributes

proposal

object | null

required

Present once the status is ready or needs_narrowing.

Show child attributes

Propose a keyword setup for a scanned draft

curl --request POST \
  --url https://app.octolens.com/api/v2/setup/propose \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "draftId": "draft_k3v9x0q2m1",
  "force": true
}
'

import requests

url = "https://app.octolens.com/api/v2/setup/propose"

payload = {
    "draftId": "draft_k3v9x0q2m1",
    "force": True
}
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({draftId: 'draft_k3v9x0q2m1', force: true})
};

fetch('https://app.octolens.com/api/v2/setup/propose', 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.octolens.com/api/v2/setup/propose",
  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([
    'draftId' => 'draft_k3v9x0q2m1',
    'force' => true
  ]),
  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.octolens.com/api/v2/setup/propose"

	payload := strings.NewReader("{\n  \"draftId\": \"draft_k3v9x0q2m1\",\n  \"force\": true\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.octolens.com/api/v2/setup/propose")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"draftId\": \"draft_k3v9x0q2m1\",\n  \"force\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/setup/propose")

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  \"draftId\": \"draft_k3v9x0q2m1\",\n  \"force\": true\n}"

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

{
  "draftId": "<string>",
  "domain": "<string>",
  "status": "scanning",
  "stale": true,
  "tier": "balanced",
  "model": "<string>",
  "guideVersion": "<string>",
  "agentFallback": true,
  "startedAt": "<string>",
  "finishedAt": "<string>",
  "steps": [
    {
      "stage": "candidates",
      "status": "running",
      "line": "<string>",
      "startedAt": "<string>",
      "ms": 4503599627370495
    }
  ],
  "degraded": [
    {
      "code": "candidates_failed",
      "message": "<string>"
    }
  ],
  "timeline": [
    {
      "kind": "stage",
      "name": "<string>",
      "status": "<string>",
      "ms": 4503599627370495
    }
  ],
  "proposal": {
    "id": "<string>",
    "draftId": "<string>",
    "domain": "<string>",
    "skillVersion": "<string>",
    "model": "<string>",
    "archetype": "quiet",
    "archetypeReason": "<string>",
    "keywords": [
      {
        "ref": "<string>",
        "keyword": "<string>",
        "tag": "own_brand",
        "route": "bare",
        "exactMatch": true,
        "caseSensitive": false,
        "additionalTerms": [],
        "additionalTermsLogic": "any",
        "excludeWords": [],
        "wildcardExcludeWords": [],
        "excludeAuthors": [],
        "platforms": [
          "dev"
        ],
        "context": "<string>",
        "volume": {
          "low": 1,
          "high": 1,
          "band": "quiet",
          "basis": "analog",
          "window": "30d",
          "perSource": [],
          "unverifiedSources": [],
          "unmeasuredSources": []
        },
        "sample": {
          "scored": 4503599627370495,
          "relevanceRate": 0.5,
          "clusters": []
        },
        "feedRef": "<string>",
        "explanation": "<string>",
        "reasons": [],
        "confidence": 0.5,
        "flags": [],
        "selectedByDefault": true,
        "approvals": [],
        "approval": {},
        "optionGroup": "<string>"
      }
    ],
    "options": [],
    "feeds": [
      {
        "ref": "<string>",
        "name": "<string>",
        "purpose": "brand",
        "keywordRefs": [
          "<string>"
        ],
        "visible": true,
        "source": "setup",
        "gate": {
          "weeklySample": 1,
          "relevanceRate": 0.5,
          "dominantClusterShare": 0.5,
          "duplicateOf": "<string>"
        },
        "contentTerms": [
          "<string>"
        ],
        "mergedIntoRef": "<string>"
      }
    ],
    "platforms": {
      "on": [
        "<string>"
      ],
      "off": []
    },
    "totals": {
      "projectedMonthly": 1,
      "dedupedMonthly": 1,
      "allowance": 5000,
      "band": "pass",
      "narrowingApplied": []
    },
    "warnings": [],
    "measurement": {
      "measuredAt": "<string>",
      "sources": [
        "<string>"
      ],
      "unmeasured": []
    },
    "confidence": 0.5,
    "agentFallback": false
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}