Skip to main content

AI Features

SureStage leverages AI to accelerate mock API creation, generate realistic test data, and suggest improvements to your mock configurations.

AI-Powered Response Generation​

From Schema​

Provide a JSON schema or TypeScript interface, and AI generates realistic response bodies:

  1. Open a route's response editor
  2. Click Generate with AI
  3. Paste your schema or describe the expected response
  4. Review and edit the generated response
  5. Save

From Description​

Describe what you need in plain language:

"Generate a paginated list of 10 users with realistic names, emails, and profile pictures. Include pagination metadata."

The AI creates a complete response body matching your description.

info

The AI-Powered Response Generation feature covers REST/HTTP protocol responses. For complete mock definitions of all other protocol types, see the AI Protocol Definition Generator below.

AI Protocol Definition Generator​

SureStage's AI can generate complete mock definitions for any of the 30+ supported protocol types. Instead of manually configuring every field, describe what you need and AI creates a fully structured definition.

How to use:

  1. Open a protocol simulation's Mock Definition Editor
  2. Toggle on AI Mock Definition Generator at the top of the editor
  3. Choose a quick template or write a custom prompt:
    • E-commerce - Product catalogs, orders, customers, payments
    • Healthcare - Patient records, appointments, lab results
    • Fintech - Accounts, transactions, compliance data
    • IoT - Sensors, telemetry, device status
    • Social Media - User profiles, posts, comments, notifications
  4. Click Generate Preview
  5. Review the generated JSON preview
  6. Click Use This Definition to apply to the visual editor
  7. Make any manual adjustments, then save
tip

The AI generates protocol-aware definitions. For example, a Kafka prompt produces topics with realistic partitions and seed messages, while a GraphQL prompt generates valid SDL schema with resolvers.

Supported protocols: All 30 protocol types including Kafka, GraphQL, gRPC, MongoDB, SCIM, OAuth2, WebSocket, S3, SMTP, Redis, and more.

Requirements: The ai_response_generation feature flag must be enabled.

Smart Route Suggestions​

When you import an API spec, AI suggests:

  • Missing error responses (400, 401, 403, 404, 500)
  • Edge case scenarios
  • Realistic test data variations
  • Response delays for performance testing

Next Steps​