Changelog - Writer AI Studio

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

2026-06-02

Python and Node SDK v3.0.0

Released version 3.0.0 of the Python and Node SDKs

Version 3.0.0 of the Python and Node SDKs includes the following changes:

See below for more details about each of these changes.

Removed API methods

Version 3.0.0 removes the following methods from the Python and Node SDKs. You cannot call these methods in 3.0.0:

If your application uses any of these methods, update your code before upgrading to 3.0.0.

Node SDK

The Node SDK MCP server now only supports code mode. Removed tool schemes:

Removed flags also include --resources, --tags, --client, and related filtering and compatibility options. Before upgrading to 3.0.0, remove those flags from your startup command and invoke the server with npx -y writer-sdk-mcp@latest or node /path/to/mcp/server. Supported flags are --port, --transport, --socket, and --tools=docs.

2026-02-06

Python SDK v2.4.0

Released version 2.4.0 of the Python SDK

Version 2.4.0 of the Python SDK includes updated default retry behavior and Knowledge Graph file upload support.

Default retry behavior

Retry defaults are now:

Override these defaults by passing max_retries when instantiating the client. See the Python SDK documentation for details.

Knowledge Graph file upload support

You can now pass the graphId parameter when uploading files to associate files with a Knowledge Graph during upload. When you provide a graphId, the uploaded file is automatically attached to the specified Knowledge Graph.

Python Example

from pathlib import Path
from writerai import Writer

# Initialize the Writer client. If you don't pass the `api_key` parameter,
# the client looks for the `WRITER_API_KEY` environment variable.
client = Writer()

file_path = Path("<FILE_PATH>")  # Replace with your file path, for example: /path/to/document.pdf
file_name = file_path.name  # Get the filename from the path
file_ = client.files.upload(
  content=file_path.read_bytes(),
  content_disposition=f"attachment; filename={file_name}",  # Replace with your file name, for example: document.pdf
  content_type="application/pdf",
  graph_id="<GRAPH_ID>"  # Replace with your Knowledge Graph ID, for example: 6029b226-1ee0-4239-a1b0-cdeebfa3ad5a
)

print(file_.id)

JavaScript Example

import fs from 'fs';
import { Writer } from "writer-sdk";

// Initialize the Writer client. If you don't pass the `api_key` parameter,
// the client looks for the `WRITER_API_KEY` environment variable.
const client = new Writer();

const file = await client.files.upload({
  content: fs.createReadStream("<FILE_PATH>"),  // Replace with your file path, for example: /path/to/document.pdf
  "Content-Disposition": "attachment; filename=<FILE_NAME>",  // Replace with your file name, for example: document.pdf
  "Content-Type": "application/pdf", // Replace with your file type, for example: application/pdf
  graphId: "<GRAPH_ID>"  // Replace with your Knowledge Graph ID, for example: 6029b226-1ee0-4239-a1b0-cdeebfa3ad5a
});

console.log(file.id);

For more information, see the file management guide.

2025-12-02

External models and guardrails

External models and guardrails now available

You can now add external models from providers like AWS Bedrock to use alongside Palmyra models in AI Studio. You can also configure guardrails from third-party providers such as AWS Bedrock to monitor and filter agent inputs and outputs, helping enforce content safety and compliance.

External models

Add models from AWS Bedrock directly in the AI Studio UI. Once configured, external models appear in the list models endpoint and can be used in chat completions by specifying the model ID. To use an external model, pass its model ID to the model parameter in your API requests:

curl -X POST https://api.writer.com/v1/chat \
  -H "Authorization: Bearer $WRITER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "your-external-model-id",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

For setup instructions, see the external models guide.

Guardrails

Configure AWS Bedrock Guardrails to enforce content safety, PII protection, and compliance policies across your AI agents. Guardrails can evaluate requests before, during, or after model calls. For setup instructions, see the guardrails guide.

2025-10-03

Python and Node SDK v2.3.2

Released version 2.3.2 of the Python and Node SDKs

Version 2.3.2 of the Python and Node SDKs adds support for the following new features:

Knowledge Graph query configuration

Added support for the query_config parameter in both chat completions with Knowledge Graph tools and direct Knowledge Graph queries. This parameter allows you to fine-tune search behavior and control response generation. Key configuration options:

Inline citations

SDK support for inline citations in Knowledge Graph responses, allowing you to programmatically extract and correlate citations with their source material. Citations appear in the format [filename](cite_id) within response text and you can match them with source data from the references object.

Upload types for no-code applications

Added support for the upload_types parameter in no-code applications, allowing you to see which file types you can upload through file input fields. For more details on these features:

2025-09-11

Knowledge Graph query configuration and inline citations

Knowledge Graph query configuration and inline citations

Added comprehensive query configuration options for Knowledge Graph operations, allowing you to fine-tune search behavior and enable inline citations in responses from the Knowledge Graph chat completions tool and direct Knowledge Graph queries.

New query configuration parameters

The query_config parameter is now available for both chat completions with Knowledge Graph tools and direct Knowledge Graph queries. This parameter includes:

For detailed information about all configuration options and their effects, see the Knowledge Graph query configuration guide. For more information about inline citations, see the Work with inline citations in Knowledge Graph responses guide.

2025-08-20

Python and Node SDK v2.3.1

Released version 2.3.1 of the Python and Node SDKs

This patch release fixes a bug introduced in version 2.3.0 where the Graph class wasn’t accessible. The Graph class is now available in the Python and Node SDKs as it was previously. For more information on working with Knowledge Graphs with the Python and Node SDKs, see the Knowledge Graphs usage guide.

2025-08-19

langchain-writer v0.3.3

langchain-writer v0.3.3

The langchain-writer package now includes the web search tool for chat completions. This tool allows you to search the web for current information during a conversation with a Palmyra model. For more details, see the langchain-writer changelog.

2025-08-14

Python and Node SDK v2.3.0

Released version 2.3.0 of the Python and Node SDKs

Version 2.3.0 of the Python and Node SDKs adds support for the following new features:

See below for more details about each of these features.

Web search and web connector URLs

Three new features are now available to enhance your AI applications with web content and search capabilities:

Web search API

The new web search tool API allows you to search the web for current information and get real-time results. This tool is useful for finding factual information, news, and data that may not be available in your model’s training data. Key features:

Web search tool for chat completions

The web search prebuilt tool for chat completions enables your AI assistant to search the web during conversations with Palmyra models. This allows your AI to provide up-to-date information and answer questions about current events.

Web connector URLs for Knowledge Graphs

Web connector URLs allow you to automatically extract and index content from websites into your Knowledge Graphs. This enables you to:

Image support in chat completions

Added support for mixed content in chat completions with Palmyra X5, allowing you to include images directly in your chat messages. This feature enables rich visual conversations without needing to use the separate Vision tool.

2025-08-12

Vision chat support for Palmyra X5

Vision chat support for Palmyra X5

Added support for mixed content in chat completions with Palmyra X5, allowing you to include images directly in your chat messages. This feature enables rich visual conversations without needing to use the separate Vision tool. Key capabilities:

Below is an example of a chat completion request that includes a message with both text and an image.

cURL Example

curl --location 'https://api.writer.com/v1/chat' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $WRITER_API_KEY" \
--data '{
  "model": "palmyra-x5",
  "messages": [\
    {\
      "role": "user",\
      "content": [\
        {\
          "type": "text",\
          "text": "What do you see in this image?"\
        },\
        {\
          "type": "image_url",\
          "image_url": {\
            "url": "https://example.com/image.jpg"\
          }\
        }\
      ]\
    }\
  ]
}'

Python Example

from writerai import Writer

# Initialize the client. If you don't pass the `apiKey` parameter,
# the client looks for the `WRITER_API_KEY` environment variable.
client = Writer()

response = client.chat.chat(
  model="palmyra-x5",
  messages=[\
    {\
      "role": "user",\
      "content": [\
        {\
          "type": "text",\
          "text": "What do you see in this image?"\
        },\
        {\
          "type": "image_url",\
          "image_url": {\
            "url": "https://example.com/image.jpg"\
          }\
        }\
      ]\
    }\
  ]
)

print(response.choices[0].message.content)

JavaScript Example

import { Writer } from "writer-sdk";

// Initialize the client. If you don't pass the `api_key` parameter,
// the client looks for the `WRITER_API_KEY` environment variable.
const client = new Writer();

const response = await client.chat.chat({
  model: "palmyra-x5",
  messages: [\
    {\
      role: "user",\
      content: [\
        {\
          type: "text",\
          text: "What do you see in this image?"\
        },\
        {\
          type: "image_url",\
          image_url: {\
            url: "https://example.com/image.jpg"\
          }\
        }\
      ]\
    }\
  ]
});

console.log(response.choices[0].message.content);

2025-01-27

Web search and web connector URLs released

Web search and web connector URLs released

Three new features are now available to enhance your AI applications with web content and search capabilities:

Web search tool API

The new web search tool API allows you to search the web for current information and get real-time results. This tool is useful for finding factual information, news, and data that may not be available in your model’s training data. Key features:

Web search tool for chat completions

The web search prebuilt tool for chat completions enables your AI assistant to search the web during conversations with Palmyra models. This allows your AI to provide up-to-date information and answer questions about current events.

Web connector URLs for Knowledge Graphs

Web connector URLs allow you to automatically extract and index content from websites into your Knowledge Graphs. This enables you to:

For more information, see the following guides: