Read the keyword proposal
The proposal as it stands; terminal once its status is ready or failed.
curl --request GET \
--url https://app.octolens.com/api/v2/onboarding/proposal \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.octolens.com/api/v2/onboarding/proposal"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.octolens.com/api/v2/onboarding/proposal', 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/onboarding/proposal",
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.octolens.com/api/v2/onboarding/proposal"
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))
}HttpResponse<String> response = Unirest.get("https://app.octolens.com/api/v2/onboarding/proposal")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octolens.com/api/v2/onboarding/proposal")
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{
"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>",
"activity": {
"band": "quiet",
"basis": "sampled",
"sampled": 0,
"saturated": []
},
"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>"
],
"filterGroups": [
{
"group_operator": "AND",
"conditions": [
{
"field": "Keywords",
"operator": "in",
"values": "42,43"
}
],
"isSingleCondition": true
}
],
"description": "<string>",
"mergedIntoRef": "<string>"
}
],
"platforms": {
"on": [
"<string>"
],
"off": []
},
"warnings": [],
"sampling": {
"sampledAt": "<string>",
"sources": [
"<string>"
]
},
"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
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.
Query Parameters
The draft_… id. Optional on every onboarding route: defaults to the onboarding's current draft.
1 - 64"draft_k3v9x0q2m1"
Response
200 response
The draft the proposal belongs to — also the {id} to poll.
proposing → measuring (the first search pass) → sampling → proposing (the agent) → ready | failed. Poll until it is one of the last two (needs_narrowing is a legacy terminal status no run produces any more).
scanning, scanned, proposing, measuring, sampling, ready, needs_narrowing, failed, applied The profile was edited after this proposal: propose again.
balanced, thorough Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Present once the status is ready or needs_narrowing.
Show child attributes
Show child attributes
Was this page helpful?
curl --request GET \
--url https://app.octolens.com/api/v2/onboarding/proposal \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.octolens.com/api/v2/onboarding/proposal"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.octolens.com/api/v2/onboarding/proposal', 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/onboarding/proposal",
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.octolens.com/api/v2/onboarding/proposal"
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))
}HttpResponse<String> response = Unirest.get("https://app.octolens.com/api/v2/onboarding/proposal")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octolens.com/api/v2/onboarding/proposal")
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{
"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>",
"activity": {
"band": "quiet",
"basis": "sampled",
"sampled": 0,
"saturated": []
},
"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>"
],
"filterGroups": [
{
"group_operator": "AND",
"conditions": [
{
"field": "Keywords",
"operator": "in",
"values": "42,43"
}
],
"isSingleCondition": true
}
],
"description": "<string>",
"mergedIntoRef": "<string>"
}
],
"platforms": {
"on": [
"<string>"
],
"off": []
},
"warnings": [],
"sampling": {
"sampledAt": "<string>",
"sources": [
"<string>"
]
},
"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"
}
}