Skip to main content
POST
Queue async post generation

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer API_KEY. Account API keys work in every workspace you belong to: send X-Notra-Organization-Id with the workspace id or slug to choose one. Workspace endpoints require it when you belong to more than one workspace; GET /v1/me/workspaces works without it. Organization keys only accept their own workspace there.

Body

application/json
contentType
enum<string>
required

Type of content to generate.

Available options:
changelog,
blog_post,
linkedin_post,
twitter_post,
image
Example:

"blog_post"

lookbackWindow
enum<string>
default:last_7_days

How far back to collect source activity (commits, pull requests, releases, Linear issues).

Available options:
current_day,
yesterday,
last_7_days,
last_14_days,
last_30_days
Example:

"last_7_days"

brandVoiceId
string

Deprecated. Use brandIdentityId instead.

Minimum string length: 1
Example:

"51c2f3aa-efdd-4e28-8e69-23fa2dfd3561"

brandIdentityId
string | null

Brand identity to write in. Defaults to the organization's default brand identity.

Minimum string length: 1
Example:

"51c2f3aa-efdd-4e28-8e69-23fa2dfd3561"

repositoryIds
string[]

Deprecated. Use integrations.github with GitHub integration IDs instead.

Minimum string length: 1
Example:
linearIntegrationIds
string[]

Deprecated. Use integrations.linear with Linear integration IDs instead.

Minimum string length: 1
Example:
integrations
object

Source integrations to draw activity from. Omit this and github.repositories to use every connected GitHub integration.

github
object

Select connected repositories by owner and name instead of integration ID. Cannot be combined with integrations.github.

Example:
dataPoints
object

Which kinds of activity to collect from the selected sources. At least one must be true, unless pullRequest is set, which ignores them.

selectedItems
object

Restrict generation to specific commits, pull requests, releases, or Linear issues instead of everything in the lookback window.

timezone
string

IANA timezone used for relative lookback windows such as current_day and yesterday.

Required string length: 1 - 100
Example:

"America/New_York"

pullRequest
object

Write about exactly this pull request in a connected repository, open or merged, whatever its age. Uses only its pull request data, so dataPoints and lookbackWindow do not apply. Cannot be combined with other source selectors or selectedItems.

Example:
brief
string

What the post should be about and what it should cover, in your own words. Steers the topic, angle and structure; facts still come from the selected sources.

Required string length: 1 - 4000
Example:

"Announce mention-driven blog posts. Lead with the phone workflow and show the comment that triggers it."

Response

Post generation queued successfully

organization
object
required
job
object
required