AI for everyone.

⚠️ This SDK is not yet published to a package manager. To use please download and build locally.

SDK Installation

Composer

To install the SDK first add the below to your composer.json file:

{
    "repositories": [
        {
            "type": "github",
            "url": "https://github.com/writerai/writer-client-sdk-php.git"
        }
    ],
    "require": {
        "writerai/writer-sdk": "*"
    }
}

Then run the following command:

composer update

SDK Example Usage

Example

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use WriterAi\SDK;
use WriterAi\SDK\Models\Shared;

$security = new Shared\Security();
$security->apiKey = '<YOUR_API_KEY_HERE>';

$sdk = SDK\Writer::builder()
    ->setOrganizationId(850421)
    ->setSecurity($security)
    ->build();

try {
    $response = $sdk->billing->getSubscriptionDetails();

    if ($response->subscriptionPublicResponseApi !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Available Resources and Operations

Billing

• getSubscriptionDetails - Get your organization subscription details

AIContentDetector

• detect - Content detector api

Content

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

CoWrite

• generateContent - Generate content using predefined templates
• listTemplates - Get a list of your existing CoWrite templates

Files

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

Models

• list - List available LLM models

Completions

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

ModelCustomization

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

DownloadTheCustomizedModel

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

Document

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

Snippet

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

Styleguide

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

Terminology

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

User

• list - List users

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 297548 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

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use WriterAi\SDK;
use WriterAi\SDK\Models\Shared;
use WriterAi\SDK\Models\Operations;

$security = new Shared\Security();
$security->apiKey = '<YOUR_API_KEY_HERE>';

$sdk = SDK\Writer::builder()
    ->setOrganizationId(496531)
    ->setSecurity($security)
    ->build();

try {
    $request = new Operations\DetectContentRequest();
    $request->contentDetectorRequest = new Shared\ContentDetectorRequest();
    $request->contentDetectorRequest->input = '<value>';

    $response = $sdk->aiContentDetector->detect($request);

    if ($response->classes !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Server Selection

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Variables
0	https://enterprise-api.writer.com	None

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !

SDK Created by Speakeasy