README

Laravel SDK for calling the Raraxuan AI API from Laravel applications.

Requirements

PHP 8.2+
Laravel 10, 11, 12, or 13

Installation

composer require latitudeinnovation/laravel-raraxuan

Publish the configuration file:

php artisan vendor:publish --tag=raraxuan-config

Configuration

Add these values to your Laravel project's .env file:

RARAXUAN_API_URL=https://ai.raraxuan.com
RARAXUAN_API_KEY=rx_live_xxxxxxxxx
RARAXUAN_TIMEOUT=60

The published config file is config/raraxuan.php:

return [
    'base_url' => env('RARAXUAN_API_URL', 'https://ai.raraxuan.com'),
    'process_path' => env('RARAXUAN_PROCESS_PATH', '/v1/prompts/process'),
    'ping_path' => env('RARAXUAN_PING_PATH', '/v1/ping'),
    'api_key' => env('RARAXUAN_API_KEY'),
    'timeout' => env('RARAXUAN_TIMEOUT', 60),
];

Usage

Process a prompt through the facade:

use LatitudeInnovation\Raraxuan\Facades\Raraxuan;

$response = Raraxuan::processPrompt('customer-support-reply', [
    'customer_message' => 'Hello',
    'tone' => 'friendly',
    'product' => 'Acme',
]);

Check API health:

use LatitudeInnovation\Raraxuan\Facades\Raraxuan;

$response = Raraxuan::ping();

Artisan Commands

After installing and configuring the SDK, you can test the API from Artisan.

Run an agent/template with a JSON variables object:

php artisan raraxuan:run customer-support-reply --input='{"customer_message":"Hello","tone":"friendly","product":"Acme"}'

Check API health:

php artisan raraxuan:ping

If the API returns an HTTP error, the commands print the status code and response body instead of a stack trace.

The API returns wrapped JSON payloads, which the SDK returns unchanged:

[
    'success' => true,
    'data' => [
        // ...
    ],
]

[
    'success' => false,
    'error' => [
        'code' => '...',
        'message' => '...',
    ],
]

Error Handling

The SDK throws its own exceptions for missing or invalid local configuration:

LatitudeInnovation\Raraxuan\Exceptions\MissingApiKeyException
LatitudeInnovation\Raraxuan\Exceptions\InvalidConfigurationException

API request failures use Laravel's HTTP client and call throw() on failed responses. Catch Illuminate\Http\Client\RequestException when you need to handle API errors.

use Illuminate\Http\Client\RequestException;
use LatitudeInnovation\Raraxuan\Exceptions\RaraxuanException;
use LatitudeInnovation\Raraxuan\Facades\Raraxuan;

try {
    $response = Raraxuan::processPrompt('customer-support-reply', [
        'customer_message' => 'Hello',
        'tone' => 'friendly',
        'product' => 'Acme',
    ]);
} catch (RequestException $exception) {
    report($exception);

    $status = $exception->response->status();
    $error = $exception->response->json();
} catch (RaraxuanException $exception) {
    report($exception);
}

Testing

After installing development dependencies, run:

composer test

Local Development

Before publishing to Packagist, require this package from a local Laravel project:

composer config repositories.raraxuan path ../laravel-raraxuan
composer require latitudeinnovation/laravel-raraxuan:@dev

If Composer cannot detect the package version, add a branch alias or require dev-main from a Git checkout.

Queue Support

Queue and job helpers are not included yet. A future version can add jobs for long-running agent calls while keeping this client as the synchronous API layer.

latitudeinnovation / laravel-raraxuan

Maintainers

Package info

Statistics

Security