Writer Generation API API is one of 7 APIs that Writer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Generation API. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
6 operations
across 5 paths,
and defines 78 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against a single base URL, https://api.writer.com.
The identity and technical contract details declared by the specification.
llm_tool
object
2 properties
2 required
application_status
string
Current deployment status of the application. Note: currently only deployed applications are returned.
completion_token_details
object
1 property
1 required
translation_function
object
A tool that uses Palmyra Translate to translate text.
6 properties
4 required
source
objectnull
A source snippet containing text and fileId from Knowledge Graph content.
2 properties
2 required
logprobs_token
object
4 properties
3 required
application_input_text_options
object
Configuration options specific to text input fields.
2 properties
2 required
chat_request
object
13 properties
2 required
models_response
object
1 property
1 required
vision_tool
object
2 properties
2 required
application_input_media_options
object
Configuration options specific to media upload input fields.
2 properties
2 required
generate_application_input
object
2 properties
2 required
chat_response
object
8 properties
5 required
llm_function
object
A tool that uses another Writer model to generate a response.
2 properties
2 required
tool_call_streaming
object
4 properties
1 required
application_input_type
string
Type of input field determining its behavior and validation rules.
translation_tool
object
A tool that uses Palmyra Translate to translate text. Note that this tool does not stream results. The response is returned after the translation is complete.
2 properties
2 required
response_format
object
The response format to use for the chat completion, available with palmyra-x4 and palmyra-x5. text is the default response format. [JSON Schema](https://json-s…
2 properties
1 required
completions_choice
object
2 properties
1 required
composite_content
A union type that can contain either text or image content fragments. This enables chat messages to include mixed content types, allowing users to send both te…
references
object
Detailed source information organized by reference type, providing comprehensive metadata about the sources used to generate the response.
2 properties
top_log_prob
object
An array of mappings for each token to its top log probabilities, showing detailed prediction probabilities.
3 properties
2 required
graph_data
object
4 properties
function_tool
object
2 properties
2 required
tool_choice
Configure how the model will call functions: - auto: allows the model to automatically choose the tool to use, or not call a tool - none: disables tool calling…
completions_request
object
9 properties
2 required
chat_message_request_role
string
The role of the chat message. You can provide a system prompt by setting the role to system, or specify that a message is the result of a [tool call](https://d…
logprobs
objectnull
2 properties
2 required
file_upload_type
string
Type of file upload method supported by the application.
application_input_file_options
object
Configuration options specific to file upload input fields.
5 properties
5 required
web_search_tool
object
2 properties
2 required
file
object
A file-based reference containing text snippets from uploaded documents in the Knowledge Graph.
5 properties
3 required
chat_completion_streaming_choice
object
5 properties
3 required
application_input_options
Type-specific configuration options for input fields.
generate_application_response_chunk
object
1 property
1 required
graph_stage_status
stringnull
prompt_token_details
object
1 property
1 required
generate_application_request
object
2 properties
1 required
application_input_dropdown_options
object
Configuration options specific to dropdown-type input fields.
1 property
1 required
streaming_data
object
1 property
1 required
graph_query_config
object
Configuration options for Knowledge Graph queries.
8 properties
application_type
string
The type of no-code application.
graph_tool
object
2 properties
2 required
web
object
A web-based reference containing text snippets from online sources accessed during the query.
4 properties
4 required
chat_completion_usage
object
Usage information for the chat completion response. Please note that at this time Knowledge Graph tool usage is not included in this object.
5 properties
3 required
chat_completion_streaming_delta
object
The chat completion message from the model. Note: this field is deprecated for streaming. Use delta instead.
7 properties
get_applications_response
object
Response object containing a paginated list of applications.
4 properties
2 required
tool_call
object
4 properties
3 required
chat_completion_chunk
object
8 properties
5 required
json_object_tool_choice
object
1 property
1 required
tool_function
object
A tool that uses a custom function.
3 properties
1 required
generate_application_response
object
2 properties
1 required
application_with_inputs
object
Detailed application object including its input configuration.
8 properties
7 required
string_tool_choice_options
string
web_search_function
object
A tool that uses web search to find information.
2 properties
2 required
web_search_data
object
1 property
1 required
chat_completion_choice
object
4 properties
3 required
application_input
object
Configuration for an individual input field in the application.
5 properties
3 required
chat_completion_finish_reason
string
completions_response
object
2 properties
1 required
stream_options
object
Additional options for streaming.
1 property
1 required
model_info
object
2 properties
2 required
image_fragment
object
Represents an image content fragment within a chat message. Note: This content type is only supported with the Palmyra X5 model.
2 properties
2 required
text_fragment
object
Represents a text content fragment within a chat message.
2 properties
2 required
string_tool_choice
object
1 property
1 required
vision_function
object
A tool that uses Palmyra Vision to analyze images and documents. Supports JPG, PNG, PDF, and TXT files up to 7MB each.
2 properties
2 required
chat_completion_response_message
object
The chat completion message from the model. Note: this field is deprecated for streaming. Use delta instead.
8 properties
3 required
chat_message
object
7 properties
1 required
vision_tool_request_file_variable
object
2 properties
2 required
function
object
2 properties
2 required
sub_query
objectnull
A sub-question generated to break down complex queries into more manageable parts, along with its answer and supporting sources.
3 properties
3 required
translation_data
object
3 properties
3 required
graph_function
object
A tool that uses Knowledge Graphs as context for responses.
4 properties
2 required
llm_data
objectnull
2 properties
2 required
generate_application_delta
object
3 properties
generate_application_chunk_stage
object
3 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Writer publishes across the network.
