Get AI Generation Schema

FreshGET

GET https://api.creatify.ai/api/ai_generation/schema/

Retrieve the available AI generation models and their input schemas. Use this to understand what parameters each model accepts.

Headers

Header	Type	Required	Description
X-API-ID	string	Yes	Your Creatify API ID
X-API-KEY	string	Yes	Your Creatify API key

Example Request

curl -X GET 'https://api.creatify.ai/api/ai_generation/schema/' \
  -H 'X-API-ID: your-api-id' \
  -H 'X-API-KEY: your-api-key'

Response

{
  "models": [
    {
      "id": "image-gen-v1",
      "name": "Image Generation v1",
      "description": "Generate images from text prompts",
      "inputs": {
        "prompt": {
          "type": "string",
          "required": true,
          "description": "Text description of the image to generate"
        },
        "aspect_ratio": {
          "type": "string",
          "required": false,
          "description": "Output aspect ratio",
          "options": ["1:1", "16:9", "9:16"]
        },
        "style": {
          "type": "string",
          "required": false,
          "description": "Visual style preset"
        }
      }
    }
  ]
}

Response Fields

Field	Type	Description
models	array	Array of available model definitions
models[].id	string	Model identifier (use in create requests)
models[].name	string	Human-readable model name
models[].description	string	Model description
models[].inputs	object	Schema definition for model inputs

Status Codes

Code	Description
200	Success
401	Unauthorized -- invalid API credentials
500	Internal server error

TIP

Always check the schema endpoint before creating generation tasks. Available models and their parameters may change over time.