API Documentation

Complete REST API Reference & Integration Guide

Complete REST API reference for MY-STE-BUDDY. Learn how to integrate our ASD‑STE100 compliance analysis API into your applications with detailed examples and best practices.

API documentation and code integration

Table of Contents

API Overview

The MY-STE-BUDDY API provides comprehensive text analysis for ASD‑STE100 compliance analysis. Our REST API processes your text and returns detailed analysis including:

Word Analysis

Word-by-word compliance status with part-of-speech tagging and alternative suggestions

Sentence Structure

Sentence classification, word count, passive voice detection, and noun cluster analysis

Detailed Metrics

Character counts, compliance statistics, and comprehensive error reporting

Base URL: https://my-ste-buddy.com/api/v1
Content-Type: application/json
Authentication: X-API-Key header

Authentication

All API requests require authentication using your API key. Include your API key in the request header: 

X-API-Key: your-64-character-api-key-here
Important:
  • Your API key is unique and should be kept secure
  • API access requires an active paid subscription
  • API keys can be managed from your dashboard

API Endpoints

POST

/api/v1/msbtxttag

Analyze text for ASD‑STE100 compliance with detailed word-level analysis and alternative suggestions.

Request Body 

{
  "text": "Your text to analyze for STE compliance."
}

Example Request 

curl -X POST "https://my-ste-buddy.com/api/v1/msbtxttag" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key-here" \
  -d '{
    "text": "This is a sample text for processing. It contains multiple sentences."
  }'

Response

200 OK 
{
  "text": {
    "orig_text": "This is a sample text for processing. It contains multiple sentences.",
    "sentences": [
      {
        "sentence": "This is a sample text for processing.",
        "error": 0,
        "sentence_inx": 1,
        "cluster_nouns": [],
        "ispassive": false,
        "wordcount": 7,
        "charactercount": 35,
        "classification": "Descriptive",
        "instructions": 0,
        "words": [
          {
            "word": "This",
            "lemma": "this",
            "pos": "PRON",
            "status": "approved",
            "alternatives": []
          },
          {
            "word": "is",
            "lemma": "be",
            "pos": "AUX",
            "status": "approved",
            "alternatives": []
          }
          // ... more words
        ]
      }
      // ... more sentences
    ]
  },
  "totalwordcount": 10,
  "totalcharactercount": 67
}

Rate Limits

API usage is limited by token consumption to ensure fair usage across all users:

Token Limits

Default limit: 10,000 tokens per request. Approximately 7,500 words or 40,000 characters.

Reset Period

Token limits are based on your subscription plan and reset monthly.

Usage Tracking

Monitor your API usage through the dashboard to track consumption.

Rate Limit Exceeded:

When you exceed the token limit, you'll receive a 413 Payload Too Large response.

Error Handling

Common Error Responses

400 Bad Request

Missing or invalid request data

{
  "detail": "Text field is required"
}
401 Unauthorized

Invalid or missing API key

{
  "detail": "invalid_or_inactive_api_key"
}
413 Payload Too Large

Text exceeds token limit

{
  "detail": "Text exceeds maximum token limit of 10000"
}

Code Examples

Python

import requests

url = "https://my-ste-budy.com/api/v1/msbtxttag"
headers = {
    "Content-Type": "application/json",
    "X-API-Key": "your-api-key-here"
}
data = {
    "text": "Your text to analyze"
}

response = requests.post(url, json=data, headers=headers)
result = response.json()

JavaScript

const response = await fetch('https://my-ste-budy.com/api/v1/msbtxttag', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-Key': 'your-api-key-here'
  },
  body: JSON.stringify({
    text: 'Your text to analyze'
  })
});

const result = await response.json();

SDKs & Libraries

We're working on official SDKs for popular programming languages. In the meantime, use the HTTP examples above with your preferred HTTP client library.

Coming Soon:

Official SDKs for Python, Node.js, PHP, and other popular languages are in development.

Ready to Integrate?

Get your API key and start building with MY-STE-BUDDY today.

Get API Access Contact Support