GET /api/schema/:category/:subcategory

Get parameter schema and definitions for a specific model

Method

GET

Authentication

Not Required

Parameters

category, subcategory

Path Parameters

Parameter	Type	Required	Description
category	string	Yes	Model category (e.g., "imagegen", "videogen")
subcategory	string	Yes	Model identifier (e.g., "flux_dev", "runway_gen2")

Request Examples

cURL

curl -X GET https://api.genvrresearch.com/api/schema/imagegen/flux_dev

JavaScript

const category = 'imagegen';
const subcategory = 'flux_dev';

const response = await fetch(
  `https://api.genvrresearch.com/api/schema/${category}/${subcategory}`
);
const schema = await response.json();

console.log('Required params:', schema.data.parameters.required);
console.log('Optional params:', schema.data.parameters.optional);

Python

import requests

category = 'imagegen'
subcategory = 'flux_dev'

response = requests.get(
    f'https://api.genvrresearch.com/api/schema/{category}/{subcategory}'
)
schema = response.json()

print('Required params:', schema['data']['parameters']['required'])
print('Optional params:', schema['data']['parameters']['optional'])

Response Example

{
  "success": true,
  "data": {
    "category": "imagegen",
    "subcategory": "flux_dev",
    "parameters": {
      "required": [
        {
          "name": "prompt",
          "type": "string",
          "description": "Text description of the image to generate"
        }
      ],
      "optional": [
        {
          "name": "aspect_ratio",
          "type": "enum",
          "default": "1:1",
          "allowedValues": ["1:1", "16:9", "21:9", "4:5", "9:16"],
          "description": "Image aspect ratio"
        },
        {
          "name": "num_outputs",
          "type": "integer",
          "default": 1,
          "minimum": 1,
          "maximum": 4,
          "description": "Number of images to generate"
        }
      ]
    }
  },
  "message": "Schema retrieved successfully"
}

Use Cases

Dynamic Form Generation

Build forms automatically based on the parameter schema with proper validation.

Input Validation

Validate user inputs before making API calls to ensure all required fields are present.

Type-Safe SDKs

Generate type definitions for SDKs in various programming languages.

Default Values

Pre-fill forms with sensible default values from the schema.