X

X (Twitter) operations

Create an X (Twitter) post or thread request

post

Creates a request to generate and publish a tweet or thread from various content sources. Supports immediate execution or scheduling.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
anyOptional
or
anyOptional
or
anyOptional
or
anyOptional
or
anyOptional
or
anyOptional
or
anyOptional
Responses
chevron-right
200

Request accepted

application/json
Responseone of
or
post
/x/post

Quick-create an X (Twitter) post or thread

post

Minimal input endpoint. Provide type and either queryText or queryAudioFile, optionally an image.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
typestring ยท enumRequired

Whether to create a single tweet or a thread

Example: tweetPossible values:
queryTextstringOptional

Text query to drive the generation (required if queryAudioFile not provided)

Example: Top 3 AI news today in an engaging tone
tweetStylestring ยท enumOptional

Optional formatting style for the tweet. OneLiner for concise tweets, Paragraphs for story-style tweets, Explainer for educational content. If not specified, a random style will be selected.

Example: ParagraphsPossible values:
countinteger ยท min: 1 ยท max: 10Optional

Number of tweets/threads to generate (default 1)

Example: 3
deepResearchbooleanOptional

If true, triggers deep research to gather additional context and insights before generating the tweet/thread. This enhances the content with supporting evidence, implications, and key learnings.

Example: false
queryAudioFilestring ยท binaryOptional

Optional audio file to upload and transcribe as the query (required if queryText not provided)

imageFilestring ยท binaryOptional

Optional image to upload and include context from

Responses
chevron-right
200

Request accepted

application/json
post
/x/post/quick

Refine an existing X (Twitter) post

post

Refines an existing tweet based on user instructions while maintaining context. Costs 1 credit. Can update the tweet text and any associated data tables or charts.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
tweetIdstringRequired

The unique ID of the tweet to refine

Example: 550e8400-e29b-41d4-a716-446655440000
promptstringOptional

Instructions for how to refine the tweet

Example: Make it more engaging and add relevant emojis
promptAudioUrlstringOptional

URL to an audio file to transcribe and use as refinement instructions. Required if prompt is not provided.

Example: https://example.com/refinement-audio.mp3
Responses
chevron-right
200

Tweet refined successfully

application/json
post
/x/refine

Get generated X (Twitter) posts for the authenticated user

get

Returns the list of generated X posts and threads, including visualization image URLs when available. Supports optional pagination.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageinteger ยท min: 1Optional

Page number for pagination (starts at 1). If not provided, returns all results.

Example: 1
limitinteger ยท min: 1 ยท max: 100Optional

Number of items per page (max 100, default 50 if page is specified)

Example: 20
Responses
chevron-right
200

Successfully retrieved X posts

application/json
get
/x/posts

Get a single generated X (Twitter) post by ID

get

Returns a single generated tweet or thread item belonging to the authenticated user by its unique ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The unique ID of the post to retrieve

Example: 550e8400-e29b-41d4-a716-446655440000
Responses
chevron-right
200

Successfully retrieved the X post

application/json
get
/x/posts/{id}

Get recurring X (Twitter) templates

get

Returns all recurring tweet/thread templates for the authenticated user with their configuration and scheduling details.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
chevron-right
200

Successfully retrieved recurring templates

application/json
get
/x/recurring

Update a recurring X (Twitter) template

post

Updates specific fields of a recurring template. Can be used to pause/resume, change frequency, update end date, or modify prompt.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The unique ID of the recurring template to update

Example: 550e8400-e29b-41d4-a716-446655440000
Body
promptstringOptional

New style instructions for generation

Example: Use a more professional tone
dailyCountinteger ยท min: 1 ยท max: 100Optional

New number of executions per day

Example: 3
scheduleEndDatestring ยท date-time ยท nullableOptional

New end date for the recurring executions (null to remove end date)

Example: 2025-01-31T23:59:59Z
isActivebooleanOptional

Set to false to pause the recurring template, true to resume

Example: false
feedIdsinteger[]Optional

Feed IDs to use as content sources (replaces existing)

Example: [101,202]
deepResearchIdsstring[]Optional

Deep research template IDs to use as content sources (replaces existing)

Example: ["550e8400-e29b-41d4-a716-446655440000"]
Responses
chevron-right
200

Recurring template updated successfully

application/json
post
/x/recurring/{id}

Last updated