Skip to main content
GET
The brief to write an article from

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 brief.

opportunityId
string
required
kind
enum<string>
required
Available options:
create_page,
update_page
title
string
required
rationale
string
required
topic
string
required
persona
string
required
intent
string
required
targetPrompts
string[]
required

The questions users ask that this article should answer.

voice
object
required
research
object | null
required

The sources Jam read and the facts it recorded from each.

articlePlan
object | null
required
creditsCharged
integer
required

Credits this read charged. The first read writes the article plan with one metered model call and charges for it; every later read returns the stored plan and charges 0.

planUnavailable
string | null
required

Why no plan could be written, when articlePlan is null.

delivery
object | null
required

The GitHub destination the article will be delivered to, when the project has one configured.

submit
object
required

The exact request that stores the finished article; fill the article fields.