AI Magicx
AI Platform Public API

Schemas


ApiResponse

  • successboolean · required
  • data
  • errorobject
  • metaobject

ApiError

  • codestring · required
  • messagestring · required
  • detailsobject

ApiMeta

  • paginationobject
  • rateLimitobject

Pagination

  • limitinteger
  • offsetinteger
  • totalinteger
  • has_moreboolean

RateLimit

  • limitinteger
  • remaininginteger
  • resetstring · date-time

ChatRequest

  • messagestring · minLength: 1 · maxLength: 8000 · required
  • modelstring · enum · required
    Enum values:
    4o-mini
    4o
    gpt-4.1
    gpt-4.1-mini
    o3
    o3-mini
    o4-mini
    claude-3-5-sonnet
  • temperaturenumber · max: 2
  • maxTokensinteger · min: 1 · max: 4096
  • toolsstring[]
  • streamboolean
    Default: true
  • systemstring
  • metadataobject

ChatResponse

  • idstring
  • modelstring
  • objectstring · enum
    Enum values:
    chat.completion
  • createdinteger
  • choicesobject[]
  • usageobject

ChatChoice

  • indexinteger
  • messageobject
  • finish_reasonstring · enum
    Enum values:
    stop
    length
    tool_calls
    content_filter

Message

  • rolestring · enum
    Enum values:
    assistant
  • contentstring
  • tool_callsobject[]

ToolCall

  • idstring
  • typestring · enum
    Enum values:
    function
  • functionobject

Function

  • namestring
  • argumentsstring

Usage

  • prompt_tokensinteger
  • completion_tokensinteger
  • total_tokensinteger

Model

  • idstring
  • namestring
  • providerstring · enum
    Enum values:
    openai
    anthropic
    google
  • descriptionstring
  • input_credits_per_1k_tokensnumber
  • output_credits_per_1k_tokensnumber
  • max_tokensinteger
  • supports_toolsboolean
  • supports_visionboolean
  • tierstring · enum
    Enum values:
    basic
    professional

Tool

  • idstring
  • namestring
  • categorystring · enum
    Enum values:
    visualization
    utility
    github
    mcp
  • descriptionstring
  • tierstring · enum
    Enum values:
    basic
    professional
  • parametersobject

ImageGenerationRequest

  • promptstring · minLength: 1 · maxLength: 4000 · required
  • modelstring · enum · required
    Enum values:
    fal-ai/flux/schnell
    fal-ai/flux/dev
    fal-ai/stable-diffusion-v3-medium
    fal-ai/stable-diffusion-v35-large/turbo
    fal-ai/stable-diffusion-v35-large
    fal-ai/flux-pro/v1.1-ultra
    fal-ai/flux-pro/v1.1
    dall-e-3
  • sizestring · enum
    Enum values:
    square
    square_hd
    square_small
    landscape_4_3
    landscape_16_9
    portrait_4_3
    portrait_16_9
    Default: square
  • ninteger · min: 1 · max: 4
    Default: 1
  • negative_promptstring · maxLength: 1000
  • stylestring · enum
    Enum values:
    photorealistic
    anime
    digital_art
    oil_painting
    watercolor
    sketch
    cartoon
    abstract
  • qualitystring · enum
    Enum values:
    standard
    hd
    Default: standard
  • seedinteger
  • guidance_scalenumber · min: 1 · max: 20
  • num_inference_stepsinteger · min: 10 · max: 150

LogoGenerationRequest

  • promptstring · minLength: 1 · maxLength: 2000 · required
  • modelstring · enum · required
    Enum values:
    fal-ai/flux/schnell
    fal-ai/flux/dev
    fal-ai/stable-diffusion-v3-medium
    fal-ai/stable-diffusion-v35-large/turbo
    fal-ai/stable-diffusion-v35-large
    fal-ai/flux-pro/v1.1-ultra
    fal-ai/flux-pro/v1.1
    dall-e-3
  • stylestring · enum · required
    Enum values:
    minimal
    modern
    vintage
    playful
    corporate
    tech
    organic
    geometric
  • industrystring · enum · required
    Enum values:
    technology
    healthcare
    finance
    education
    retail
    food
    travel
    entertainment
  • sizestring · enum
    Enum values:
    square
    square_hd
    square_small
    landscape_4_3
    landscape_16_9
    portrait_4_3
    portrait_16_9
    Default: square
  • ninteger · min: 1 · max: 4
    Default: 1
  • negative_promptstring · maxLength: 1000
  • color_schemestring · maxLength: 200
  • typographystring · enum
    Enum values:
    sans-serif
    serif
    script
    display
    monospace
  • moodstring · enum
    Enum values:
    professional
    friendly
    bold
    elegant
    playful
  • complexityinteger · min: 1 · max: 5
    Default: 3
  • refine_promptboolean
    Default: true

ImageGenerationResponse

  • idstring
  • modelstring
  • objectstring · enum
    Enum values:
    image.generation
  • createdinteger
  • dataobject[]
  • usageobject

Error

  • successboolean
    Example: false
  • errorobject

UsageResponse

  • successboolean
    Example: true
  • dataobject