Skip to content

sharpapi/sharpapi.github.io

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
.github/workflows
.github/workflows
 
 
_includes
_includes
 
 
vendor
vendor
 
 
README.md
README.md
 
 
_config.yml
_config.yml
 
 
composer.json
composer.json
 
 
composer.lock
composer.lock
 
 
posts.php
posts.php
 
 

Repository files navigation

SharpAPI GitHub cover

SharpAPI.com - Automate Workflows with AI-powered API

Leverage AI API to streamline workflows in E-Commerce, Marketing, Content Management, HR Tech, Travel, and more.

Connect with Us

Overview

SharpAPI is a powerful API designed to automate workflows across multiple industries with AI-powered endpoints, allowing you to streamline operations in e-commerce, marketing, content management, HR, and more. Our API uses top AI technologies, including OpenAI's models and Claude 2, integrated with SharpAPI’s unique capabilities to provide tailored solutions for a variety of applications.

Here’s a section listing the available functionalities of the API, with links to each API Product's documentation, based on the available sitemap and Postman collection:

SharpAPI Functionalities

SharpAPI offers a wide range of AI-powered products for various business needs. Each product consists of a pair of endpoints: a POST endpoint to initiate the job request and a GET endpoint to retrieve the job results. Here’s a list of all available functionalities, with links to their respective documentation:

E-commerce

  • Product Intro Generator AI API

    • This tool generates concise, engaging product introductions based on detailed product information. Designed for e-commerce platforms, it simplifies the process of creating consistent and compelling catalog entries, making product listings more attractive to potential buyers. It allows customization of the writing style through parameters like max_length and voice_tone.

  • Product Categorization AI API

    • Automatically assigns products to the most relevant categories based on their descriptions. This function is ideal for large e-commerce sites and marketplaces, where it helps maintain an organized catalog, enabling users to find products more easily. By analyzing the product’s features and keywords, the tool determines the optimal category, improving navigation and search results.

  • Product Review Sentiment Checker AI API

    • Analyzes customer reviews to detect the sentiment expressed, helping businesses understand customer satisfaction and feedback trends. This functionality allows companies to gauge how products are perceived by users, enabling data-driven decision-making and targeted improvements based on customer feedback.

  • Custom Thank You E-mail Generator AI API

    • Generates personalized thank-you emails for customers after a purchase. By crafting unique, tailored messages, this tool enhances customer experience and helps businesses foster better relationships with their clients. It allows the integration of personalized elements, such as customer names and specific purchase details.

Content Marketing Automation

  • Paraphrase Text AI API

    • Rewrites existing content in a new tone or style to better match brand voice or target different audiences. This tool is invaluable for content marketers looking to create unique variations of existing text, ensuring consistency across multiple platforms while preserving the original message.

  • Keywords/Tags Generator AI API

    • Extracts keywords and tags from content, aiding in SEO and content categorization. By automatically generating relevant tags, this tool enhances content discoverability on search engines and social media, driving more organic traffic to websites.

  • Advanced Text Translator AI API

    • Translates text between multiple languages, supporting over 80 languages. This feature is ideal for businesses operating in multilingual environments, allowing them to localize content quickly and effectively, reaching a wider audience across different regions.

  • Summarize Text AI API

    • Condenses lengthy content into shorter, easily digestible summaries. This tool helps readers quickly grasp the main points of long articles or reports, making it especially useful for content curators, journalists, and educators.

  • Proofread & Grammar Checker

    • Identifies and corrects grammatical errors in written content. It’s perfect for ensuring the professional quality of all written materials, from blog posts to customer communications, enhancing readability and trustworthiness.

  • Spam Detector AI API

    • Analyzes content to detect spam indicators, helping businesses filter out unwanted messages. This tool is ideal for platforms managing user-generated content, ensuring that spam is minimized and that community standards are maintained.

HR Tech

  • Job Description Generator AI API

    • Creates detailed, customized job descriptions based on input criteria. This tool helps HR departments and recruiters attract the right candidates by ensuring job descriptions are clear, engaging, and accurately reflect the role.

  • Related Job Positions Generator AI API

    • Suggests job titles related to a specified role, assisting recruiters in exploring job position variations. It helps companies create job listings that align closely with industry standards, making it easier to attract qualified candidates.

  • Related Skills Generator AI API

    • Lists skills relevant to a given role, enabling more precise job requirement listings. This tool assists hiring managers in clearly defining the skill sets needed for specific positions, leading to more qualified applicants.

  • Resume/CV Parsing AI API

    • Extracts structured information from resumes and CVs, making it easier to evaluate candidates. This tool helps HR teams process large volumes of applications quickly, ensuring that essential details such as education, experience, and skills are readily accessible for comparison.

SEO

  • SEO Social Media Tags Generator AI API
    • Generates SEO-optimized tags for social media platforms to improve content visibility. By using the right tags and keywords, this tool helps content reach a broader audience, enhancing engagement and driving more traffic to websites or social media pages.

Travel & Hospitality

  • Hospitality Product Categorization AI API

    • Categorizes hospitality products and services, facilitating easier organization and discovery on travel and booking platforms. This tool helps businesses in the travel and hospitality sector maintain well-organized catalogs, improving the user experience for travelers seeking accommodations, activities, or services.

  • Tours & Activities Product Categorization AI API

    • Assigns tours and activities to appropriate categories, aiding travelers in discovering experiences that match their interests. This functionality is ideal for booking platforms looking to streamline user searches for activities, enhancing the customer journey.

  • Travel Review Sentiment Checker AI API

    • Analyzes travel-related reviews for sentiment, providing insights into customer satisfaction. Travel companies can use this tool to understand guest feedback trends, enabling data-driven improvements to their services and offerings.

Utility

  • Airports Database & Flight Duration Calculator API
    • Calculates estimated flight durations between two airports, leveraging an extensive airport database. This tool is helpful for travel agencies and flight booking platforms, providing quick access to essential travel information that can assist customers in planning their journeys more effectively.

Each API product is designed to perform specialized tasks, and you can review the individual product documentation for detailed usage, parameter requirements, and best practices for each endpoint.

SDK Client Libraries

For streamlined integration, use one of our SDK clients available for multiple programming languages:

Refer to the respective GitHub repositories for setup and usage instructions.

Key Features

1. AI-powered Endpoints

SharpAPI provides endpoints for various tasks such as content generation, paraphrasing, product categorization, and more. Each endpoint is designed with simplicity and efficiency in mind, delivering high-quality results through a standardized RESTful format.

2. Utility Endpoints

Non-AI endpoints offer simple, reliable, and cost-effective options for performing essential tasks. These endpoints can quickly process data and return immediate results, ideal for non-AI based needs.

General Usage

To use the SharpAPI, you need to:

  1. Authenticate: Use Bearer Authentication with your API key. 
    Authorization: Bearer YOUR_API_KEY
  2. Content Type: All requests should have the Accept: application/json header.
  3. Handling Jobs:
    • Initiate jobs via POST requests to respective endpoints.
    • Poll for status updates on jobs through Retry-After headers and job-specific status URLs.

Best Practices

  • Use the SharpAPI-Job-Id header for tracking job IDs, which can help in error tracking and debugging.
  • Monitor your SharpAPI-Cost header (in USD) to keep track of the expenses per request.
  • Manage request rates with X-RateLimit-* headers to avoid rate limits. These include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.

Non-standard HTTP Headers

SharpAPI uses several custom HTTP headers to enhance API interaction:

  • SharpAPI-Job-Id: Unique identifier for each job request.
  • SharpAPI-Cost: Cost of the request in USD.
  • X-RateLimit-Limit: Total requests allowed within a specific timeframe.
  • X-RateLimit-Remaining: Number of requests left in the current limit period.
  • X-RateLimit-Reset: Time when the rate limit will reset.

Error Handling

SharpAPI handles errors gracefully with detailed responses:

  • 401 Unauthorized: Check your API key.
  • 402 Payment Required: Increase credits via the dashboard.
  • 422 Unprocessable Content: Verify the request body for accuracy.
  • 429 Too Many Requests: Follow rate limit headers to manage request pace.
  • 500 Internal Server Error: Retry after some time as our team addresses the issue.

Use Cases

  1. E-commerce Product Descriptions: Generate tailored and engaging product intros with SharpAPI's e-commerce endpoint.

  2. Content Rewriting for SEO: Improve content quality for search optimization.

  3. HR Applicant Tracking: Categorize resumes or generate job descriptions.

  4. Travel Content Generation: Create compelling travel descriptions for tourism platforms.

  5. Here’s a dedicated section for the 2-Step Approach to using AI-powered API workflows on SharpAPI, explaining the process of dispatching an AI job and retrieving results.

2-Step Approach to Using AI-powered API Workflows

SharpAPI's AI-powered endpoints follow a straightforward 2-step process that ensures effective task management and optimal performance for content generation, data processing, and more. Here’s how it works:

Step 1: Dispatching the AI Job

The first step is to submit a job request to the relevant AI endpoint. This is done via a POST request, where you provide the required parameters in the request body. After submitting the request, SharpAPI will initiate the processing job and respond with a job_id and a status_url in the response, allowing you to track the progress of the job.

Example: Dispatching a Content Paraphrase Job

POST /api/v1/content/paraphrase
Authorization: Bearer YOUR_API_KEY
Accept: application/json
Content-Type: application/json

Request Body:

{
    "content": "Exploring the vibrant tech industry, we discover amazing advancements.",
    "voice_tone": "enthusiastic",
    "language": "English"
}

Example Response:

{
    "status_url": "https://sharpapi.com/api/v1/content/paraphrase/job/status/5de4887a-0dfd-49b6-8edb-9280e468c210",
    "job_id": "5de4887a-0dfd-49b6-8edb-9280e468c210"
}

The response will contain:

  • status_url: A URL to check the job’s status.
  • job_id: A unique identifier for the job request.

This job_id is also included in the SharpAPI-Job-Id header for easier tracking. Additionally, the Retry-After header specifies how long to wait before polling for results.

Step 2: Checking Job Status & Retrieving Results

Once the job has been dispatched, you can track its progress using the status_url obtained from Step 1. This is done via a GET request. The status will be updated as the job processes, eventually indicating a success or failed outcome. If successful, the response will include the processed results.

Polling Example: Checking Job Status

GET https://sharpapi.com/api/v1/content/paraphrase/job/status/5de4887a-0dfd-49b6-8edb-9280e468c210
Authorization: Bearer YOUR_API_KEY
Accept: application/json

Response for Pending Job:

{
    "data": {
        "type": "api_job",
        "id": "5de4887a-0dfd-49b6-8edb-9280e468c210",
        "attributes": {
            "status": "pending",
            "type": "content_paraphrase"
        }
    }
}

Response for Completed Job:

{
    "data": {
        "type": "api_job_result",
        "id": "5de4887a-0dfd-49b6-8edb-9280e468c210",
        "attributes": {
            "status": "success",
            "type": "content_paraphrase",
            "result": {
                "paraphrase": "As we delve into the dynamic tech sector, we witness remarkable progress."
            }
        }
    }
}

In this final response:

  • The status field changes to success when the job is complete, along with the paraphrased content or other requested output in the result field.
  • In case of a failure, the status field will display failed, and details will be provided for further troubleshooting. If a job fails, no processing fee is charged, and you can retry the job.

Best Practices for Using the 2-Step Approach

  1. Optimize Polling Intervals: Use the Retry-After header to avoid excessive polling and manage API rate limits effectively.
  2. Error Handling: Implement error handling based on the status field to ensure smooth reattempts for failed jobs.
  3. Tracking with SharpAPI-Job-Id: Use the SharpAPI-Job-Id header for improved job tracking, especially if you’re managing multiple concurrent jobs.
  4. Cost Awareness: Monitor SharpAPI-Cost headers in the responses to track API usage costs for budgeting and optimization.

This 2-step process is designed to handle AI-powered tasks efficiently, ensuring timely and reliable results for applications ranging from content creation to advanced data processing. By integrating this workflow, you can streamline various tasks and enhance the overall functionality of your applications using SharpAPI's robust AI capabilities.

Note on Job Failures

Occasionally, an AI job may fail to complete successfully. Failures can occur due to several reasons, such as temporary service interruptions, input validation issues, or AI model limitations. When a job fails, the status field in the response will be set to failed, and specific error details will be provided to assist with troubleshooting.

Common Reasons for Job Failure:

  • Invalid Input: If input parameters don’t meet required specifications, the job may fail due to validation errors.
  • AI Model Limitations: Some complex or ambiguous inputs may not be fully processed by the AI model.
  • Service Downtime: Temporary service disruptions or network issues could result in a failed job.

Rest assured, no charges are incurred for failed jobs, and you can simply retry the request after addressing the issue. For optimized handling, consider implementing error-checking and retry logic to ensure a smooth user experience.

Utility Endpoints: PING and QUOTA

SharpAPI includes simple utility endpoints like PING and QUOTA to help you manage and monitor your API usage efficiently. These endpoints provide valuable information for ensuring your application’s smooth operation and staying informed about API limits and usage.

PING Endpoint

The PING endpoint is a lightweight endpoint used to check the availability and responsiveness of the SharpAPI service. This is particularly useful for health checks in your application, allowing you to verify the API is up and running before making further requests.

  • Endpoint: GET /api/v1/ping
  • Purpose: Confirms the API's operational status.
  • Example Request: 
    GET /api/v1/ping
Authorization: Bearer YOUR_API_KEY
Accept: application/json
  • Example Response: 
    {
    "ping": "pong",
    "timestamp": "2024-03-12T08:50:11.188308Z"
}

If you receive a successful response, it means the API is functional, and you can proceed with other requests confidently. If the ping check fails, it could indicate temporary downtime or network issues.

QUOTA Endpoint

The QUOTA endpoint provides a summary of your current API usage limits and the remaining resources within your selected pricing plan. By calling this endpoint, you can monitor your usage in real-time, helping you stay within your allocated credits and avoid unexpected service interruptions.

  • Endpoint: GET /api/v1/quota
  • Purpose: Retrieves information on available and consumed API quota.
  • Example Request: 
    GET /api/v1/quota
Authorization: Bearer YOUR_API_KEY
Accept: application/json
  • Example Response: 
    {
    "timestamp": "2024-03-19T07:06:23.180548Z",
    "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": 0,
    "subscription_words_used_percentage": 0
}

In this example:

  • subscription_words_quota represents the total allowed words for the current plan.
  • subscription_words_used indicates the number of words consumed.
  • subscription_words_used_percentage shows the current usage percentage of the word quota.
  • current_subscription_end specifies when the subscription period will renew.

402 Payment Required Error

When calling various SharpAPI endpoints, including the AI-powered endpoints, you may encounter a 402 Payment Required HTTP response. This response indicates that you have exhausted the available quota on your current subscription, and further processing requires additional credits or an upgrade in your subscription.

Example 402 Response:

{
    "code": "GEN-PAYMENT-REQUIRED",
    "message": "You have exceeded your monthly words quota [100000]. Please login to the dashboard and increase number of credits."
}

The 402 Payment Required response helps prevent unintentional overages by stopping further processing until you add credits or upgrade your plan. To avoid encountering this error, regularly check your quota status using the QUOTA endpoint and adjust your plan as necessary through the SharpAPI dashboard.

Best Practices

  • Use PING for Application Health Checks: Incorporate regular PING calls as part of your application's health monitoring system to ensure the API is responsive.
  • Monitor Quota with QUOTA: Regularly check your usage with QUOTA to prevent service interruptions due to reaching quota limits. Set up alerts or notifications based on subscription_words_used_percentage to stay informed when your usage approaches the limit.
  • Watch for 402 Payment Required Responses: When interacting with SharpAPI’s endpoints, handle the 402 Payment Required response by redirecting users to upgrade options or by notifying your team to add more credits.

These utility endpoints, along with careful monitoring of quota status, will help you maintain a consistent and reliable experience with SharpAPI.

Blog

Alright, so you’ve got a stack of resumes to sift through, and you're feeling that slight existential dread knowing there are only so many hours in a day. What if you could slice through all that resume clutter with an AI-powered razor that picks out the gems for you?

Alright, imagine this: you've got a Laravel Nova dashboard, a list of content fields in multiple languages, and a burning desire to automate translations because, let’s be real, manually doing it is not exactly a great time.

So, you’re neck-deep in resumes and job descriptions, and your only defense against the deluge is a lukewarm cup of coffee. Enter SharpAPI. This isn’t just any old toolkit – this is a turbo-charged, HR tech hero. Here’s how each of these endpoint superheroes (cue dramatic music) can turn your hiring process from drudgery to, well, semi-automated bliss.

HR tech is about more than just hunting for the perfect hire – it’s about creating content that attracts them and keeps them glued to your brand. Enter SharpAPI’s content automation tools, here to make your marketing team and your brand look like absolute rockstars. Imagine having a set of tools so sharp, they could slice through a clunky sentence or rescue a dull job ad, turning it into a showstopper. Let’s dive in.

In an industry where time zones are crossed faster than you can finish a complimentary in-flight snack, AI has become the quiet co-pilot shaping every corner of travel. Imagine automating itinerary emails, categorizing unique stays, or instantly translating tour descriptions—all while you focus on delivering memorable experiences. SharpAPI brings this vision to life, offering a suite of AI-powered tools that not only simplify operations but add that extra spark to customer interactions, making travel smoother, smarter, and undeniably more exciting.

Big news! SharpAPI has officially integrated with Integrately.com, bringing seamless, 1-click connections to over 1200+ apps without a learning curve. Whether you're a tech pro or a complete newbie, this integration lets you automate workflows effortlessly. Now you can connect SharpAPI to your favorite tools like Pipedrive, Mailchimp, Google Sheets, Slack, and more with just a few clicks. Say goodbye to complexity and hello to instant automation magic! 🚀

We're thrilled to announce the release of the SharpAPI Node.js SDK Client—a powerful, AI-driven tool designed to seamlessly integrate workflow automation into your JS/Node projects.

In the ever-evolving landscape of software development, automation and intelligent workflows are key to building efficient, scalable, and user-centric applications. We're thrilled to announce the release of the SharpAPI Python Client SDK—a powerful, AI-driven tool designed to seamlessly integrate workflow automation into your Python projects.

Discover the impact of AI-powered HR tech stacks on modern recruitment challenges and how top HR APIs are reshaping the hiring landscape in 2024. Enhance candidate experience, improve efficiency, and stay competitive with innovative HR technology solutions.

API marketplaces are evolving rapidly, driven by the surge in AI-based solutions. As a seasoned technologist with over 25 years of coding experience, I’ve had the privilege of witnessing and contributing to this transformation. Recently, I’ve delved deep into the intricacies of API marketplace integration from the perspective of an AI-powered API provider. This article shares my findings, insights, and visions for the future.

Let’s explore how AI can be leveraged to build scalable solutions for online engagement across various industries seeking to enhance efficiency and productivity through AI-driven workflow automation.

Integrating AI into business workflows can significantly boost efficiency and productivity. However, while directly accessing APIs like OpenAI's ChatGPT or Google's Gemini might seem like an easy solution, it comes with several challenges that can complicate automation.

I'm probably going to ruffle some feathers here, but hear me out. 🙂

SharpAPI is a powerful AI-powered API, which provides a range of workflow automation endpoints to help improve efficiency across various industries. It has features for E-commerce, Content & Marketing Automation, SEO, HR Tech, and Travel & Hospitality industries.

Hey fellow Laravel enthusiasts! In the ever-evolving landscape of e-commerce, integrating AI into your Laravel applications is not just a luxury, it’s a necessity. With SharpAPI’s Laravel package, it’s now easier than ever. In this blog, I’ll guide you through 10 transformative use cases for enhancing your Laravel-based e-commerce applications using SharpAPI.

  ____  _                        _    ____ ___ 
 / ___|| |__   __ _ _ __ _ __   / \  |  _ \_ _|
 \___ \| '_ \ / _` | '__| '_ \ / _ \ | |_) | | 
  ___) | | | | (_| | |  | |_) / ___ \|  __/| | 
 |____/|_| |_|\__,_|_|  | .__/_/   \_\_|  |___|
                        |_|

Happy Coding! 🚀

About

SharpAPI.com GitHub-based documentation

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages