Skip to content

ContentGenerationApi.md

Latest commit

 

History

History
715 lines (519 loc) · 27.7 KB

ContentGenerationApi.md

File metadata and controls

715 lines (519 loc) · 27.7 KB

root / docs

[Back to README.md]

ContentGenerationApi

All URIs are relative to https://api.dataforseo.com

Method HTTP request Description
checkGrammarLive POST /v3/content_generation/check_grammar/live
contentGenerationCheckGrammarLanguages GET /v3/content_generation/check_grammar/languages
contentGenerationTextSummaryLanguages GET /v3/content_generation/text_summary/languages
generateLive POST /v3/content_generation/generate/live
generateMetaTagsLive POST /v3/content_generation/generate_meta_tags/live
generateSubTopicsLive POST /v3/content_generation/generate_sub_topics/live
generateTextLive POST /v3/content_generation/generate_text/live
grammarRules GET /v3/content_generation/grammar_rules
paraphraseLive POST /v3/content_generation/paraphrase/live
textSummaryLive POST /v3/content_generation/text_summary/live

checkGrammarLive

ContentGenerationCheckGrammarLiveResponseInfo checkGrammarLive(contentGenerationCheckGrammarLiveRequestInfo)

‌ This endpoint will provide you with grammar and spelling corrections for the text you specify. for more info please visit 'https://docs.dataforseo.com/v3/content_generation/check_grammar/live/?bash'

Example

// Import classes:
import io.github.dataforseo.dataforseo_client.ApiClient;
import io.github.dataforseo.dataforseo_client.ApiException;
import io.github.dataforseo.dataforseo_client.Configuration;
import io.github.dataforseo.dataforseo_client.auth.*;
import io.github.dataforseo.dataforseo_client.models.*;
import io.github.dataforseo.dataforseo_client.api.ContentGenerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.dataforseo.com");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    ContentGenerationApi apiInstance = new ContentGenerationApi(defaultClient);
    List<ContentGenerationCheckGrammarLiveRequestInfo> contentGenerationCheckGrammarLiveRequestInfo = Arrays.asList(); // List<ContentGenerationCheckGrammarLiveRequestInfo> | 
    try {
      ContentGenerationCheckGrammarLiveResponseInfo result = apiInstance.checkGrammarLive(contentGenerationCheckGrammarLiveRequestInfo);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ContentGenerationApi#checkGrammarLive");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
contentGenerationCheckGrammarLiveRequestInfo List<ContentGenerationCheckGrammarLiveRequestInfo> [optional]

Return type

ContentGenerationCheckGrammarLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

contentGenerationCheckGrammarLanguages

ContentGenerationCheckGrammarLanguagesResponseInfo contentGenerationCheckGrammarLanguages()

You will receive the list of languages by calling this API.   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. for more info please visit 'https://docs.dataforseo.com/v3/content_generation/check_grammar/languages/?bash&#39;

Example

// Import classes:
import io.github.dataforseo.dataforseo_client.ApiClient;
import io.github.dataforseo.dataforseo_client.ApiException;
import io.github.dataforseo.dataforseo_client.Configuration;
import io.github.dataforseo.dataforseo_client.auth.*;
import io.github.dataforseo.dataforseo_client.models.*;
import io.github.dataforseo.dataforseo_client.api.ContentGenerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.dataforseo.com");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    ContentGenerationApi apiInstance = new ContentGenerationApi(defaultClient);
    try {
      ContentGenerationCheckGrammarLanguagesResponseInfo result = apiInstance.contentGenerationCheckGrammarLanguages();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ContentGenerationApi#contentGenerationCheckGrammarLanguages");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

ContentGenerationCheckGrammarLanguagesResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

contentGenerationTextSummaryLanguages

ContentGenerationTextSummaryLanguagesResponseInfo contentGenerationTextSummaryLanguages()

You will receive the list of languages by calling this API.   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. for more info please visit 'https://docs.dataforseo.com/v3/content_generation/text_summary/languages/?bash&#39;

Example

// Import classes:
import io.github.dataforseo.dataforseo_client.ApiClient;
import io.github.dataforseo.dataforseo_client.ApiException;
import io.github.dataforseo.dataforseo_client.Configuration;
import io.github.dataforseo.dataforseo_client.auth.*;
import io.github.dataforseo.dataforseo_client.models.*;
import io.github.dataforseo.dataforseo_client.api.ContentGenerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.dataforseo.com");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    ContentGenerationApi apiInstance = new ContentGenerationApi(defaultClient);
    try {
      ContentGenerationTextSummaryLanguagesResponseInfo result = apiInstance.contentGenerationTextSummaryLanguages();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ContentGenerationApi#contentGenerationTextSummaryLanguages");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

ContentGenerationTextSummaryLanguagesResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

generateLive

ContentGenerationGenerateLiveResponseInfo generateLive(contentGenerationGenerateLiveRequestInfo)

‌ This endpoint will provide you with a text generated based on the part of the text you define and other available parameters. for more info please visit 'https://docs.dataforseo.com/v3/content_generation/generate/live/?bash&#39;

Example

// Import classes:
import io.github.dataforseo.dataforseo_client.ApiClient;
import io.github.dataforseo.dataforseo_client.ApiException;
import io.github.dataforseo.dataforseo_client.Configuration;
import io.github.dataforseo.dataforseo_client.auth.*;
import io.github.dataforseo.dataforseo_client.models.*;
import io.github.dataforseo.dataforseo_client.api.ContentGenerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.dataforseo.com");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    ContentGenerationApi apiInstance = new ContentGenerationApi(defaultClient);
    List<ContentGenerationGenerateLiveRequestInfo> contentGenerationGenerateLiveRequestInfo = Arrays.asList(); // List<ContentGenerationGenerateLiveRequestInfo> | 
    try {
      ContentGenerationGenerateLiveResponseInfo result = apiInstance.generateLive(contentGenerationGenerateLiveRequestInfo);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ContentGenerationApi#generateLive");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
contentGenerationGenerateLiveRequestInfo List<ContentGenerationGenerateLiveRequestInfo> [optional]

Return type

ContentGenerationGenerateLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

generateMetaTagsLive

ContentGenerationGenerateMetaTagsLiveResponseInfo generateMetaTagsLive(contentGenerationGenerateMetaTagsLiveRequestInfo)

‌ This endpoint is designed to generate title and description meta tags for a text specified in the request. for more info please visit 'https://docs.dataforseo.com/v3/content_generation/generate_meta_tags/live/?bash&#39;

Example

// Import classes:
import io.github.dataforseo.dataforseo_client.ApiClient;
import io.github.dataforseo.dataforseo_client.ApiException;
import io.github.dataforseo.dataforseo_client.Configuration;
import io.github.dataforseo.dataforseo_client.auth.*;
import io.github.dataforseo.dataforseo_client.models.*;
import io.github.dataforseo.dataforseo_client.api.ContentGenerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.dataforseo.com");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    ContentGenerationApi apiInstance = new ContentGenerationApi(defaultClient);
    List<ContentGenerationGenerateMetaTagsLiveRequestInfo> contentGenerationGenerateMetaTagsLiveRequestInfo = Arrays.asList(); // List<ContentGenerationGenerateMetaTagsLiveRequestInfo> | 
    try {
      ContentGenerationGenerateMetaTagsLiveResponseInfo result = apiInstance.generateMetaTagsLive(contentGenerationGenerateMetaTagsLiveRequestInfo);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ContentGenerationApi#generateMetaTagsLive");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
contentGenerationGenerateMetaTagsLiveRequestInfo List<ContentGenerationGenerateMetaTagsLiveRequestInfo> [optional]

Return type

ContentGenerationGenerateMetaTagsLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

generateSubTopicsLive

ContentGenerationGenerateSubTopicsLiveResponseInfo generateSubTopicsLive(contentGenerationGenerateSubTopicsLiveRequestInfo)

‌ This endpoint will provide you with 10 subtopics generated based on the topic and other parameters you specify. for more info please visit 'https://docs.dataforseo.com/v3/content_generation/generate_sub_topics/live/?bash&#39;

Example

// Import classes:
import io.github.dataforseo.dataforseo_client.ApiClient;
import io.github.dataforseo.dataforseo_client.ApiException;
import io.github.dataforseo.dataforseo_client.Configuration;
import io.github.dataforseo.dataforseo_client.auth.*;
import io.github.dataforseo.dataforseo_client.models.*;
import io.github.dataforseo.dataforseo_client.api.ContentGenerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.dataforseo.com");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    ContentGenerationApi apiInstance = new ContentGenerationApi(defaultClient);
    List<ContentGenerationGenerateSubTopicsLiveRequestInfo> contentGenerationGenerateSubTopicsLiveRequestInfo = Arrays.asList(); // List<ContentGenerationGenerateSubTopicsLiveRequestInfo> | 
    try {
      ContentGenerationGenerateSubTopicsLiveResponseInfo result = apiInstance.generateSubTopicsLive(contentGenerationGenerateSubTopicsLiveRequestInfo);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ContentGenerationApi#generateSubTopicsLive");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
contentGenerationGenerateSubTopicsLiveRequestInfo List<ContentGenerationGenerateSubTopicsLiveRequestInfo> [optional]

Return type

ContentGenerationGenerateSubTopicsLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

generateTextLive

ContentGenerationGenerateTextLiveResponseInfo generateTextLive(contentGenerationGenerateTextLiveRequestInfo)

‌ This endpoint will provide you with a text generated based on the topic and other parameters you specify. for more info please visit 'https://docs.dataforseo.com/v3/content_generation/generate_text/live/?bash&#39;

Example

// Import classes:
import io.github.dataforseo.dataforseo_client.ApiClient;
import io.github.dataforseo.dataforseo_client.ApiException;
import io.github.dataforseo.dataforseo_client.Configuration;
import io.github.dataforseo.dataforseo_client.auth.*;
import io.github.dataforseo.dataforseo_client.models.*;
import io.github.dataforseo.dataforseo_client.api.ContentGenerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.dataforseo.com");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    ContentGenerationApi apiInstance = new ContentGenerationApi(defaultClient);
    List<ContentGenerationGenerateTextLiveRequestInfo> contentGenerationGenerateTextLiveRequestInfo = Arrays.asList(); // List<ContentGenerationGenerateTextLiveRequestInfo> | 
    try {
      ContentGenerationGenerateTextLiveResponseInfo result = apiInstance.generateTextLive(contentGenerationGenerateTextLiveRequestInfo);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ContentGenerationApi#generateTextLive");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
contentGenerationGenerateTextLiveRequestInfo List<ContentGenerationGenerateTextLiveRequestInfo> [optional]

Return type

ContentGenerationGenerateTextLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

grammarRules

ContentGenerationGrammarRulesResponseInfo grammarRules()

You will receive the list of grammar rules by calling this API.   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. for more info please visit 'https://docs.dataforseo.com/v3/content_generation/grammar_rules/?bash&#39;

Example

// Import classes:
import io.github.dataforseo.dataforseo_client.ApiClient;
import io.github.dataforseo.dataforseo_client.ApiException;
import io.github.dataforseo.dataforseo_client.Configuration;
import io.github.dataforseo.dataforseo_client.auth.*;
import io.github.dataforseo.dataforseo_client.models.*;
import io.github.dataforseo.dataforseo_client.api.ContentGenerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.dataforseo.com");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    ContentGenerationApi apiInstance = new ContentGenerationApi(defaultClient);
    try {
      ContentGenerationGrammarRulesResponseInfo result = apiInstance.grammarRules();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ContentGenerationApi#grammarRules");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

ContentGenerationGrammarRulesResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

paraphraseLive

ContentGenerationParaphraseLiveResponseInfo paraphraseLive(contentGenerationParaphraseLiveRequestInfo)

‌ This endpoint will provide you with a paraphrased version of the text you specify. for more info please visit 'https://docs.dataforseo.com/v3/content_generation/paraphrase/live/?bash&#39;

Example

// Import classes:
import io.github.dataforseo.dataforseo_client.ApiClient;
import io.github.dataforseo.dataforseo_client.ApiException;
import io.github.dataforseo.dataforseo_client.Configuration;
import io.github.dataforseo.dataforseo_client.auth.*;
import io.github.dataforseo.dataforseo_client.models.*;
import io.github.dataforseo.dataforseo_client.api.ContentGenerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.dataforseo.com");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    ContentGenerationApi apiInstance = new ContentGenerationApi(defaultClient);
    List<ContentGenerationParaphraseLiveRequestInfo> contentGenerationParaphraseLiveRequestInfo = Arrays.asList(); // List<ContentGenerationParaphraseLiveRequestInfo> | 
    try {
      ContentGenerationParaphraseLiveResponseInfo result = apiInstance.paraphraseLive(contentGenerationParaphraseLiveRequestInfo);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ContentGenerationApi#paraphraseLive");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
contentGenerationParaphraseLiveRequestInfo List<ContentGenerationParaphraseLiveRequestInfo> [optional]

Return type

ContentGenerationParaphraseLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

textSummaryLive

ContentGenerationTextSummaryLiveResponseInfo textSummaryLive(contentGenerationTextSummaryLiveRequestInfo)

‌ This endpoint will provide you with statistical data based on the given text, such as the number of words and sentences, vocabulary density, and text readability. for more info please visit 'https://docs.dataforseo.com/v3/content_generation/text_summary/live/?bash&#39;

Example

// Import classes:
import io.github.dataforseo.dataforseo_client.ApiClient;
import io.github.dataforseo.dataforseo_client.ApiException;
import io.github.dataforseo.dataforseo_client.Configuration;
import io.github.dataforseo.dataforseo_client.auth.*;
import io.github.dataforseo.dataforseo_client.models.*;
import io.github.dataforseo.dataforseo_client.api.ContentGenerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.dataforseo.com");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    ContentGenerationApi apiInstance = new ContentGenerationApi(defaultClient);
    List<ContentGenerationTextSummaryLiveRequestInfo> contentGenerationTextSummaryLiveRequestInfo = Arrays.asList(); // List<ContentGenerationTextSummaryLiveRequestInfo> | 
    try {
      ContentGenerationTextSummaryLiveResponseInfo result = apiInstance.textSummaryLive(contentGenerationTextSummaryLiveRequestInfo);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ContentGenerationApi#textSummaryLive");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
contentGenerationTextSummaryLiveRequestInfo List<ContentGenerationTextSummaryLiveRequestInfo> [optional]

Return type

ContentGenerationTextSummaryLiveResponseInfo

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -

root / docs

[Back to README.md]