AI Agents

Linguistic syntax/grammar checker. Returns a structured analysis with overall score, per-issue breakdown by severity …

post/api/syntax-checker-agent

Request

  • Base URL: https://platform.vocametrix.com
  • URL: https://platform.vocametrix.com/api/syntax-checker-agent
  • Auth: API key in header X-API-Key

Request body

textstring required

REQUIRED. Text to analyze (≤ 5000 characters).

localestring required

REQUIRED. Language code (validated via validateLanguageCode).

threadIdstring

Optional. Thread ID for multi-turn continuity.

emailstring

Optional. Used by the credit-validation flow.

Response

Successful response

successboolean

Boolean.

analysisobject

Object: { overall_score, language_detected, text_length, analysis_timestamp, issues: [...], suggestions: [{category, type, description, examples}], statistics: {total_issues, by_severity: {high, medium, low}, by_type: {grammar, spelling, punctuation, style, clarity}}, corrected_text, readability: {grade_level, reading_ease, avg_sentence_length} }.

metadataobject

Object: { locale, textLength, threadId, agentName, processingTimeSeconds, timestamp }.

remaining_creditsnumber

Number.

Changes

No recorded changes to this operation across all 1 revision of this API.