Skip to main content

​
Overview

Quickly convert your existing test cases (from spreadsheets, documents, or any format) to Revyl using AI assistants like Claude or ChatGPT.

​
What You’ll Need

  1. Revyl API Key - Get from Settings > API Keys
  2. Build Name - Your app’s exact name in Revyl
  3. Your test cases - From spreadsheet, document, or any format

​
Step 1: Find Your Build Name

Your build name must match exactly. Run this command to list your builds: 
curl -s "https://backend.revyl.ai/api/v1/builds/vars" \
  -H "Authorization: Bearer YOUR_API_KEY"
Look for the "name" field in the response (e.g., "My App - iOS - Beta").

​
Step 2: Copy the Schema to Your AI Assistant

Copy the entire content from the LLM Schema Reference page and paste it into your AI chat (Claude, ChatGPT, etc.).

​
Step 3: Add Your Test Cases

After pasting the schema, add your test cases: 
Now convert these test cases to Revyl YAML format:

Build name: "My App - iOS - Beta"
Platform: ios

Test Cases:
Step 1: User logs in
Step 2: User clicks profile icon
Step 3: Verify profile page loads
...

​
Step 4: Upload the Generated YAML

Endpoint: POST https://backend.revyl.ai/api/v1/tests/yaml/from-yaml 
curl -X POST "https://backend.revyl.ai/api/v1/tests/yaml/from-yaml" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"yaml_content": "YOUR_GENERATED_YAML"}'
Tip: You can also ask the AI to make the upload request for you if it has terminal access.

​
Quick Reference

​
YAML Structure

test:
  metadata:
    name: "Test Name"
    platform: ios              # Required: ios or android

  build:
    name: "My App - iOS"       # Must match exactly

  blocks:
    - type: instructions
      step_description: "Tap the login button"

    - type: validation
      step_description: "User is logged in"

​
Converting Spreadsheet Steps

Your Spreadsheet SaysConvert To
”Click X” / “Tap X”type: instructions
”Verify X” / “Check X”type: validation
”Get X” / “Extract X”type: extraction with variable_name
”Wait X seconds”type: manual, step_type: wait

​
Using Variables

Extract a value first, then reference it with double curly braces: 
# Extract
- type: extraction
  step_description: "The phone number shown"
  variable_name: phone-number

# Use
- type: validation
  step_description: "Field shows {{phone-number}}"
Warning: Only {{variable-name}} syntax works. Not @var, $var, or other formats.

​
Example Conversion

​
Original Spreadsheet

StepTest StepExpected Result
1User logs inLogin successful
2User clicks profileProfile menu opens
3Verify usernameShows “John Doe”

​
Converted YAML

test:
  metadata:
    name: "User Profile Test"
    platform: ios

  build:
    name: "My App - iOS - Beta"

  blocks:
    - type: instructions
      step_description: "Log in to the app"

    - type: validation
      step_description: "Login was successful"

    - type: instructions
      step_description: "Tap the profile icon"

    - type: validation
      step_description: "Profile menu is open"

    - type: validation
      step_description: "Username 'John Doe' is displayed"

​
Tips for Best Results

  1. Be Concise - “Tap login” works better than “Click on the login button located in the top right corner”
  2. Use Broad Validations - “User is logged in” instead of “Green checkmark appears next to username”
  3. No Navigation at Start - The app opens automatically - don’t add open_app at the beginning
  4. Always Specify Platform - Use ios or android (lowercase)

​
Troubleshooting

ErrorSolution
”Build variable not found”Check exact build name spelling from API
”Missing required field: platform”Add platform: ios or platform: android
”Invalid platform”Use lowercase: ios not iOS

​
Next Steps