Skip to main content

Field Limits

The API enforces the following limits to ensure system stability:

String Fields

Numeric Fields

Request Limits

  • Request body size: 10MB maximum
  • Rate limit: 100 requests per minute per IP address

Input Requirements

Server Creation

Required fields:
  • name: Unique per user
Optional fields with defaults:
  • description: empty string
  • tokenExpiresInDays: no expiration
  • restrictions:
  • isPublic: false

Action Execution

Required fields:
  • connectorId: Valid connector identifier (non-empty string)
  • actionId: Valid action for the connector (non-empty string)
  • parameters: Action-specific parameters (object)
Optional fields:
  • credentialId: 24-character MongoDB ObjectId for specific credential
  • timeout: Custom timeout in milliseconds

Validation Rules

Server Names

  • Must be unique per user
  • Cannot be empty or whitespace only
  • Special characters allowed: spaces, hyphens, underscores
  • Cannot start or end with whitespace
Valid examples:
Invalid examples:

API Keys

  • Must be at least 16 characters
  • Alphanumeric characters, underscores, and hyphens allowed
  • Case-sensitive
  • JWT tokens are also accepted as API keys

User IDs

  • Must be a non-empty string
  • Maximum 10,000 characters
  • Any format accepted (MongoDB ObjectId, UUID, custom ID)
Valid examples:

Restrictions

Restrictions must follow specific schemas:
Note: Provide either allowedIds/allowedActions OR blockedIds/blockedActions based on the mode, not both.

Validation Errors

When validation fails, you’ll receive a 400 Bad Request with details:

Common Validation Errors

Type Coercion

The API performs automatic type coercion where safe:
  • Strings to numbers: “100” → 100
  • Numbers to strings: 123 → “123”
  • Booleans: “true”/“false” → true/false
No coercion for:
  • Arrays and objects
  • Null values
  • Undefined values

Security Validation

Additional security checks:

Input Sanitization

  • All user inputs are validated using Zod schemas
  • Server IDs are generated from names with sanitization
  • Special characters in names are converted to hyphens

Best Practices

  1. Validate on client side for better UX
  2. Handle validation errors gracefully
  3. Use appropriate field types in requests
  4. Respect field limits to avoid truncation
  5. Sanitize user input before sending
  6. Implement retry logic for validation errors