Skip to main content
Writer logo
  • Category: artificial intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 23
  • Triggers: 0
  • Slug: WRITER
  • Version: 20261101_00

Tools

Slug: WRITER_ADD_FILE_TO_GRAPHTool to add a file to a knowledge graph for indexing and retrieval. Use when you need to add an uploaded file to an existing knowledge graph for RAG applications.

Input Parameters

string
required
The unique identifier of the file to add to the knowledge graph
string
required
The unique identifier of the knowledge graph to add the file to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_ANALYZE_IMAGESTool to analyze images using Writer’s vision capabilities. Use when you need image understanding, text extraction from images, or visual question answering. Images must be uploaded via POST /v1/files before analysis.

Input Parameters

string
required
The vision model to use for image analysis. Specify ‘palmyra-vision’ for Writer’s vision model.
string
required
Text prompt describing what to analyze in the images. Use {{image_name}} placeholders to reference images from the variables array.
array
required
Array of image variables with their names and file IDs. Each image must be uploaded first via POST /v1/files to obtain a file_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_ASK_QUESTION_TO_KNOWLEDGE_GRAPHSend a question to specified Knowledge Graphs, with optional context. Responses containing file sources may fail validation because the tool requires a URL for each source.

Input Parameters

array
Optional list of context key/value pairs to provide additional information
string
required
The question to ask the knowledge graph
array
required
List of knowledge graph identifiers to target

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_CHAT_COMPLETIONGenerate a non-streaming chat completion from a conversation history using a specified model.

Input Parameters

integer
Number of chat completion choices to generate
string
Up to 4 sequences where the API will stop generating further tokens
string
Model identifier to use for the chat completion
number
Nucleus sampling probability threshold
boolean
Whether to stream back partial progress as server-sent events
array
required
Conversation history in order. Required.
integer
Maximum number of tokens to generate
number
Sampling temperature; higher values produce more random output
number
Penalty for new tokens based on presence in the text so far
number
Penalty for new tokens based on their frequency in the text so far

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_CREATE_KNOWLEDGE_GRAPHCreate an empty Knowledge Graph that files can be added to. It is org-wide with an organization-scoped API key and assigned to the key’s team with a team-scoped key.

Input Parameters

string
required
The name of the knowledge graph
string
A short description clarifying the graph’s purpose for the model

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_DELETE_FILETool to delete a file by its ID. Use when you need to permanently remove a file from Writer with no recovery option available.

Input Parameters

string
required
The unique identifier of the file to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_DELETE_GRAPHTool to delete a knowledge graph by its ID. Use when you need to remove a graph after confirming its identifier.

Input Parameters

string
required
Unique identifier of the graph to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_DETECT_AI_CONTENTAnalyze text for AI-generated content and return a classification label and score. Input must contain at least 350 characters excluding newline characters.

Input Parameters

string
required
The text to analyze for AI content. Must have at least 350 characters (excluding newline characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_DOWNLOAD_FILETool to download the binary content of a file. Use when you need to retrieve file data from the Writer platform. The response contains the file in its original format.

Input Parameters

string
required
The ID of the file to download.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_GET_FILETool to retrieve detailed information about a specific file by its ID. Use when you need to check a file’s metadata, processing status, or associated knowledge graphs.

Input Parameters

string
required
The ID of the file to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_LIST_APPLICATIONSList a page of no-code agent applications, with an optional page size and cursor for retrieving subsequent pages.

Input Parameters

string
Cursor for pagination. Use the last_id from a previous response to get the next page.
integer
Maximum number of applications to return (for pagination).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_LIST_FILESTool to list all uploaded files. Use when you need to retrieve a paginated set of user files, optionally filtered by status, graph, or type. Use after uploading files to inspect available files.

Input Parameters

string
Cursor for returning the next page of results; set to the last file ID of the prior page.
integer
Max number of files to return (1-100). Defaults to 50.
string ("asc" | "desc")
Sorting order for results: ‘asc’ (oldest first) or ‘desc’ (newest first).
string
Cursor for returning the previous page of results; set to the first file ID of the prior page.
string ("in_progress" | "completed" | "failed")
Filter files by status.
string
Filter files by a specific knowledge graph ID.
string
Comma-separated list of file extensions to include, e.g. ‘pdf,docx,jpg’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_LIST_GRAPHSList a page of Writer Knowledge Graphs. With an organization-scoped API key, results include only org-wide graphs; with a team-scoped key, they include only that team’s graphs.

Input Parameters

string
ID of last object from previous page for forward pagination.
integer
Number of items per page. Default: 50, max: 100.
string
Sort order: ‘asc’ or ‘desc’. Default: ‘desc’.
string
ID of first object from previous page for backward pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_LIST_MODELSTool to list all available language models. Use when you need to discover which models can be used for completions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_MEDICAL_COMPREHENDExtract medical entities and any returned concepts from unstructured clinical text using the Entities response type.

Input Parameters

string
required
The clinical or medical text to analyze (max 20,000 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_PARSE_PDFParse a previously uploaded PDF into text or markdown using Writer’s deprecated PDF parser endpoint, which Writer scheduled for removal on December 22, 2025.

Input Parameters

string ("text" | "markdown")
required
Output format for the parsed PDF content: ‘text’ for plain text or ‘markdown’ for markdown-formatted output.
string
required
The ID of the PDF file to parse. Obtained from a prior file upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_REMOVE_FILE_FROM_GRAPHTool to remove a file from a Knowledge Graph. Use when you need to unlink a specific file from a graph by providing both graph and file identifiers.

Input Parameters

string
required
The ID of the file to remove from the graph.
string
required
The ID of the graph from which to remove the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_RETRIEVE_GRAPHRetrieve a Writer Knowledge Graph by its ID to inspect details of an existing graph, such as its name, description, creation time, and file processing status. Access is subject to the scope of the API key.

Input Parameters

string
required
Unique identifier of the knowledge graph to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_TEXT_GENERATIONTool to generate text based on a given prompt. Use when you need model-driven completions after crafting a prompt.

Input Parameters

array
Sequences where the API will stop generating.
string
required
The name of the model to use for generation. Available models include: palmyra-x-003-instruct, palmyra-x4, palmyra-x5, palmyra-creative, palmyra-fin, palmyra-med, palmyra-vision.
number
Nucleus sampling parameter between 0 and 1.
string
required
The text prompt for the model.
integer
Maximum number of tokens in the generated output.
number
Sampling temperature between 0 and 2.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_TRANSLATE_TEXTTool to translate text from one language to another with support for formality, length control, and profanity masking. Use when you need to convert text between different languages.

Input Parameters

string
required
The text to translate (maximum 100,000 words)
string ("palmyra-translate")
required
Translation model to use
boolean
required
Apply formal language style to the translation (support varies by language)
boolean
required
Control the length of the output translation (support varies by language)
boolean
required
Mask profane words in the translated text (support varies by language)
string
required
Source language ISO-639-1 code (e.g., en for English, es for Spanish, fr for French)
string
required
Target language ISO-639-1 code (e.g., en for English, es for Spanish, fr for French)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_UPDATE_GRAPHTool to update an existing knowledge graph. Use after confirming the graph_id. Specify at least one of name or description to modify.

Input Parameters

string
New name for the graph
string
required
The unique identifier of the graph to update
string
New description for the graph

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_UPLOAD_FILESubmit a file to Writer using a multipart upload for file-based operations.

Input Parameters

object
required
The file to upload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WRITER_WEB_SEARCHTool to perform a web search. Use when you need relevant web page results for a given query.

Input Parameters

string
required
The search query string
string ("general" | "news")
Search category: ‘general’ (default) for broader web search, ‘news’ for current events and news articles
string ("day" | "week" | "month" | "year" | "d" | "w" | "m" | "y")
Content recency filter: ‘day’/‘d’, ‘week’/‘w’, ‘month’/‘m’, or ‘year’/‘y’
integer
Maximum number of results to return (cannot exceed 20)
string ("basic" | "advanced")
Search depth: ‘basic’ (default, fewer results) or ‘advanced’ (deeper search)
boolean
Include a generated answer based on results (default: true)
array
Exclude specific domains from results
array
Restrict results to specific domains

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not