writerai 0.31.0

Python SDK for Writer API

Python SDK

AI for everyone.

SDK Installation

pip install writerai

Authentication

Writer authenticates your API requests using your account’s API keys. If you do not include your key when making an API request, or use one that is incorrect or outdated, Writer returns an error.

Your API keys are available in the account dashboard. We include randomly generated API keys in our code examples if you are not logged in. Replace these with your own or log in to see code examples populated with your own API keys.

If you cannot see your secret API keys in the Dashboard, this means you do not have access to them. Contact your Writer account owner and ask to be added to their team as a developer.

SDK Example Usage

import writer
from writer.models import operations, shared

s = writer.Writer(
    api_key="",
    organization_id=496531,
)


res = s.ai_content_detector.detect(content_detector_request=shared.ContentDetectorRequest(
    input='Bronze Indian',
), organization_id=558689)

if res.content_detector_responses is not None:
    # handle response
    pass

Available Resources and Operations

ai_content_detector

• detect - Content detector api

billing

• get_subscription_details - Get your organization subscription details

co_write

• generate_content - Generate content using predefined templates
• list_templates - Get a list of your existing CoWrite templates

completions

• create - Create completion for LLM model
• create_model_customization_completion - Create completion for LLM customization model

content

• check - Check your content against your preset styleguide.
• correct - Apply the style guide suggestions directly to your content.

download_the_customized_model

• fetch_file - Download your fine-tuned model (available only for Palmyra Base and Palmyra Large)

files

• delete - Delete file
• get - Get file
• list - List files
• upload - Upload file

model_customization

• create - Create model customization
• delete - Delete Model customization
• get - Get model customization
• list - List model customizations

models

• list - List available LLM models

snippet

• delete - Delete snippets
• find - Find snippets
• update - Update snippets

styleguide

• get - Page details
• list_pages - List your styleguide pages

terminology

• add - Add terms
• delete - Delete terms
• find - Find terms
• update - Update terms

user

• list - List users

document

• get - Get document details
• list - List team documents

Dev Containers

Experience our SDK in an enhanced sandbox environment. Try it now in GitHub Codespaces!

• Explore Dev Containers

Global Parameters

A parameter is configured globally. This parameter must be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set organizationId to 547272 at SDK initialization and then you do not have to pass the same value on calls to operations like detect. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.

Available Globals

The following global parameter is available. The required parameter must be set when you initialize the SDK client.

Name	Type	Required	Description
organizationId	int	✔️	The organizationId parameter.

Example

import writer
from writer.models import operations, shared

s = writer.Writer(
    api_key="",
    organization_id=496531,
)


res = s.ai_content_detector.detect(content_detector_request=shared.ContentDetectorRequest(
    input='Bronze Indian',
), organization_id=558689)

if res.content_detector_responses is not None:
    # handle response
    pass

SDK Generated by Speakeasy