Skip to main content
Markdown files are useful for README files, API docs, project notes, meeting notes, knowledge base entries, and changelogs. Moxus AI supports .md and .markdown uploads in Conversation. For API calls, read the Markdown content and place it in the message text.

Supported paths

Conversation upload

Upload a .md or .markdown file in Conversation. The file is read as text and sent with the current message.

API call

Read the Markdown file in your backend and append its content to messages.content.

File rules

Markdown files are not sent as image_url parts like images, and they are not sent as file objects like PDFs. They are read as text and appended to the user message.

Use in Conversation

1

Open Conversation

Sign in, open Conversation, and choose a model that can handle long text.
2

Upload a Markdown file

Click the attachment button in the input box and choose a .md or .markdown file. The file appears in the attachment area.
3

Describe the task

Tell the model what to do, such as summarize the document, extract API sections, review a changelog, or rewrite the content.
4

Send and review

The Markdown content is sent with your message. After the request, open Usage to review the call and cost.

API example

For API calls, read the Markdown file in your program and include its content in messages.content. Put the Markdown file in the project root: the folder containing the .py or .mjs file and where you run the command. MARKDOWN_PATH = "README.md" is the filename to read. If your file is named notes.md, change it to MARKDOWN_PATH = "notes.md". The name, extension, and letter case must match exactly. Use the full local path when the file is outside the project root. You do not upload the Markdown file separately: the code reads its text and sends it in the request. Install the SDK for the Python example first:
For the Node.js example, choose either npm or pnpm. If py is unavailable on Windows, install the Python dependency with python -m pip install openai.

Recommendations

  • Remove unrelated logs, repeated tables of contents, and generated content before sending long files.
  • Keep headings, section names, and list numbers when you need traceable answers.
  • Use Structured output when you need JSON or predictable fields.
  • If you send images, PDFs, and Markdown together, describe the role of each attachment in your prompt.
Markdown files may contain internal links, example keys, config snippets, or private code. Remove sensitive content before uploading or sending it through the API.

Next steps