Step 1. Submit the AI Job request
Endpoint: POST - /api/v1/content/keywords
Attribute |
Type |
Mandatory |
Description |
content |
String |
Yes |
Provide the content to generate keywords. |
max_quantity |
Number |
No |
Maximum number of keywords to generate. |
voice_tone |
String |
No |
Specify the voice tone of the output. It can be adjectives like funny or joyous , or even the name of a famous writer. |
language |
String |
No |
Specify the language of the output, defaults to English . |
context |
String |
No |
An optional context parameter is also available. It can be used to add additional processing instructions for the content. |
REQUEST EXAMPLE:
{
"content": "“Red Bull's Max Verstappen says this weekend's Las Vegas Grand Prix is “99% show and 1% sporting event“. The triple world champion said he is “not looking forward“ to the razzmatazz around the race, the first time Formula 1 cars have raced down the city's famous Strip. Other leading drivers were more equivocal about the hype. Aston Martin's Fernando Alonso said: “With the investment that has been made and the place we are racing, it deserves a little bit [of] different treatment and extra show.“ The weekend was kick-started on Wednesday evening with a lavish opening ceremony. It featured performances from several music stars, including Kylie Minogue and Journey, and culminated in the drivers being introduced to a sparsely populated crowd in light rain by being lifted into view on hydraulic platforms under a sound-and-light show. Lewis Hamilton said: “It's amazing to be here. It is exciting - such an incredible place, so many lights, a great energy, a great buzz. “This is one of the most iconic cities there is. It is a big show, for sure. It is never going to be like Silverstone [in terms of history and purity]. But maybe over time the people in the community here will grow to love the sport.“ Hamilton added: “It is a business, ultimately. You'll still see good racing here. “Maybe the track will be good, maybe it will be bad. It was so-so on the [simulator]. Don't knock it 'til you try it.",
"language": "English",
"max_quantity": 10,
"voice_tone": "neutral"
}
RESPONSE EXAMPLE:
{
"status_url": "https://sharpapi.com/api/v1/content/translate/job/status/5de4887a-0dfd-49b6-8edb-9280e468c210",
"job_id": "5de4887a-0dfd-49b6-8edb-9280e468c210"
}
Step 2. Monitor & Fetch AI Job Results
Endpoint: GET - /api/v1/content/keywords/job/status/:uuid
An endpoint is used to check on the progress of the requested API job.
RESULT EXAMPLE:
{
"data": {
"type": "api_job_result",
"id": "b93aae27-87b8-4c68-925a-f6c991cc563c",
"attributes": {
"status": "success",
"type": "content_keywords",
"result": [
"Las Vegas Grand Prix",
"Max Verstappen",
"Formel 1",
"Lewis Hamilton",
"Fernando Alonso"
]
}
}
}