Content Generation – Generate Text API
This endpoint will provide you with a text generated based on the topic and other parameters you specify.
This endpoint will provide you with a text generated based on the topic and other parameters you specify.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access
<?php // You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip require('RestClient.php'); $api_url = 'https://api.dataforseo.com/'; // Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access $client = new RestClient($api_url, null, 'login', 'password'); $post_array = array(); // simple way to set a task $post_array[] = array( "topic" => "Steve Jobs", "sub_topics" => array( "Apple", "Pixar", "Amazing Products" ), "description" => "Take a closer look at Steve Jobs' life and his incredible impact on the tech industry, with a special focus on the development of the iPhone.", "meta_keywords" => array( "iPhone", "sell", "CEO" ), "creativity_index" => 0.8, "word_count" => 50, "include_conclusion" => true ); try { // POST /v3/content_generation/generate_text/live $result = $client->post('/v3/content_generation/generate_text/live', $post_array); print_r($result); // do something with post result } catch (RestClientException $e) { echo "n"; print "HTTP code: {$e->getHttpCode()}n"; print "Error code: {$e->getCode()}n"; print "Message: {$e->getMessage()}n"; print $e->getTraceAsString(); echo "n"; } $client = null; ?>
The above command returns JSON structured like this:
{ "version": "0.1.20221214", "status_code": 20000, "status_message": "Ok.", "time": "2.1546 sec.", "cost": 0.003, "tasks_count": 1, "tasks_error": 0, "tasks": [ { "id": "02161336-4426-0502-0000-112d42a7dccf", "status_code": 20000, "status_message": "Ok.", "time": "2.1018 sec.", "cost": 0.003, "result_count": 1, "path": [ "v3", "content_generation", "generate_text", "live" ], "data": { "api": "content_generation", "function": "generate_text", "topic": "Steve Jobs", "sub_topics": [ "Apple", "Pixar", "Amazing Products" ], "description": "Take a closer look at Steve Jobs' life and his incredible impact on the tech industry, with a special focus on the development of the iPhone.", "meta_keywords": [ "iPhone", "sell", "CEO" ], "creativity_index": 0.8, "word_count": 50, "include_conclusion": true }, "result": [ { "input_tokens": 102, "output_tokens": 60, "new_tokens": 60, "generated_text": "The first personal computer was invented in 1976 by William “Bill” Gates (b. 1955), who is best known for co-founding Microsoft Corporation along with Paul Allen (1955–1999). The company that he founded now has over 650 employees working from four locations around the world.", "supplement_token": "5YHXAQ" } ] } ] }
All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute.
You can specify the number of results you want to retrieve, filter and sort them.
Below you will find a detailed description of the fields you can use for setting a task.
Description of the fields for setting a task:
Field name | Type | Description |
---|---|---|
topic |
string | main topic of the content to generate required field main topic for generating content; can contain from 1 to 50 tokens |
word_count |
integer | number of words in content required field the number of tokens in the generated text; can take values from 1 to 1000 |
sub_topics |
array | secondary topics of the content to generate optional field secondary topics for generating content; can contain up to 10 terms; example: "sub_topics": ["Apple","Pixar","Amazing Products"]
|
description |
string | meta description of the content to generate optional field can contain from 1 to 1000 tokenslearn more about this parameter on our help center |
meta_keywords |
array | keywords for the content to generate optional field can contain up to 10 terms; learn more about this parameter on our help center example: "meta_keywords": ["iPhone","sell","CEO"] |
creativity_index |
float | creativity of content generation optional field the randomness of the selection of equally probable subsequent tokens; can take values from 0 to 1 default value: 0.8 learn more about this parameter on our help center |
include_conclusion |
boolean | include conclusion in generated text optional field if set to true , generated content will include a logical conclusion
|
supplement_token |
string | token for generating subsequent results optional field provided in the identical filed of the response to each request; you can use this parameter to continue the generation of text from the initial response supplement_token values are unique for each subsequent task |
tag |
string | user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response |
As a response of the API server, you will receive JSON-encoded data containing a tasks
array with the information specific to the set tasks.
Description of the fields in the results array:
Field name | Type | Description |
---|---|---|
version |
string | the current version of the API |
status_code |
integer | general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions |
status_message |
string | general informational message you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | total tasks cost, USD |
tasks_count |
integer | the number of tasks in the tasks array |
tasks_error |
integer | the number of tasks in the tasks array returned with an error |
tasks |
array | array of tasks |
id |
string | task identifier unique task identifier in our system in the UUID format |
status_code |
integer | status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here |
status_message |
string | informational message of the task you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | cost of the task, USD |
result_count |
integer | number of elements in the result array |
path |
array | URL path |
data |
object | contains the same parameters that you specified in the POST request |
result |
array | array of results |
input_tokens |
integer | number of input tokens |
output_tokens |
integer | number of output tokens |
new_tokens |
integer | number of new tokens |
generated_text |
string | resulting text |
supplement_token |
string | token for generating subsequent results you can use this parameter to continue the generation from the end of the current result; supplement_token values are unique for each subsequent task |