Reply inbox API
The reply inbox, Engage feeds and Reddit listening.
9 endpoints. Every path is relative to the API base URL and needs a bearer token unless it is marked public. See the REST API overview for authentication, errors and pagination.
GET/v1/orgs/{orgId}/engagement
Lists replies, mentions and community posts on X, and Reddit threads found by listening, with their drafted replies, newest first. Open items (the default) are those still waiting on a decision.
Path parameters
orgIdstring (uuid)required
Query parameters
statusstringone of
open,sent,dismissed,allkindstringone of
mention,community,allplatformstringone of
x,reddit,allfeedIdstringpageintegerlimitinteger
Responses
200Lists replies, mentions and community posts on X, and Reddit threads found by listening, with their drafted replies, newest first. Open items (the default) are those still waiting on a decision.
dataobjectrequiredFields
itemsarray<object>requiredItem fields
idstring (uuid)requiredplatformstringrequiredone of
x,redditkindstringrequiredone of
mention,communitystatusstringrequiredone of
new,drafted,sending,sent,dismissed,failedexternalPostIdstringrequiredurlstringrequiredauthorobjectrequiredFields
handlestring | nullrequirednamestring | nullrequiredfollowersinteger | nullrequired
textstringrequiredpostedAtstring | nullrequiredlikeCountintegerrequiredreplyCountintegerrequiredinReplyToTextstring | nullrequiredmatchedBystring | nullrequiredfeedIdstring | nullrequiredtitlestring | nullrequiredcommunitystring | nullrequiredrelevanceinteger | nullrequireddraftTextstring | nullrequireddraftReasonstring | nullrequiredcanSendFromAppbooleanrequiredreplyOnXUrlstringrequiredsentUrlstring | nullrequiredsentAtstring | nullrequiredlastErrorstring | nullrequiredcreatedAtstringrequired
pageintegerrequiredlimitintegerrequiredtotalintegerrequiredhasMorebooleanrequired
curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/engagement" \ -H "Authorization: Bearer $ADVENTURAI_TOKEN"PATCH/v1/orgs/{orgId}/engagement/{itemId}
Edits a drafted reply, dismisses the item, brings it back, or records a reply posted on X by hand. Never posts anything.
Path parameters
orgIdstring (uuid)requireditemIdstring (uuid)required
Request body application/json
draftTextstringstatusstringone of
drafted,dismissed,sent
Responses
200Edits a drafted reply, dismisses the item, brings it back, or records a reply posted on X by hand. Never posts anything.
dataobjectrequiredFields
idstring (uuid)requiredplatformstringrequiredone of
x,redditkindstringrequiredone of
mention,communitystatusstringrequiredone of
new,drafted,sending,sent,dismissed,failedexternalPostIdstringrequiredurlstringrequiredauthorobjectrequiredFields
handlestring | nullrequirednamestring | nullrequiredfollowersinteger | nullrequired
textstringrequiredpostedAtstring | nullrequiredlikeCountintegerrequiredreplyCountintegerrequiredinReplyToTextstring | nullrequiredmatchedBystring | nullrequiredfeedIdstring | nullrequiredtitlestring | nullrequiredcommunitystring | nullrequiredrelevanceinteger | nullrequireddraftTextstring | nullrequireddraftReasonstring | nullrequiredcanSendFromAppbooleanrequiredreplyOnXUrlstringrequiredsentUrlstring | nullrequiredsentAtstring | nullrequiredlastErrorstring | nullrequiredcreatedAtstringrequired
curl -X PATCH "https://api.adventur.ai/v1/orgs/$ORG_ID/engagement/$ITEM_ID" \ -H "Authorization: Bearer $ADVENTURAI_TOKEN" \ -H "Content-Type: application/json" \ -d '{}'POST/v1/orgs/{orgId}/engagement/{itemId}/draft
Writes a new reply to an inbox item in the brand voice and the way the user writes in their own recent X posts, optionally steered by guidance. Posts nothing.
Path parameters
orgIdstring (uuid)requireditemIdstring (uuid)required
Request body application/json
guidancestring
Responses
200Writes a new reply to an inbox item in the brand voice and the way the user writes in their own recent X posts, optionally steered by guidance. Posts nothing.
dataobjectrequiredFields
idstring (uuid)requiredplatformstringrequiredone of
x,redditkindstringrequiredone of
mention,communitystatusstringrequiredone of
new,drafted,sending,sent,dismissed,failedexternalPostIdstringrequiredurlstringrequiredauthorobjectrequiredFields
handlestring | nullrequirednamestring | nullrequiredfollowersinteger | nullrequired
textstringrequiredpostedAtstring | nullrequiredlikeCountintegerrequiredreplyCountintegerrequiredinReplyToTextstring | nullrequiredmatchedBystring | nullrequiredfeedIdstring | nullrequiredtitlestring | nullrequiredcommunitystring | nullrequiredrelevanceinteger | nullrequireddraftTextstring | nullrequireddraftReasonstring | nullrequiredcanSendFromAppbooleanrequiredreplyOnXUrlstringrequiredsentUrlstring | nullrequiredsentAtstring | nullrequiredlastErrorstring | nullrequiredcreatedAtstringrequired
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/engagement/$ITEM_ID/draft" \ -H "Authorization: Bearer $ADVENTURAI_TOKEN" \ -H "Content-Type: application/json" \ -d '{}'POST/v1/orgs/{orgId}/engagement/{itemId}/send
Posts the approved reply to a mention on X, or as a comment on a Reddit thread from the connected Reddit account. Sending is the approval, so the exact text is required. X community posts can't be replied to through X's API; post those on X with the item's replyOnXUrl.
Path parameters
orgIdstring (uuid)requireditemIdstring (uuid)required
Request body application/json
textstringrequired
Responses
200Posts the approved reply to a mention on X, or as a comment on a Reddit thread from the connected Reddit account. Sending is the approval, so the exact text is required. X community posts can't be replied to through X's API; post those on X with the item's replyOnXUrl.
dataobjectrequiredFields
idstring (uuid)requiredplatformstringrequiredone of
x,redditkindstringrequiredone of
mention,communitystatusstringrequiredone of
new,drafted,sending,sent,dismissed,failedexternalPostIdstringrequiredurlstringrequiredauthorobjectrequiredFields
handlestring | nullrequirednamestring | nullrequiredfollowersinteger | nullrequired
textstringrequiredpostedAtstring | nullrequiredlikeCountintegerrequiredreplyCountintegerrequiredinReplyToTextstring | nullrequiredmatchedBystring | nullrequiredfeedIdstring | nullrequiredtitlestring | nullrequiredcommunitystring | nullrequiredrelevanceinteger | nullrequireddraftTextstring | nullrequireddraftReasonstring | nullrequiredcanSendFromAppbooleanrequiredreplyOnXUrlstringrequiredsentUrlstring | nullrequiredsentAtstring | nullrequiredlastErrorstring | nullrequiredcreatedAtstringrequired
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/engagement/$ITEM_ID/send" \ -H "Authorization: Bearer $ADVENTURAI_TOKEN" \ -H "Content-Type: application/json" \ -d '{"text":"string"}'POST/v1/orgs/{orgId}/engagement/reddit-suggestions
Suggests pain-point phrases and subreddits to listen to on Reddit, from the brand profile and strategy. Saves nothing.
Path parameters
orgIdstring (uuid)required
Responses
200Suggests pain-point phrases and subreddits to listen to on Reddit, from the brand profile and strategy. Saves nothing.
dataobjectrequiredFields
redditKeywordsarray<string>requiredsubredditsarray<string>required
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/engagement/reddit-suggestions" \ -H "Authorization: Bearer $ADVENTURAI_TOKEN"POST/v1/orgs/{orgId}/engagement/refresh
Pulls new replies, mentions and community posts from X, and Reddit threads about the workspace's pain points, into the reply inbox and drafts a reply to each. Posts nothing.
Path parameters
orgIdstring (uuid)required
Request body application/json
feedIdstring
Responses
200Pulls new replies, mentions and community posts from X, and Reddit threads about the workspace's pain points, into the reply inbox and drafts a reply to each. Posts nothing.
dataobjectrequiredFields
addedintegerrequireddraftedintegerrequiredmentionsFoundintegerrequiredcommunityFoundintegerrequiredredditFoundintegerrequiredfeedsFoundintegerrequiredwarningsarray<string>requireditemsarray<object>requiredItem fields
idstring (uuid)requiredplatformstringrequiredone of
x,redditkindstringrequiredone of
mention,communitystatusstringrequiredone of
new,drafted,sending,sent,dismissed,failedexternalPostIdstringrequiredurlstringrequiredauthorobjectrequiredFields
handlestring | nullrequirednamestring | nullrequiredfollowersinteger | nullrequired
textstringrequiredpostedAtstring | nullrequiredlikeCountintegerrequiredreplyCountintegerrequiredinReplyToTextstring | nullrequiredmatchedBystring | nullrequiredfeedIdstring | nullrequiredtitlestring | nullrequiredcommunitystring | nullrequiredrelevanceinteger | nullrequireddraftTextstring | nullrequireddraftReasonstring | nullrequiredcanSendFromAppbooleanrequiredreplyOnXUrlstringrequiredsentUrlstring | nullrequiredsentAtstring | nullrequiredlastErrorstring | nullrequiredcreatedAtstringrequired
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/engagement/refresh" \ -H "Authorization: Bearer $ADVENTURAI_TOKEN" \ -H "Content-Type: application/json" \ -d '{}'GET/v1/orgs/{orgId}/engagement/settings
The X accounts and keywords the reply inbox watches, its saved Engage feeds, the Reddit pain-point phrases and subreddits it listens to, and whether it checks automatically.
Path parameters
orgIdstring (uuid)required
Responses
200The X accounts and keywords the reply inbox watches, its saved Engage feeds, the Reddit pain-point phrases and subreddits it listens to, and whether it checks automatically.
dataobjectrequiredFields
watchHandlesarray<any>requiredkeywordsarray<string>requiredautoRefreshbooleanrequiredredditKeywordsarray<string>requiredsubredditsarray<any>requiredredditExcludeTermsarray<string>requiredfeedsarray<object>requiredItem fields
idstringrequirednamestringrequiredsourcestringrequiredone of
keywords,list,peoplekeywordsarray<string>requiredlistIdstring | nullrequiredhandlesarray<string>requiredminFollowersnumber | nullrequiredmaxFollowersnumber | nullrequiredenabledbooleanrequiredlastCheckedAtstring | nullrequired
lastRefreshedAtstring | nullrequired
curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/engagement/settings" \ -H "Authorization: Bearer $ADVENTURAI_TOKEN"PUT/v1/orgs/{orgId}/engagement/settings
Sets the X accounts (up to 10) and keywords (up to 5) to watch for community posts, up to 5 Engage feeds, the Reddit pain-point phrases (up to 8) and subreddits (up to 10) to listen to, and whether to check automatically.
Path parameters
orgIdstring (uuid)required
Request body application/json
watchHandlesarray<any>keywordsarray<string>autoRefreshbooleanredditKeywordsarray<string>subredditsarray<any>redditExcludeTermsarray<string>feedsarray<object>Item fields
namestringrequiredsourcestringrequiredone of
keywords,list,peopleidstringkeywordsarray<string>listIdany | nullhandlesarray<any>minFollowersinteger | nullmaxFollowersinteger | nullenabledboolean
Responses
200Sets the X accounts (up to 10) and keywords (up to 5) to watch for community posts, up to 5 Engage feeds, the Reddit pain-point phrases (up to 8) and subreddits (up to 10) to listen to, and whether to check automatically.
dataobjectrequiredFields
watchHandlesarray<any>requiredkeywordsarray<string>requiredautoRefreshbooleanrequiredredditKeywordsarray<string>requiredsubredditsarray<any>requiredredditExcludeTermsarray<string>requiredfeedsarray<object>requiredItem fields
idstringrequirednamestringrequiredsourcestringrequiredone of
keywords,list,peoplekeywordsarray<string>requiredlistIdstring | nullrequiredhandlesarray<string>requiredminFollowersnumber | nullrequiredmaxFollowersnumber | nullrequiredenabledbooleanrequiredlastCheckedAtstring | nullrequired
lastRefreshedAtstring | nullrequired
curl -X PUT "https://api.adventur.ai/v1/orgs/$ORG_ID/engagement/settings" \ -H "Authorization: Bearer $ADVENTURAI_TOKEN" \ -H "Content-Type: application/json" \ -d '{}'POST/v1/orgs/{orgId}/engagement/x-account-suggestions
Suggests up to 15 X accounts the workspace's audience follows, checked against X for existence and size. Runs at most once a week; within the week it returns the saved suggestions at no cost. Saves no feed.
Path parameters
orgIdstring (uuid)required
Responses
200Suggests up to 15 X accounts the workspace's audience follows, checked against X for existence and size. Runs at most once a week; within the week it returns the saved suggestions at no cost. Saves no feed.
dataobjectrequiredFields
accountsarray<object>requiredItem fields
handlestringrequirednamestring | nullrequiredfollowersinteger | nullrequiredbiostring | nullrequiredreasonstringrequired
generatedAtstringrequiredcachedbooleanrequirednextRefreshAtstringrequired
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/engagement/x-account-suggestions" \ -H "Authorization: Bearer $ADVENTURAI_TOKEN"