⚠️ DEPRECATION NOTICE

This package (sharpapi/sharpapi-php-client) has been deprecated and is no longer maintained.

Why?

• Better Performance: Install only what you need
• Smaller Dependencies: Reduced package size
• Easier Maintenance: Each endpoint has its own repository
• Clearer Documentation: Focused docs for each feature
• Faster Updates: Independent versioning per endpoint

What Should You Do?

Migrate to the new specialized endpoint-specific packages:

📝 Content & Marketing (9 packages)

• sharpapi/php-content-summarize-text
• sharpapi/php-content-text-translator
• sharpapi/php-content-paraphrase-text
• And 6 more...

🛒 E-commerce (4 packages)

• sharpapi/php-ecommerce-product-review-sentiment
• sharpapi/php-ecommerce-product-categorization
• And 2 more...

🧑‍💻 HR Tech (3 packages)

✈️ Travel & Hospitality (3 packages)

🔍 SEO (1 package)

🛠️ Utilities (2 packages)

See README.md for complete list and migration guide.

For Existing Users

✅ Your code will continue to work - source code unchanged
⚠️ No new features or updates will be added
🔄 Migrate to specialized packages for ongoing support

Changes in v2.0.0

• Marked package as abandoned in composer.json
• Updated README with deprecation notice and full migration guide
• Added complete table of 22 specialized packages
• Updated CHANGELOG with deprecation information
• No source code changes - backward compatible

View all packages: https://packagist.org/packages/sharpapi/

August 26, 2024 - v1.2.0 update

• Generate Keywords/Tags & Summarize methods aquired optional context that allows to pass additional processing instructions for the provided content
• API useage optimized internall, switched to AI job dispatch/result endpoint pairing mode

March 24, 2023 - v1.1.0 update

1. New methods added

1.2. Paraphrase text: paraphrase()

Generates a paraphrased version of the provided text.

Check Documentation

1.2 Proofread & Grammar Check: proofread()

Proofreads (and checks grammar) of the provided text.

Check Documentation

1.3 Subscription Info / Quota Check: quota()

Endpoint to check details regarding the subscription's current period.

{
    "timestamp": "2024-03-19T12:49:41.445736Z",
    "on_trial": false,
    "trial_ends": "2024-03-17T07:57:46.000000Z",
    "subscribed": true,
    "current_subscription_start": "2024-03-18T12:37:39.000000Z",
    "current_subscription_end": "2024-04-18T12:37:39.000000Z",
    "subscription_words_quota": 100000,
    "subscription_words_used": 9608,
    "subscription_words_used_percentage": 0.1
}

• "subscription_words_used_percentage" is a percentage of current monthly quota usage
• and might serve as an alert to the user of the depleted credits.
• With a value above 80%, it's advised to subscribe to more credits
• at https://sharpapi.com/dashboard/credits to avoid service disruption.

Check Documentation

1.4 Subscription Info / Quota Check: ping()

Simple PING endpoint to check the availability of the API and its internal time zone (timestamp).

{
    "ping": "pong",
    "timestamp": "2024-03-12T08:50:11.188308Z"
}

Check Documentation

2. New Parameters added

2.1 max_quantity - allows to limit the amount of returned items

Added to methods:

• E-commerce > Product Categories / productCategories()
• Travel, Tourism & Hospitality > Tours & Activities Product Categories / toursAndActivitiesProductCategories()
• Travel, Tourism & Hospitality > Hospitality Product Categories / hospitalityProductCategories()
• HR Tech > Related Job Positions / relatedJobPositions()
• HR Tech > Related Skills / relatedSkills()

2.2 max_length - allows to instruct AI model to limit the output of generated text

Please keep in mind that max_length serves as a strong suggestion for the Language Model,
rather than a strict requirement, to maintain the general sense of the outcome.

Added to methods:

• E-commerce > Generate Product Intro / generateProductIntro()
• E-commerce > Generate Thank You E-mail / generateThankYouEmail()
• Content & Marketing Automation > Summarize Content / summarizeText()
• Content & Marketing Automation > Paraphrase Text / paraphrase()

2.3 voice_tone - Tone of voice of the generated text

You can set your preferred writing style by providing
an optional voice_tone parameter. It can be adjectives like
funny or joyous, or even the name of a famous writer.
You can provide multiple tones at the same time.

Added to methods:

• SEO > Generate SEO Tags / generateSeoTags()
• Content & Marketing Automation > Generate Keywords/Tags / generateKeywords()
• Content & Marketing Automation > Summarize Content / summarizeText()
• Content & Marketing Automation > Paraphrase Text / paraphrase()
• Content & Marketing Automation > Translate Text / translate()
• Travel, Tourism & Hospitality > Tours & Activities Product Categories / toursAndActivitiesProductCategories()
• Travel, Tourism & Hospitality > Hospitality Product Categories / hospitalityProductCategories()
• HR Tech > Generate Job Description / generateJobDescription()
• E-commerce > Product Categories / productCategories()
• E-commerce > Generate Product Intro / generateProductIntro()
• E-commerce > Generate Thank You E-mail / generateThankYouEmail()

2.4 context - adds more context/instructions for content processing

Added to methods:

• HR Tech > Generate Job Description / generateJobDescription()
• E-commerce > Generate Thank You E-mail / generateThankYouEmail()
• E-commerce > Product Categories / productCategories()
• Travel, Tourism & Hospitality > Tours & Activities Product Categories / toursAndActivitiesProductCategories()
• Travel, Tourism & Hospitality > Hospitality Product Categories / hospitalityProductCategories()
• Content & Marketing Automation > Translate Text / translate()
• Content & Marketing Automation > Paraphrase Text / paraphrase()

3.0 Added a method to set custom User-Agent for Affiliate Program members.

More info at https://sharpapi.com/affiliate_program