Skip to content

Generate Social Post

POST
/social/posts/generate

Draft up to three variants with AI. SPENDS CREDITS (credits_used); saves nothing.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Ask the AI studio for draft variants. SPENDS CREDITS; saves nothing.

The variants come back in the response - create a post from the one you want with POST /social/posts.

object
campaign_id
Any of:
string
context
Any of:
string
<= 2000 characters
frame
Any of:
string
<= 40 characters
hashtags_max
integer
default: 3 <= 3
idea_id
Any of:
string
instructions
Any of:
string
<= 2000 characters
reference_post
Any of:
string
<= 4000 characters
refine
Any of:

Rewrite an existing draft instead of generating from scratch.

object
body
required
string
>= 1 characters <= 3000 characters
instruction
required
string
>= 1 characters <= 300 characters
sources
Any of:
Array<string>
<= 6 items
tone
Any of:
string
<= 200 characters
variants
integer
default: 3 >= 1 <= 3

Responses

200

Successful Response

object
data
required

Generated drafts. Nothing has been saved.

object
credits_used
required
integer
provenance
required
Array<string>
variants
required
Array<object>

One generated draft.

object
body
required
string
frame
required
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string