X posts API
3 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.
POST/v1/orgs/{orgId}/marketing/x-posts/delete
Deletes one of the workspace's own X posts, named by its link on X or by its post id. A published post is deleted on X and removed here; one that hasn't gone out yet is canceled.
Path parameters
orgIdstring (uuid)required
Request body application/json
postUrlstringpostIdstring (uuid)socialAccountIdstring (uuid)
Responses
200Deletes one of the workspace's own X posts, named by its link on X or by its post id. A published post is deleted on X and removed here; one that hasn't gone out yet is canceled.
dataobjectrequiredFields
outcomestringrequiredone of
deleted_on_x,removed_from_schedulepostIdstring | nullrequiredxPostIdstring | nullrequiredsocialAccountIdstring | nullrequiredwarningsarray<string>required
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/marketing/x-posts/delete" \ -H "Authorization: Bearer $ADVENTURAI_TOKEN" \ -H "Content-Type: application/json" \ -d '{}'POST/v1/orgs/{orgId}/marketing/x-posts/read
Reads any public post on X by its link or id: full text, author, metrics, links, hashtags, mentions and the posts it replies to or quotes, plus its photos and videos when asked. Each post X returns costs usage credits.
Path parameters
orgIdstring (uuid)required
Request body application/json
poststringrequiredincludeMediaboolean
Responses
200Reads any public post on X by its link or id: full text, author, metrics, links, hashtags, mentions and the posts it replies to or quotes, plus its photos and videos when asked. Each post X returns costs usage credits.
dataobjectrequiredFields
postobjectrequiredFields
idstringrequiredurlstringrequiredtextstringrequiredcreatedAtstring | nullrequiredlangstring | nullrequiredauthorobject | nullrequiredFields
idstringrequiredhandlestring | nullrequirednamestring | nullrequiredverifiedbooleanrequiredfollowersnumber | nullrequiredprofileImageUrlstring | nullrequiredbiostring | nullrequired
metricsobjectrequiredFields
likesnumberrequiredrepostsnumberrequiredrepliesnumberrequiredquotesnumberrequiredbookmarksnumberrequiredimpressionsnumber | nullrequired
conversationIdstring | nullrequiredinReplyToPostIdstring | nullrequiredlinksarray<object>requiredItem fields
urlstringrequiredexpandedUrlstring | nullrequiredtitlestring | nullrequireddescriptionstring | nullrequired
hashtagsarray<string>requiredmentionsarray<string>requiredcashtagsarray<string>requiredpossiblySensitivebooleanrequiredmediaCountnumberrequiredmediaarray<object>requiredItem fields
keystringrequiredtypestringrequiredone of
photo,video,animated_gifurlstring | nullrequiredpreviewImageUrlstring | nullrequiredaltTextstring | nullrequiredwidthnumber | nullrequiredheightnumber | nullrequireddurationMsnumber | nullrequiredvariantsarray<object>requiredItem fields
urlstringrequiredcontentTypestringrequiredbitRatenumber | nullrequired
referencedPostsarray<object>requiredItem fields
typestringrequiredone of
replied_to,quoted,retweetedidstringrequiredpostobject | nullrequiredFields
idstringrequiredurlstringrequiredtextstringrequiredcreatedAtanyrequiredlanganyrequiredauthoranyrequiredmetricsobjectrequiredFields
likesnumberrequiredrepostsnumberrequiredrepliesnumberrequiredquotesnumberrequiredbookmarksnumberrequiredimpressionsnumber | nullrequired
conversationIdanyrequiredinReplyToPostIdanyrequiredlinksarray<object>requiredItem fields
urlstringrequiredexpandedUrlstring | nullrequiredtitlestring | nullrequireddescriptionstring | nullrequired
hashtagsarray<string>requiredmentionsarray<string>requiredcashtagsarray<string>requiredpossiblySensitivebooleanrequiredmediaCountnumberrequiredmediaarray<object>requiredItem fields
keystringrequiredtypestringrequiredone of
photo,video,animated_gifurlstring | nullrequiredpreviewImageUrlstring | nullrequiredaltTextstring | nullrequiredwidthnumber | nullrequiredheightnumber | nullrequireddurationMsnumber | nullrequiredvariantsarray<object>required
usageobjectrequiredFields
postsReturnednumberrequiredpostsChargednumberrequiredcreditsUsednumberrequired
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/marketing/x-posts/read" \ -H "Authorization: Bearer $ADVENTURAI_TOKEN" \ -H "Content-Type: application/json" \ -d '{"post":"string"}'POST/v1/orgs/{orgId}/marketing/x-posts/thread
Reads the conversation a post on X belongs to: the post that started it, the author's own thread oldest first and, when asked, other people's replies. Each post X returns costs usage credits.
Path parameters
orgIdstring (uuid)required
Request body application/json
poststringrequiredincludeRepliesbooleanincludeMediabooleanlimitinteger
Responses
200Reads the conversation a post on X belongs to: the post that started it, the author's own thread oldest first and, when asked, other people's replies. Each post X returns costs usage credits.
dataobjectrequiredFields
postobjectrequiredFields
idstringrequiredurlstringrequiredtextstringrequiredcreatedAtstring | nullrequiredlangstring | nullrequiredauthorobject | nullrequiredFields
idstringrequiredhandlestring | nullrequirednamestring | nullrequiredverifiedbooleanrequiredfollowersnumber | nullrequiredprofileImageUrlstring | nullrequiredbiostring | nullrequired
metricsobjectrequiredFields
likesnumberrequiredrepostsnumberrequiredrepliesnumberrequiredquotesnumberrequiredbookmarksnumberrequiredimpressionsnumber | nullrequired
conversationIdstring | nullrequiredinReplyToPostIdstring | nullrequiredlinksarray<object>requiredItem fields
urlstringrequiredexpandedUrlstring | nullrequiredtitlestring | nullrequireddescriptionstring | nullrequired
hashtagsarray<string>requiredmentionsarray<string>requiredcashtagsarray<string>requiredpossiblySensitivebooleanrequiredmediaCountnumberrequiredmediaarray<object>requiredItem fields
keystringrequiredtypestringrequiredone of
photo,video,animated_gifurlstring | nullrequiredpreviewImageUrlstring | nullrequiredaltTextstring | nullrequiredwidthnumber | nullrequiredheightnumber | nullrequireddurationMsnumber | nullrequiredvariantsarray<object>requiredItem fields
urlstringrequiredcontentTypestringrequiredbitRatenumber | nullrequired
referencedPostsarray<object>requiredItem fields
typestringrequiredone of
replied_to,quoted,retweetedidstringrequiredpostobject | nullrequiredFields
idstringrequiredurlstringrequiredtextstringrequiredcreatedAtanyrequiredlanganyrequiredauthoranyrequiredmetricsobjectrequiredFields
likesnumberrequiredrepostsnumberrequiredrepliesnumberrequiredquotesnumberrequiredbookmarksnumberrequiredimpressionsnumber | nullrequired
conversationIdanyrequiredinReplyToPostIdanyrequiredlinksarray<object>requiredItem fields
urlstringrequiredexpandedUrlstring | nullrequiredtitlestring | nullrequireddescriptionstring | nullrequired
hashtagsarray<string>requiredmentionsarray<string>requiredcashtagsarray<string>requiredpossiblySensitivebooleanrequiredmediaCountnumberrequiredmediaarray<object>requiredItem fields
keystringrequiredtypestringrequiredone of
photo,video,animated_gifurlstring | nullrequiredpreviewImageUrlstring | nullrequiredaltTextstring | nullrequiredwidthnumber | nullrequiredheightnumber | nullrequireddurationMsnumber | nullrequiredvariantsarray<object>required
rootobject | nullrequiredFields
idstringrequiredurlstringrequiredtextstringrequiredcreatedAtstring | nullrequiredlangstring | nullrequiredauthorobject | nullrequiredFields
idstringrequiredhandlestring | nullrequirednamestring | nullrequiredverifiedbooleanrequiredfollowersnumber | nullrequiredprofileImageUrlstring | nullrequiredbiostring | nullrequired
metricsobjectrequiredFields
likesnumberrequiredrepostsnumberrequiredrepliesnumberrequiredquotesnumberrequiredbookmarksnumberrequiredimpressionsnumber | nullrequired
conversationIdstring | nullrequiredinReplyToPostIdstring | nullrequiredlinksarray<object>requiredItem fields
urlstringrequiredexpandedUrlstring | nullrequiredtitlestring | nullrequireddescriptionstring | nullrequired
hashtagsarray<string>requiredmentionsarray<string>requiredcashtagsarray<string>requiredpossiblySensitivebooleanrequiredmediaCountnumberrequiredmediaarray<object>requiredItem fields
keystringrequiredtypestringrequiredone of
photo,video,animated_gifurlstring | nullrequiredpreviewImageUrlstring | nullrequiredaltTextstring | nullrequiredwidthnumber | nullrequiredheightnumber | nullrequireddurationMsnumber | nullrequiredvariantsarray<object>requiredItem fields
urlstringrequiredcontentTypestringrequiredbitRatenumber | nullrequired
referencedPostsarray<object>requiredItem fields
typestringrequiredone of
replied_to,quoted,retweetedidstringrequiredpostobject | nullrequiredFields
idstringrequiredurlstringrequiredtextstringrequiredcreatedAtanyrequiredlanganyrequiredauthoranyrequiredmetricsobjectrequiredFields
likesnumberrequiredrepostsnumberrequiredrepliesnumberrequiredquotesnumberrequiredbookmarksnumberrequiredimpressionsnumber | nullrequired
conversationIdanyrequiredinReplyToPostIdanyrequiredlinksarray<object>requiredItem fields
urlstringrequiredexpandedUrlstring | nullrequiredtitlestring | nullrequireddescriptionstring | nullrequired
hashtagsarray<string>requiredmentionsarray<string>requiredcashtagsarray<string>requiredpossiblySensitivebooleanrequiredmediaCountnumberrequiredmediaarray<object>requiredItem fields
keystringrequiredtypestringrequiredone of
photo,video,animated_gifurlstring | nullrequiredpreviewImageUrlstring | nullrequiredaltTextstring | nullrequiredwidthnumber | nullrequiredheightnumber | nullrequireddurationMsnumber | nullrequiredvariantsarray<object>required
threadarray<object>requiredItem fields
idstringrequiredurlstringrequiredtextstringrequiredcreatedAtstring | nullrequiredlangstring | nullrequiredauthorobject | nullrequiredFields
idstringrequiredhandlestring | nullrequirednamestring | nullrequiredverifiedbooleanrequiredfollowersnumber | nullrequiredprofileImageUrlstring | nullrequiredbiostring | nullrequired
metricsobjectrequiredFields
likesnumberrequiredrepostsnumberrequiredrepliesnumberrequiredquotesnumberrequiredbookmarksnumberrequiredimpressionsnumber | nullrequired
conversationIdstring | nullrequiredinReplyToPostIdstring | nullrequiredlinksarray<object>requiredItem fields
urlstringrequiredexpandedUrlstring | nullrequiredtitlestring | nullrequireddescriptionstring | nullrequired
hashtagsarray<string>requiredmentionsarray<string>requiredcashtagsarray<string>requiredpossiblySensitivebooleanrequiredmediaCountnumberrequiredmediaarray<object>requiredItem fields
keystringrequiredtypestringrequiredone of
photo,video,animated_gifurlstring | nullrequiredpreviewImageUrlstring | nullrequiredaltTextstring | nullrequiredwidthnumber | nullrequiredheightnumber | nullrequireddurationMsnumber | nullrequiredvariantsarray<object>requiredItem fields
urlstringrequiredcontentTypestringrequiredbitRatenumber | nullrequired
referencedPostsarray<object>requiredItem fields
typestringrequiredone of
replied_to,quoted,retweetedidstringrequiredpostobject | nullrequiredFields
idstringrequiredurlstringrequiredtextstringrequiredcreatedAtanyrequiredlanganyrequiredauthoranyrequiredmetricsobjectrequiredFields
likesnumberrequiredrepostsnumberrequiredrepliesnumberrequiredquotesnumberrequiredbookmarksnumberrequiredimpressionsnumber | nullrequired
conversationIdanyrequiredinReplyToPostIdanyrequiredlinksarray<object>requiredItem fields
urlstringrequiredexpandedUrlstring | nullrequiredtitlestring | nullrequireddescriptionstring | nullrequired
hashtagsarray<string>requiredmentionsarray<string>requiredcashtagsarray<string>requiredpossiblySensitivebooleanrequiredmediaCountnumberrequiredmediaarray<object>requiredItem fields
keystringrequiredtypestringrequiredone of
photo,video,animated_gifurlstring | nullrequiredpreviewImageUrlstring | nullrequiredaltTextstring | nullrequiredwidthnumber | nullrequiredheightnumber | nullrequireddurationMsnumber | nullrequiredvariantsarray<object>required
repliesarray<object>requiredItem fields
idstringrequiredurlstringrequiredtextstringrequiredcreatedAtstring | nullrequiredlangstring | nullrequiredauthorobject | nullrequiredFields
idstringrequiredhandlestring | nullrequirednamestring | nullrequiredverifiedbooleanrequiredfollowersnumber | nullrequiredprofileImageUrlstring | nullrequiredbiostring | nullrequired
metricsobjectrequiredFields
likesnumberrequiredrepostsnumberrequiredrepliesnumberrequiredquotesnumberrequiredbookmarksnumberrequiredimpressionsnumber | nullrequired
conversationIdstring | nullrequiredinReplyToPostIdstring | nullrequiredlinksarray<object>requiredItem fields
urlstringrequiredexpandedUrlstring | nullrequiredtitlestring | nullrequireddescriptionstring | nullrequired
hashtagsarray<string>requiredmentionsarray<string>requiredcashtagsarray<string>requiredpossiblySensitivebooleanrequiredmediaCountnumberrequiredmediaarray<object>requiredItem fields
keystringrequiredtypestringrequiredone of
photo,video,animated_gifurlstring | nullrequiredpreviewImageUrlstring | nullrequiredaltTextstring | nullrequiredwidthnumber | nullrequiredheightnumber | nullrequireddurationMsnumber | nullrequiredvariantsarray<object>requiredItem fields
urlstringrequiredcontentTypestringrequiredbitRatenumber | nullrequired
referencedPostsarray<object>requiredItem fields
typestringrequiredone of
replied_to,quoted,retweetedidstringrequiredpostobject | nullrequiredFields
idstringrequiredurlstringrequiredtextstringrequiredcreatedAtanyrequiredlanganyrequiredauthoranyrequiredmetricsobjectrequiredFields
likesnumberrequiredrepostsnumberrequiredrepliesnumberrequiredquotesnumberrequiredbookmarksnumberrequiredimpressionsnumber | nullrequired
conversationIdanyrequiredinReplyToPostIdanyrequiredlinksarray<object>requiredItem fields
urlstringrequiredexpandedUrlstring | nullrequiredtitlestring | nullrequireddescriptionstring | nullrequired
hashtagsarray<string>requiredmentionsarray<string>requiredcashtagsarray<string>requiredpossiblySensitivebooleanrequiredmediaCountnumberrequiredmediaarray<object>requiredItem fields
keystringrequiredtypestringrequiredone of
photo,video,animated_gifurlstring | nullrequiredpreviewImageUrlstring | nullrequiredaltTextstring | nullrequiredwidthnumber | nullrequiredheightnumber | nullrequireddurationMsnumber | nullrequiredvariantsarray<object>required
truncatedbooleanrequirednotesarray<string>requiredusageobjectrequiredFields
postsReturnednumberrequiredpostsChargednumberrequiredcreditsUsednumberrequired
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/marketing/x-posts/thread" \ -H "Authorization: Bearer $ADVENTURAI_TOKEN" \ -H "Content-Type: application/json" \ -d '{"post":"string"}'