Skip to main content
GET
Get an opportunity

Authorizations

Authorization
string
header
required

A workspace API key issued in Settings → Developer, sent as Bearer sk_….

Path Parameters

opportunityId
string<uuid>
required
Example:

"0b6f2c1e-6d2a-4c3e-9a1f-5e8d7c4b3a21"

Response

The opportunity.

id
string
required
projectId
string
required
kind
enum<string>
required
Available options:
create_page,
update_page
changeKind
string | null
required

For an update: what to change on the page.

targetPageId
string | null
required

For an update: the page it changes.

title
string
required
rationale
string
required
topic
string
required
persona
string
required
intent
string
required
score
number
required
createdAt
string
required

ISO-8601 UTC timestamp.

state
enum<string>
required
Available options:
planned,
dismissed,
writing,
claimed,
creation_failed,
open
dismissedAt
string | null
required

ISO-8601 UTC timestamp.

creationFailure
object | null
required

The last failure to create content from it, if any, with a readable reason.

contentId
string | null
required

The content created from it, if any.

claim
object | null
required

Who holds it now: a Jam run (pipeline, state writing) or an external agent (agent, state claimed). Agent claims expire.

prompts
object[]
required
demandQueries
object[]
required