WordCloudApi.md

ProWritingAidSDK\Api\WordCloudApi

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

Method	HTTP request	Description
get	GET /api/async/wordcloud/result/{taskId}	Tries to get the result of a request using the task id of the request
post	POST /api/async/wordcloud	Analyses text and returns a word cloud (as an image)

get

\ProWritingAidSDK\Model\AsyncResponseWordCloudResponse get($task_id)

Tries to get the result of a request using the task id of the request

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new ProWritingAidSDK\Api\WordCloudApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$task_id = "task_id_example"; // string | 

try {
    $result = $apiInstance->get($task_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WordCloudApi->get: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
task_id	string

Return type

\ProWritingAidSDK\Model\AsyncResponseWordCloudResponse

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post

\ProWritingAidSDK\Model\AsyncResponseWordCloudResponse post($requestp)

Analyses text and returns a word cloud (as an image)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new ProWritingAidSDK\Api\WordCloudApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$requestp = new \ProWritingAidSDK\Model\WordCloudRequest(); // \ProWritingAidSDK\Model\WordCloudRequest | 

try {
    $result = $apiInstance->post($requestp);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WordCloudApi->post: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
requestp	\ProWritingAidSDK\Model\WordCloudRequest

Return type

\ProWritingAidSDK\Model\AsyncResponseWordCloudResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json, text/json, application/x-www-form-urlencoded
• Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]