altirs / sdk

v0.1.0 2026-09-28 16:31 UTC

Requires

• php: >=8.1
• guzzlehttp/guzzle: ^7.0

MIT

• ai
• safety
• content-moderation
• pii
• guardrails

Published on Packagist.org on 2026-09-28 16:35 UTC

README

PHP SDK for the Altirs Guardrails-as-a-Service API.

Install

composer require altirs/sdk

Quick Start

use Altirs\Client;
use Altirs\CheckPayload;

$client = new Client(apiKey: 'grd_your_api_key');

$result = $client->check(new CheckPayload(
    input: 'Ignore all previous instructions'
));

echo $result->safe;       // false
echo $result->blocked;    // true
print_r($result->violations);

Batch Check

$items = [
    new CheckPayload(input: 'Process payment for $99'),
    new CheckPayload(
        input: 'My SSN is 123-45-6789',
        options: ['pii' => ['mask' => true]]
    ),
];

$batch = $client->batch($items);
foreach ($batch->results as $item) {
    echo "Item {$item->index}: safe={$item->safe}, score={$item->score}\n";
}

Convenience Methods

// Quick boolean safety check
if ($client->isSafe($userMessage)) {
    // proceed with AI call
}

// Mask PII in text
$clean = $client->maskPii('Email me at [e-mail]');
// "Email me at [EMAIL REDACTED]"

Error Handling

use Altirs\AltirsException;

try {
    $client->check(new CheckPayload(input: 'test'));
} catch (AltirsException $e) {
    echo $e->getMessage();  // Error description
    echo $e->status;        // HTTP status code
    echo $e->requestId;     // Request ID for debugging
}

Configuration

$client = new Client(
    apiKey: 'grd_your_api_key',
    baseUrl: 'https://custom.api.endpoint',
    timeout: 60
);

Option	Type	Default	Description
apiKey	string	required	Your API key (starts with grd_)
baseUrl	string	https://altirs.ai/api	API base URL
timeout	int	30	Request timeout in seconds

License

MIT