Writer AI Studio

Docs

• AGENTS
• Understand agent architecture: Understand how Agent Builder agents work. Learn about UI components, blueprints, state management, and how they connect to create functional agents.
• Trigger blueprints via API: Enable external systems to trigger blueprints via HTTP API calls. Integrate agents with webhooks, schedulers, and third-party services programmatically.
• Build a chatbot connected to a Knowledge Graph
• Collaborate on agents
• Add styling to the agent UI
• Build data tables with DataFrames
• Agent Builder Demo Application: Explore the Agent Builder demo agent that analyzes customer reviews and drafts responses. Learn how UI, blueprints, and state variables work together.
• Deploy with Docker: Deploy Agent Builder agents with Docker containers. Run agents on cloud platforms, on-premises servers, or local development machines.
• Using data from previous blocks: Pass data between blocks in Agent Builder blueprints. Access state variables, secrets, and results from preceding blocks with execution environment.
• Process invoices and send to Slack
• Create and test agents locally: Develop Agent Builder agents offline on your local machine with Writer Framework. Test agents locally before deploying to Writer Cloud.
• Learn about Agent Builder: Build AI agents with a low-code visual editor. Collaborate with drag-and-drop blocks for tool calling, RAG, and custom workflows.
• Add custom Python code
• Python libraries installed in Agent Builder: View all Python packages available in Agent Builder including aiohttp, boto3, pandas, requests, and 50+ other libraries with version numbers.
• Access secrets in Python code
• Agent Builder Quickstart: Build your first agent in Agent Builder. Create a meeting notes summarizer with a visual interface and blueprint in this step-by-step tutorial.
• Build dynamic UI components with Repeaters: Display dynamic lists of data in Agent Builder UI with Repeaters. Create repeating components for lists, dictionaries, and nested data structures.
• Store secrets with Vault: Store API keys, passwords, and credentials securely with Vault in Agent Builder. Reference secrets in blueprints and Python code.
• Manage agent state
• Upload, parse, and summarize PDFs: Build a PDF research paper summarizer with Agent Builder. Upload PDFs, parse content, and generate summaries for specific personas.
• Sync agents between local and cloud
• Use tool calling in Agent Builder: Add tool calling to Agent Builder blueprints and chatbots. Connect Knowledge Graphs and define custom functions with JSON Schema.
• Understand tool calling: Learn how tool calling enables dynamic agent workflows. Understand ReAct patterns and why tool calling matters for intelligent agent orchestration.
• Tool calling with external APIs
• Troubleshoot common issues
• Get your organization subscription details
• Detect If the content is AI generated
• Post contentorganization team check
• Post contentorganization team correct
• Get cowriteorganization team template
• Post cowriteorganization team generate
• Delete snippets
• Find snippets
• Update snippets
• List your styleguide pages
• Page details
• Add terms
• Delete terms
• Find terms
• Update terms
• List users
• Manage API keys: Learn how to create, manage, and delete API keys.
• Application details: Retrieves detailed information for a specific no-code agent (formerly called no-code applications), including its configuration and current status.
• Retrieve all jobs: Retrieve all jobs created via the async API, linked to the provided application ID (or alias).
• Generate from application: Generate content from an existing no-code agent (formerly called no-code applications) with inputs.
• Generate from application (async): Generate content asynchronously from an existing no-code agent (formerly called no-code applications) with inputs.
• Retrieve graphs: Retrieve Knowledge Graphs associated with a no-code agent that has chat capabilities.
• Retrieve a single job: Retrieves a single job created via the Async API.
• List applications: Retrieves a paginated list of no-code agents (formerly called no-code applications) with optional filtering and sorting capabilities.
• Retry job execution: Re-triggers the async execution of a single job previously created via the Async api and terminated in error.
• Associate graphs: Updates the list of Knowledge Graphs associated with a no-code chat agent.
• Chat completion: Generate a chat completion based on the provided messages. The response shown below is for non-streaming. To learn about streaming responses, see the chat completion guide.
• List models: Retrieve a list of available models that can be used for text generation, chat completions, and other AI tasks.
• Text generation: Generate text completions using the specified model and prompt. This endpoint is useful for text generation tasks that don't require conversational context.
• Understand error codes
• Handle errors
• Delete file: Permanently delete a file from the system. This action cannot be undone.
• Download file: Download the binary content of a file. The response will contain the file data in the appropriate MIME type.
• Retry failed files: Retry processing of files that previously failed to process. This will re-attempt the processing of the specified files.
• List files: Retrieve a paginated list of files with optional filtering by status, graph association, and file type.
• Retrieve file: Retrieve detailed information about a specific file, including its metadata, status, and associated graphs.
• Upload file: Upload a new file to the system. Supports various file formats including PDF, DOC, DOCX, PPT, PPTX, JPG, PNG, EML, HTML, SRT, CSV, XLS, and XLSX.
• Add file to graph: Add a file to a Knowledge Graph.
• Create graph: Create a new Knowledge Graph.
• Delete graph: Delete a Knowledge Graph.
• List graphs: Retrieve a list of Knowledge Graphs.
• Question: Ask a question to specified Knowledge Graphs.
• Remove file from graph: Remove a file from a Knowledge Graph.
• Retrieve graph: Retrieve a Knowledge Graph.
• Update graph: Update the name and description of a Knowledge Graph.
• Migrate from medical comprehend API to LLM tool
• Migrate from translation API to translation tool
• Migrate from web search API to web search tool
• Paginate API results
• Understand rate limits: Understand API rate limits for Writer endpoints. Learn about RPM and TPM limits, best practices, and retry strategies for optimal performance.
• Secure your integration
• Parse PDF: Parse PDF to other formats.
• Web search: Search the web for information about a given query and return relevant results with source URLs.
• View supported languages
• Translate text: Translate text from one language to another.
• Analyze images: Submit images and documents with a prompt to generate an analysis. Supports JPG, PNG, PDF, and TXT files up to 7MB each.
• Add files to Writer Cloud
• Add to Knowledge Graph
• Add to state list
• AI Studio Agent
• API Trigger
• Ask graph question
• Change page
• Chat reply
• Classification
• For-each loop
• HTTP Request
• If-Else
• Key-Value Storage
• Log message
• Parse JSON
• Parse PDF tool
• Python code
• Return value
• Run blueprint
• Set state
• Structured output
• Text generation
• Tool calling
• UI Trigger
• Annotated Text
• Button
• Chatbot
• Checkbox Input
• Column
• Column Container
• DataFrame
• Date Input
• File Input
• Heading
• Horizontal Stack
• HTML Element
• IFrame
• Image
• JSON Viewer
• Link
• Message
• Metric
• Multiselect Input
• Number Input
• Page
• Pagination
• PDF
• Plotly Graph
• Progress Bar
• Radio Input
• Slider Range Input
• Rating Input
• Repeater
• Reuse Component
• Root
• Section
• Select Input
• Separator
• Sidebar
• Slider Input
• Step
• Step Container
• Switch Input
• Tab
• Tab Container
• Tags
• Text
• Text area Input
• Text Input
• Time Input
• Timer
• Video Player
• Adobe Experience Manager connector: Connect WRITER Agent to Adobe Experience Manager to manage AEM content, sites, pages, content fragments, assets, launches, and Cloud Manager infrastructure
• Asana connector: Connect WRITER Agent to Asana for workspaces, tasks, projects, and workload insights
• Atlassian connector: Connect WRITER Agent to Atlassian to access Jira and Confluence content and manage work items and pages
• Databricks connector: Connect WRITER Agent to Databricks using MCP to access SQL, Unity Catalog functions, and Genie spaces
• FactSet connector: Connect WRITER Agent to FactSet to access financial data, equity fundamentals, and market analytics
• Gmail connector: Connect WRITER Agent to Gmail to manage emails, search messages, and automate email workflows
• Gong connector: Connect WRITER Agent to Gong to access call transcripts, meeting summaries, and sales analytics
• Google BigQuery connector: Connect WRITER Agent to Google BigQuery to securely query and analyze data in your BigQuery data warehouse
• Google Calendar connector: Connect WRITER Agent to Google Calendar to manage events, schedule meetings, and automate calendar workflows
• Google Docs connector: Connect WRITER Agent to Google Docs to read, edit, and manage documents
• Google Drive connector: Connect WRITER Agent to Google Drive to manage files, folders, and sharing across My Drive and shared drives
• Google Sheets connector: Connect WRITER Agent to Google Sheets to read, update, and analyze spreadsheet data
• HubSpot connector: Connect WRITER Agent to HubSpot to access CRM data, contacts, deals, and pipeline insights
• Microsoft Calendar connector: Connect WRITER Agent to Microsoft Calendar to manage events and schedules
• Microsoft OneDrive connector: Connect WRITER Agent to OneDrive to access and manage files and folders
• Microsoft Outlook connector: Connect WRITER Agent to Microsoft Outlook to manage emails and communications
• Microsoft SharePoint connector: Connect WRITER Agent to SharePoint to access sites, documents, and collaboration content
• Microsoft Teams connector: Connect WRITER Agent to Microsoft Teams to access channels, messages, and team collaboration
• PitchBook connector: Connect WRITER Agent to PitchBook to access private market data and investment analytics
• Salesforce Data Cloud connector: Connect WRITER Agent to Salesforce Data Cloud to query and access unified customer data
• Salesforce Platform API connector: Connect WRITER Agent to Salesforce to access platform APIs, including CRM objects, metadata, queries, and invocable actions
• Salesforce Revenue Cloud connector: Connect WRITER Agent to Salesforce Revenue Cloud to manage quotes, orders, and asset lifecycle
• Semrush connector: Connect WRITER Agent to Semrush to access SEO, keyword, traffic, and competitive research data
• Slack connector: Connect WRITER Agent to Slack to search messages, manage channels, and automate team communication
• Snowflake connector: Connect WRITER Agent to Snowflake to access SQL analytics, Cortex tools, object metadata, and semantic views
• Writer AI module
• Application state
• Authentication
• Backend-driven UI
• Backend-initiated actions
• Builder basics
• Chat assistant
• Deploy to Writer Cloud
• Components
• Custom components
• Custom server
• Dataframe
• Deploy with Docker
• Event handlers
• Frontend scripts
• Handling inputs
• Writer Framework
• Page routes
• Product description generator
• Quickstart
• Quickstart tutorial
• Release notes generator
• Repeater
• Sample app library
• SEO and social sharing
• Sessions
• Social post generator
• State schema
• Stylesheets
• Testing
• Account management
• Agent Builder
• Monitor agent performance: Monitor agent performance with session logs and observability metrics in AI Studio. Track usage, analyze conversations, and debug agent behavior.
• Analyze images: Analyze single or multiple images with Palmyra Vision. Ask questions about images, generate captions, and compare images using the vision endpoint.
• API Reference
• Invoke no-code agents via the API: Turn deployed no-code agents into microservices with the Applications API. Use text generation and research agents as tools in your applications.
• Use no-code agents as tools
• Run agents asynchronously: Process no-code agent requests asynchronously or in batches with the async applications API. Generate content for multiple items efficiently.
• Engineering Blog
• Changelog: Stay up to date with the latest changes to the Writer API and SDKs.
• Generate chat completions: Create multi-turn conversations with AI using the chat completion API. Preserve conversation context and use tool calling for advanced features.
• Add images to chat completions
• Cookbooks
• Custom connectors: Create custom connectors from OpenAPI specifications or MCP servers to extend WRITER Agent with your own APIs and tools
• Choose your development path: Choose your development path for AI agents. Compare no-code builder, Agent Builder, and Writer API/SDKs for customization and technical requirements.
• Encryption Key Management: Control encryption keys for data at rest with Writer-managed or customer-managed (BYOK) encryption across your organization.
• Event logs: View, filter, search, and export request-level logs to debug issues and audit agent activity in AI Studio.
• Add external models: Configure external AI models from providers like AWS Bedrock, Microsoft Azure, or NVIDIA NIM to use alongside Palmyra models in AI Studio
• Manage files: Upload, download, list, and delete files with the File API. Use files in Knowledge Graphs and no-code agents.
• Understand generative AI: Learn how generative AI works and how to leverage Writer's models, safety, and best practices for building AI-powered applications.
• Configure guardrails: Configure guardrails to monitor and filter AI agent inputs and outputs for safety and compliance
• Set up Azure Content Safety guardrails: Configure Azure AI Content Safety for text moderation and prompt injection detection
• Set up Bedrock guardrails: Configure AWS Bedrock Guardrails for content filtering and sensitive data protection
• Help Center
• Work with inline citations in Knowledge Graph responses
• Explore integrations
• Invoke Palmyra models on Amazon Bedrock
• Structured output with Instructor
• Using Writer with LangChain
• Using Writer with OpenLLMetry: Monitor and debug Writer API calls with OpenLLMetry. Export traces to Jaeger, Datadog, New Relic, or Traceloop for LLM observability.
• Using Writer with AWS Strands Agents
• Writer AI Studio: Build, deploy, and manage AI agents with enterprise controls
• Use a Knowledge Graph in a chat: Query Knowledge Graphs during chat completions with tool calling. Reference multiple graphs and configure query parameters for accurate responses.
• Ask questions to Knowledge Graphs
• Create and manage a Knowledge Graph: Integrate graph-based RAG into your agents with Knowledge Graph API. Achieve higher accuracy than traditional vector-based retrieval methods.
• Connect your data to AI with Knowledge Graph: Understand graph-based RAG with Knowledge Graph. Learn how content ingestion, graph construction, and query processing deliver accurate AI responses.
• Configure Knowledge Graph query parameters
• Create and manage Knowledge Graphs
• Language support: Palmyra LLM supports 30+ languages including Arabic, French, Spanish, Hindi, and Chinese. View MMLU and BLEU benchmark scores for multilingual text generation.
• Configure connectors: Configure prebuilt and custom connectors for WRITER Agent to securely access enterprise tools and your own APIs
• MCP server
• Mitigate bias in AI outputs
• Use another LLM as a tool
• Configure model parameters
• Choose a model: Choose the right Palmyra model for your needs. Compare capabilities, context windows, and pricing for X5, Fin, Med, Creative, and Vision models.
• Choose a model: Compare Writer's Palmyra models with external provider models to select the best fit for your AI agents
• Observability overview: Monitor events, errors, and performance across your AI Studio deployment
• Palmyra Med vocabularies and entities
• Parse a PDF
• Configure plugins: Stream telemetry and security data from AI Studio to your existing monitoring platforms with observability and security plugins.
• Datadog Logs plugin: Send logs and metrics to Datadog for monitoring your AI Studio platform and agents.
• Pricing: View pricing for Writer AI models. Compare costs per million tokens for Palmyra models including X5, X4, Med, Fin, Creative, and Vision.
• Private endpoints: Connect WRITER Agent to connectors over a private network using AWS PrivateLink or GCP Private Service Connect
• Secure prompts against attacks
• Write effective prompts: Master prompting fundamentals and advanced techniques. Learn directive writing, context inclusion, few-shot prompting, and chain-of-thought reasoning.
• Quickstart: Make your first API call to Writer. Create an API key and generate text using the chat completion endpoint in minutes.
• Research
• SDKs: Install and use Writer SDKs for Python and Node.js. Get started with code examples and learn how to integrate Writer AI into your applications.
• Set up BYOK encryption: Connect your own KMS from AWS, Azure, or GCP to control encryption keys for your Writer organization.
• Stream responses from the API: Stream API responses in real-time with Server-Sent Events. Reduce latency and display generated content as it's created for better user experience.
• Receive structured outputs
• Column test
• Generate text from a prompt: Generate text using the text generation endpoint. Compare text generation vs chat completion and see API examples.
• Understand tokens
• Call a custom function in a chat: Extend LLM capabilities with tool calling. Execute custom functions, query databases, fetch real-time data, and integrate results into chat responses.
• Toxic check
• Translate text
• Translate text in a chat
• Transparency
• Usage and spend: Track organization-wide costs, token usage, and consumption trends across all agents
• Usage policy
• Analyze images in a chat
• Add web content to a Knowledge Graph
• Search the web
• Web search in a chat: Search the web for real-time information during chat completions. Enable models to access current news, facts, and up-to-date data.
• Chat
• Chat with Knowledge Graph
• Choose your use case
• Deploy an agent
• Create an earnings call agent
• Edit an agent
• No-code agents: Build AI agents without code to automate tasks, create branded content, and develop knowledge assistants using your company data.
• Create a newsletter generation agent
• Research
• Text generation
• AWS Bedrock: Add AI models from AWS Bedrock to use in AI Studio agents
• Microsoft Azure: Add AI models from Microsoft Azure to use in AI Studio agents
• NVIDIA NIM: Add AI models from NVIDIA NIM to use in AI Studio agents

OpenAPI Specs

• gateway-api-schema
• gateway-api-schema.documented
• legacy