API Reference

VOX Platform Reference Documentation

This section provides comprehensive technical reference for developers building voice agents on the VOX platform. Use these references when implementing agents, designing tools, or integrating UI components.

What's in the Reference

The VOX reference documentation is organized into four main sections, each covering a critical aspect of the platform's technical capabilities.

Quick Navigation

For Agent Developers

If you're building your first voice agent, start with these references:

• Core Tools — Learn what's available out-of-the-box
• HTTP Tools — Understand how to connect your APIs
• UI Components — Discover how to render rich visuals

For API Integrators

If you're integrating the VOX platform into your application:

• API Reference — Session creation, authentication, rate limiting
• HTTP Tools — Tool descriptor schema and templating rules

For Platform Engineers

If you're managing multi-tenant deployments:

• API Reference — Rate limits, security controls, usage monitoring
• HTTP Tools — Validation rules and error handling

Reference Conventions

Throughout this documentation, we follow these conventions:

Required vs Optional

Type Notation

string          // String value
number          // Numeric value
boolean         // true or false
object          // JSON object
array           // JSON array
enum            // One of specified values
pattern         // Must match regex pattern

HTTP Status Codes

Using This Reference

Code Examples

All examples are production-ready. Copy and adapt them directly:

{
  "kind": "http_tool",
  "name": "example_tool",
  "description": "Clear description of what this tool does"
}

Templating Syntax

The platform uses a templating system with this context:

• args.fieldName — Access tool parameters
• response.fieldName — Access API response data
• secrets.keyName — Access secure credentials
• status — Access HTTP status code

Filters

Apply type coercion and transformations:

• args.value | number — Coerce to number
• args.value | bool — Coerce to boolean
• args.value | json — Pass complex objects
• args.value | upper — Uppercase string
• args.value | default('fallback') — Provide default

Common Patterns

Authentication Headers

{
  "headers": {
    "authorization": "Bearer {{secrets.api_key}}",
    "content-type": "application/json"
  }
}

Error Handling

{
  "ui": {
    "onError": {
      "open": {
        "component_name": "alert",
        "title": "Operation Failed",
        "description": "{{response.message}}"
      }
    }
  }
}

Parameter Validation

{
  "parameters": {
    "type": "object",
    "properties": {
      "email": { "type": "string", "format": "email" },
      "date": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }
    },
    "required": ["email", "date"]
  }
}

Next Steps

Choose the reference section that matches your current task: