Get Style Suggestion

GET

https://app.acrolinx.cloud/v1/style/suggestions/:workflow_id

GET

/v1/style/suggestions/:workflow_id

1 from acrolinx import Acrolinx
2 
3 client = Acrolinx(
4     token="YOUR_TOKEN",
5 )
6 client.style_suggestions.get_style_suggestion(
7     workflow_id="workflow_id",
8 )

Try it

1 {
2   "status": "completed",
3   "scores": {
4     "quality": {
5       "score": 48
6     },
7     "clarity": {
8       "average_sentence_length": 23.5,
9       "flesch_kincaid_grade": 8.1,
10       "flesch_reading_ease": 71.9,
11       "lexical_diversity": 48.4,
12       "score": 51,
13       "sentence_complexity": 97.4,
14       "sentence_count": 17,
15       "vocabulary_complexity": 19.1,
16       "word_count": 399
17     },
18     "grammar": {
19       "score": 14,
20       "issues": 33
21     },
22     "style_guide": {
23       "score": 18,
24       "issues": 24
25     },
26     "tone": {
27       "score": 58,
28       "informality": 61.6,
29       "liveliness": 56.7,
30       "target_informality": -1,
31       "target_liveliness": -1,
32       "informality_tolerance": -1,
33       "liveliness_tolerance": -1
34     },
35     "terminology": {
36       "score": 100,
37       "issues": 0
38     }
39   },
40   "issues": [
41     {
42       "original": "To whom it may concern,",
43       "char_index": 0,
44       "subcategory": "other",
45       "suggestion": "Dear Reader,",
46       "category": "grammar"
47     },
48     {
49       "original": "went",
50       "char_index": 71,
51       "subcategory": "verbs",
52       "suggestion": "gone",
53       "category": "grammar"
54     },
55     {
56       "original": "gonna",
57       "char_index": 93,
58       "subcategory": "spelling",
59       "suggestion": "going",
60       "category": "grammar"
61     }
62   ],
63   "check_options": {
64     "style_guide": {
65       "style_guide_type": "ap",
66       "style_guide_id": "01971e03-dd27-75ee-9044-b48e654848cf"
67     },
68     "dialect": "american_english",
69     "tone": "academic"
70   }
71 }

Retrieve the results of a style and brand suggestion workflow. Returns running or complete status.

Path parameters

workflow_idstringRequired

Response

The suggestion run results.

SuggestionResponseobject

WorkflowStatusResponseobject

StyleCheckResponseobject

RFC9457Errorobject

Get Style Suggestion

Path parameters

Headers

Response

Errors