API Endpoints

Complete reference for all available CX Tools API endpoints

Calendar API

Get Status

GET /api/calendar/status

Response:
{
    "is_open": true,
    "next_open": "2024-01-22T09:00:00Z",
    "next_close": "2024-01-22T17:00:00Z"
}

Returns the current open/closed status of your business with timestamps for the next status change.

Get Holidays

GET /api/calendar/holidays

Response:
{
    "holidays": [
        {
            "id": 1,
            "name": "New Year's Day",
            "date": "2024-01-01",
            "recurring": true
        }
    ]
}

Returns a list of upcoming holidays and special events from your calendar.

GRXML API

Validate Grammar

POST /api/grxml/validate
Content-Type: application/json

{
    "content": "..."
}

Response:
{
    "valid": true,
    "errors": []
}

Validates a GRXML grammar against W3C standards and best practices.

Test Grammar

POST /api/grxml/test
Content-Type: application/json

{
    "content": "...",
    "input": "test phrase"
}

Response:
{
    "matches": true,
    "result": "test phrase"
}

Tests if a specific input phrase matches the provided GRXML grammar.

Studio API

Script Backup

POST /api/studio/backup
Content-Type: application/json

{
    "script_id": "123",
    "content": "script content..."
}

Response:
{
    "backup_id": "456",
    "timestamp": "2024-01-22T10:00:00Z"
}

Create a backup of your Studio script for version control and recovery.

Hours of Operation

GET /api/studio/hoo/status/{schedule_id}

Response:
{
    "is_open": true,
    "schedule": {
        "id": "789",
        "name": "Main Schedule",
        "timezone": "America/New_York"
    }
}

Get the current status of a specific hours of operation schedule.

SpeechSmith API

Grammar Analysis

POST /api/speechsmith/analyze
Content-Type: application/json

{
    "grammar": "...",
    "depth": "standard"
}

Response:
{
    "score": 85,
    "issues": [
        {
            "type": "ambiguity",
            "severity": "warning",
            "location": "rule:main",
            "message": "Potential recognition ambiguity"
        }
    ],
    "suggestions": [...]
}

Analyzes a GRXML grammar for quality and potential recognition issues.

Generate Suggestions

POST /api/speechsmith/suggestions
Content-Type: application/json

{
    "topic": "banking",
    "phrases": ["check balance", "transfer funds"]
}

Response:
{
    "suggestions": [
        "check my balance",
        "what's my balance",
        "transfer money",
        "move funds"
    ]
}

Generate alternative phrases to improve grammar coverage based on topic and existing phrases.

Authentication Requirements

All API endpoints require authentication using your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

For more information on authentication, see our Authentication Guide.

Next Steps

Ready to start using our API? Get your API key and review our authentication guide.