Inference Logoinference shell
apps/x/article-publish

article-publish

Publish long-form articles on X.com from markdown. Supports headings, lists, blockquotes, code blocks, GFM tables, LaTeX, images, embedded tweets, and inline formatting (bold, italic, strikethrough, links). Optional cover image and draft-only mode.

run in browser →run via API
run with your agent
# install belt
$curl -fsSL https://cli.inference.sh | sh
# view schema & details
$belt app get x/article-publish
# run
$belt app run x/article-publish

api reference

about

publish long-form articles on x.com from markdown. supports headings, lists, blockquotes, code blocks, gfm tables, latex, images, embedded tweets, and inline formatting (bold, italic, strikethrough, links). optional cover image and draft-only mode.

1. calling the api

install the client

the client provides a convenient way to interact with the api.

bash
1pip install inferencesh

setup your api key

set INFERENCE_API_KEY as an environment variable. get your key from settings → api keys.

bash
1export INFERENCE_API_KEY="inf_your_key"

run and get result

submit a request and wait for the final result. best for batch processing or when you don't need progress updates.

python
1from inferencesh import inference23client = inference()456result = client.run({7        "app": "x/article-publish",8        "input": {}9    })1011print(result["output"])

stream live updates

get real-time progress updates as the task runs. ideal for showing progress bars, partial results, or long-running tasks.

python
1from inferencesh import inference23client = inference()456# stream=True yields updates as they arrive7for update in client.run({8        "app": "x/article-publish",9        "input": {}10    }, stream=True):11    if update.get("progress"):12        print(f"progress: {update['progress']}%")13    if update.get("output"):14        print(f"output: {update['output']}")

2. authentication

the api uses api keys for authentication. see the authentication docs for detailed setup instructions.

3. files

file inputs are automatically handled by the sdk. you can pass local paths, urls, or base64 data.

automatic upload

the python sdk automatically detects local file paths and uploads them. urls are passed through as-is.

python
1# local file paths are automatically uploaded2result = client.run({3    "app": "x/article-publish",4    "input": {5        "image": "/path/to/local/image.png",  # detected & uploaded6        "audio": "https://example.com/audio.mp3",  # url passed through7    }8})

manual upload

you can also upload files manually and use the returned url.

python
1# upload and get a hosted URL2file = client.files.upload("/path/to/file.png")3print(file.uri)  # https://cloud.inference.sh/...

4. webhooks

get notified when a task completes by providing a webhook url. when the task reaches a terminal state (completed, failed, or cancelled), a POST request is sent to your url with the task result.

python
1result = client.run({2    "app": "x/article-publish",3    "input": {},4    "webhook": "https://your-server.com/webhook"5}, wait=False)

webhook payload

your endpoint receives a JSON POST with the task result:

json
1{2  "id": "task_abc123",3  "status": 9,4  "output": { ... },5  "error": "",6  "session_id": null,7  "created_at": "2024-01-15T10:30:00Z",8  "updated_at": "2024-01-15T10:30:05Z"9}
idstring— task id
statusnumber— terminal status (9=completed, 10=failed, 11=cancelled)
outputobject— task output (when completed)
errorstring— error message (when failed)
session_idstring— session id (if using sessions)
created_atstring— iso timestamp
updated_atstring— iso timestamp

5. schema

input

titlestring*

article title (headline)

minLength:1
contentstring*

article body in markdown. supports # headings, **bold**, *italic*, ~~strikethrough~~, `code`, [links](url), lists, blockquotes, fenced code blocks, gfm tables, $$latex$$, horizontal rules. reference uploaded media as ![alt](file:0), ![alt](file:1). embed tweets as {{tweet:id}}.

minLength:1
cover_imagestring(file)

cover image displayed at the top of the article

mediaarray

media files referenced in content as file:0, file:1, etc. supports images (jpg, png, webp, gif) and video (mp4).

publishboolean

publish immediately. set false to save as draft only.

default: true

output

article_idstring*

id of the created article

post_idstring

id of the post created on publish

post_urlstring

url of the post created on publish

publishedboolean*

whether the article was published

titlestring*

article title

ready to run article-publish?

try in browserbrowse all tools

we use cookies

we use cookies to ensure you get the best experience on our website. for more information on how we use cookies, please see our cookie policy.

by clicking "accept", you agree to our use of cookies.
learn more.