sharpapi / laravel-custom-workflow
Laravel wrapper for SharpAPI Custom AI Workflow SDK - build and execute no-code AI API endpoints
Installs: 4
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
pkg:composer/sharpapi/laravel-custom-workflow
Requires
- php: >=8.1
- laravel/framework: ^10.0|^11.0|^12.0
- sharpapi/php-custom-workflow: ^1.0.0
README
SharpAPI Laravel Custom Workflow
๐ฏ Laravel wrapper for SharpAPI Custom AI Workflows โ build and execute no-code AI API endpoints.
Check the full documentation on the Custom AI Workflows page.
Quick Links
| Resource | Link |
|---|---|
| Product Details | SharpAPI.com |
| PHP SDK (non-Laravel) | sharpapi/php-custom-workflow |
| SDK Libraries | GitHub - SharpAPI SDKs |
Requirements
- PHP >= 8.1
- Laravel 10, 11, or 12
- A SharpAPI account with an API key
Installation
Step 1. Install the package via Composer:
composer require sharpapi/laravel-custom-workflow
Step 2. Visit SharpAPI to get your API key.
Step 3. Add your API key to .env:
SHARPAPI_API_KEY=your-api-key
Step 4 (Optional). Publish the configuration:
php artisan vendor:publish --tag=sharpapi-custom-workflow
What it does
This package provides a Laravel-native wrapper around sharpapi/php-custom-workflow. It adds:
- Service Provider with deferred loading (singleton only created when first used)
- Facade for quick static access
- Dependency Injection support
- Publishable configuration with auto-discovery
Usage (Facade)
use SharpAPI\LaravelCustomWorkflow\Facades\CustomWorkflow; // Execute a workflow $statusUrl = CustomWorkflow::executeWorkflow('my-sentiment-analyzer', [ 'text' => 'Great product!', 'score' => 4.5, ]); // Fetch results when ready $result = CustomWorkflow::fetchResults($statusUrl); // List your workflows $workflows = CustomWorkflow::listWorkflows(); // Describe a workflow's schema $definition = CustomWorkflow::describeWorkflow('my-analyzer'); // Validate + execute in one call $statusUrl = CustomWorkflow::validateAndExecute('my-analyzer', ['text' => 'hello']);
Usage (Dependency Injection)
use SharpAPI\CustomWorkflow\CustomWorkflowClient; class AnalyzeController extends Controller { public function analyze(CustomWorkflowClient $client) { $statusUrl = $client->executeWorkflow('my-sentiment-analyzer', [ 'text' => 'Great product!', ]); return $client->fetchResults($statusUrl); } }
Configuration
After publishing, the config file is at config/sharpapi-custom-workflow.php:
return [ 'api_key' => env('SHARPAPI_API_KEY'), 'base_url' => env('SHARPAPI_BASE_URL', 'https://sharpapi.com/api/v1'), ];
Do you think our API is missing some obvious functionality?
Changelog
Please see CHANGELOG for more information on what has changed recently.
Credits
- A2Z WEB LTD
- Dawid Makowski
- Boost your PHP AI capabilities!
License
The MIT License (MIT). Please see License File for more information.
Social Media
๐ For the latest news, tutorials, and case studies, don't forget to follow us on: