About this endpoint
What it does
Submits an asynchronous job to generate keywords and tags from the provided content. The request body includes the content to analyze and optional parameters for context, language, voice tone, and maximum quantity.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| content | String | Yes | Provide the content to generate keywords. |
| context | String | No | Optional context used to add additional processing instructions for the content. |
| language | String | No | Specify the language of the output; defaults to English. |
| voice_tone | String | No | Specify the voice tone of the output, such as adjectives like funny or joyous, or the name of a famous writer. |
| max_quantity | Number | No | Maximum number of keywords to generate. |
Response
Returns a JSON object with a job_id string field and a status_url string field. job_id is the identifier of the submitted asynchronous job, and status_url is the URL used to check the job status.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| job_id | String | Yes | Identifier of the submitted asynchronous job. Format: UUID. |
| status_url | String | Yes | URL used to check the submitted job status. Format: URI. |
Notes
This endpoint kicks off an async job and returns immediately with a job identifier; the actual work runs in the background. Pair this call with the corresponding job_check endpoint — poll that until the status reaches a terminal state to retrieve the result. Use the job_id returned in the response to track the job, and the status_url to check its status.