Writer API

Hosted Palmyra enterprise models with tool calling and Knowledge Graph retrieval.

Provider: default
Kind: AI service
Category: Compute
Official docs: https://dev.writer.com/api-reference/rate-limits
Also known as: Palmyra, Writer AI Studio

Properties · 7 set by this component

property	type	values	required	kind default	this component
auth	enum	api-key \| oauth \| iam \| none	no	—	▸ api-key
contentFiltering	boolean	—	no	—	inherited
customRateLimits · component property	boolean	—	no	false	inherited
customerManagedKeys	boolean	—	no	—	▸ false
dataResidency · advanced	enum	us \| eu \| asia \| global	no	—	inherited
dataRetentionDays	integer	—	no	—	inherited
keyStore	boolean	—	no	false	inherited
knowledgeGraph · component property	boolean	—	no	false	inherited
managed	boolean	—	no	false	▸ true
modality	enum	text \| vision \| speech \| multimodal \| structured \| image \| video \| audio \| embedding \| rerank	no	—	▸ multimodal
publicEndpoint	boolean	—	no	—	▸ true
quotaUnitsPerMinute	integer	—	no	—	inherited
rateLimitRpm · advanced	integer	—	no	—	▸ 400
rateLimitTpm · advanced	integer	—	no	—	▸ 25000
viaGateway	boolean	—	no	false	inherited

Rules that apply · 2

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

AI API key not managedwarning

ai-api-key-unmanaged

This AI vendor is reached with an API key, and nothing in the design holds or rotates that key. It ends up in environment files or code, every caller shares it, and a single leak runs up the vendor bill until someone notices. Put the key in a key-management component, or say it is held there with keyStore.

— all of these hold:
— the node's `auth` is "api-key"
— the node's `keyStore` is false
— the node has at least one incoming edge from an app-server, worker or client
— this does not hold:
— the design contains a node of kind key-management

Stateful node without zone redundancyerror

stateful-node-without-zone-redundancy

A stateful compute node pinned to exactly one availability zone disappears with that zone, and its state goes with it. Nodes inside a cell are exempt, because there the cell is deliberately single-zone and redundancy comes from the other cells.

— all of these hold:
— the node's `stateless` is false
— the node sits inside exactly 1 availability-zone group
— this does not hold:
— the node sits inside at least one cell group

Use it in a design

nodes:
  - { id: "writer-api", component: "writer-api" }

Other AI service products · 125

and 85 more → AI service page

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# Writer API: hosted Palmyra enterprise models (chat, tool calling, Knowledge Graph RAG, vision) over a public endpoint.
3# Per "Understand rate limits", endpoints enforce 400 requests and 25,000 tokens per minute unless Sales sets custom
4# limits; per "Encryption Key Management", customer-managed (BYOK) keys are an Enterprise-plan option.
5schemaVersion: "1"
6type: "component"
7id: "writer-api"
8kind: "ai-service"
9provider: "default"
10docs: "https://dev.writer.com/api-reference/rate-limits"
11aliases: ["Palmyra", "Writer AI Studio"]
12defaults:
13  auth: "api-key"
14  managed: true
15  modality: "multimodal"
16  publicEndpoint: true
17  rateLimitRpm: 400
18  rateLimitTpm: 25000
19  customerManagedKeys: false
20properties:
21  knowledgeGraph:
22    type: "boolean"
23    default: false
24  customRateLimits:
25    type: "boolean"
26    default: false

The same page as markdown, for an agent: /catalogue/components/writer-api.md