https://github.com/sharpapi/php-core
SharpAPI.com PHP Core functionalities & communication
https://github.com/sharpapi/php-core
Last synced: 4 months ago
JSON representation
SharpAPI.com PHP Core functionalities & communication
- Host: GitHub
- URL: https://github.com/sharpapi/php-core
- Owner: sharpapi
- Created: 2024-11-13T12:38:24.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-10T09:42:39.000Z (over 1 year ago)
- Last Synced: 2025-03-29T11:51:45.383Z (about 1 year ago)
- Language: PHP
- Size: 14.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SharpAPI.com PHP Core functionalities & communication
## 🚀 Automate workflows with AI-powered API
### Leverage AI API to streamline workflows in E-Commerce, Marketing, Content Management, HR Tech, Travel, and more.
See more at [SharpAPI.com Website »](https://sharpapi.com/)
---
## Quota Method
The `quota()` method returns a `SubscriptionInfo` DTO with the following fields:
| Field | Type | Description |
|---|---|---|
| `timestamp` | `Carbon` | Timestamp of the subscription check |
| `on_trial` | `bool` | Whether the account is on a trial period |
| `trial_ends` | `Carbon` | End date of the trial period |
| `subscribed` | `bool` | Whether the user is currently subscribed |
| `current_subscription_start` | `Carbon` | Start of the current subscription period |
| `current_subscription_end` | `Carbon` | End of the current subscription period |
| `current_subscription_reset` | `Carbon` | Quota reset timestamp |
| `subscription_words_quota` | `int` | Total word quota for the period |
| `subscription_words_used` | `int` | Words used in the current period |
| `subscription_words_used_percentage` | `float` | Percentage of word quota used |
| `requests_per_minute` | `int` | Maximum API requests allowed per minute |
```php
$client = new SharpApiClient('your-api-key');
$quota = $client->quota();
echo $quota->subscription_words_quota;
echo $quota->requests_per_minute;
```
---
## Rate Limiting
The SDK automatically handles API rate limits. When the API returns HTTP 429 (Too Many Requests), the client will:
1. **Retry automatically** — reads the `Retry-After` header, sleeps for the specified duration, and retries the request (up to 3 times by default).
2. **Slow down polling** — during `fetchResults()`, when `X-RateLimit-Remaining` drops below the low threshold, polling intervals are automatically increased to avoid hitting the limit.
### Inspecting Rate-Limit State
After any API call, you can check the current rate-limit values:
```php
$client = new SharpApiClient('your-api-key');
$client->ping();
echo $client->getRateLimitLimit(); // e.g. 60 (requests per window)
echo $client->getRateLimitRemaining(); // e.g. 58 (remaining in current window)
```
> **Note:** `getRateLimitLimit()` and `getRateLimitRemaining()` return `null` before the first API call or after endpoints that don't return rate-limit headers (e.g. `/ping`, `/quota`).
### Configuration
```php
// Max automatic retries on HTTP 429 (default: 3)
$client->setMaxRetryOnRateLimit(5);
// Threshold below which polling intervals are increased (default: 3)
$client->setRateLimitLowThreshold(5);
```
When `rateLimitRemaining` is at or below the threshold, polling intervals in `fetchResults()` are multiplied by an increasing factor (2x at threshold, growing as remaining approaches 0). This helps avoid 429 errors during long-running job polling.
---
## Credits
- [A2Z WEB LTD](https://github.com/a2zwebltd)
- [Dawid Makowski](https://github.com/makowskid)
- Boost your [Laravel AI](https://sharpapi.com/) capabilities!
---
## License
The MIT License (MIT).
---
## Social Media
🚀 For the latest news, tutorials, and case studies, don't forget to follow us on:
- [SharpAPI X (formerly Twitter)](https://x.com/SharpAPI)
- [SharpAPI YouTube](https://www.youtube.com/@SharpAPI)
- [SharpAPI Vimeo](https://vimeo.com/SharpAPI)
- [SharpAPI LinkedIn](https://www.linkedin.com/products/a2z-web-ltd-sharpapicom-automate-with-aipowered-api/)
- [SharpAPI Facebook](https://www.facebook.com/profile.php?id=61554115896974)