Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Get a public model by name

Server:https://openapi.felo.ai
Client Libraries

Get a public model by name

​

Anonymous exact lookup by public name or registered alias. Returns the canonical model ID and the same model object as the catalog. Unknown or unlisted models return 404. locale controls document selection only.

Query Parameters
  • model
    Type: string
    min length:  
    1
    max length:  
    256
    required

    Exact case-sensitive public model name or registered alias

  • locale
    Type: string enum

    Document language; falls back to English when unavailable

    values
    • en
    • zh-CN
    • zh-TW
    • ja
    • ko
Headers
  • If-None-Match
    Type: string

    Previous ETag; matching content returns 304

Responses
  • 200
    Type: object · ModelCatalogModelResponse

    Public model details

    • data
      Type: object · CatalogModel
      required
      • author
        Type: string · Authornullable
        required
      • author_display_name
        Type: string · Author Display Namenullable
        required
      • available_content_locales
        Type: array string[] · Available Content Localesenum
        required
        values
        • en
        • zh-CN
        • zh-TW
        • ja
        • ko
      • best_for
        Type: array string[] · Best For
        required
      • capabilities
        Type: array string[] · Capabilities
        required
      • content_locale
        Type: string · Content Localeenumnullable
        required
        values
        • en
        • zh-CN
        • zh-TW
        • ja
        • ko
      • context_length
        Type: integer · Context Lengthnullable
        required

        Integer numbers.

      • description
        Type: string · Descriptionnullable
        required
      • document
        Type: object · PublicDocumentnullable
        required

        Selected language only; summary/description/best_for stay on the model

        • extra
          Type: object · Extra
          required
          • propertyName
            Type: anything
        • notice
          Type: object · CatalogNoticenullable
          required
          • body
            Type: string · Body
            required
          • link_text
            Type: string · Link Textnullable
            required
          • target_slug
            Type: string · Target Slugnullable
            required
          • title
            Type: string · Titlenullable
            required
        • updated_at
          Type: string · Updated At
          required

          Selected language document update time

      • icon_url
        Type: string · Icon Urlnullable
        required
      • id
        Type: string · Id
        required
      • input_modalities
        Type: array string[] · Input Modalities
        required
      • latency_class
        Type: string · Latency Classnullable
        required
      • max_completion_tokens
        Type: integer · Max Completion Tokensnullable
        required

        Integer numbers.

      • model_kind
        Type: string · Model Kindenum
        required
        values
        • chat
        • image_generation
        • video_generation
        • decisions
      • name
        Type: string · Name
        required
      • output_modalities
        Type: array string[] · Output Modalities
        required
      • reasoning
        Type: object · Reasoningnullable
        required

        Upstream reasoning JSON object; preserves unknown fields; null if unavailable

        • propertyName
          Type: anything
      • released_at
        Type: string · Released Atnullable
        required

        Model release date in ISO 8601 UTC; may use the OpenRouter listing time. Manual overrides take precedence; null means unknown.

      • short_name
        Type: string · Short Name
        required
      • slug
        Type: string · Slug
        required
      • sort_order
        Type: integer · Sort Order
        required

        Integer numbers.

      • summary
        Type: string · Summarynullable
        required
      • supported_parameters
        Type: array string[] · Supported Parameters
        required
      • trial_status
        Type: string · Trial Status
        required
      • updated_at
        Type: string · Updated Atnullable
        required
      • video_spec
        Type: object · VideoSpecnullable
        required
        • aspect_ratios
          Type: array string[] | null · Aspect Ratiosnullable
        • audio
          Type: object · AudioSpecnullable
          • input
            Type: boolean · Inputnullable
          • output
            Type: boolean · Outputnullable
          • output_optional
            Type: boolean · Output Optionalnullable
        • constraints
          Type: object · Constraintsnullable

          Data-only JSON Schema for valid request combinations

          • propertyName
            Type: anything
        • duration_seconds
          Type: object · DurationSpecnullable
          • max
            Type: number · Max
            greater than:  
            0
            required
          • min
            Type: number · Min
            min:  
            0
            required
          • step
            Type: number · Step
            greater than:  
            0
            required
        • example_request
          Type: object · Example Requestnullable
          • propertyName
            Type: anything
        • input_modes
          Type: array string[] | null · Input Modesnullable
        • reference_limits
          Type: object · Reference Limitsnullable
          • propertyName
            nullable
            • Type: integer

              Integer numbers.

        • request_defaults
          Type: object · Request Defaultsnullable
          • propertyName
            Type: anything
        • resolutions
          Type: array string[] | null · Resolutionsnullable
      • channels
        Type: array object[] · Channels
        • code
          Type: string · Code
          required
        • discount_multiplier
          Type: string · Discount Multipliernullable
          required

          Exact sales multiplier from 0 to 1; apply once to configured rates or upstream cost

        • is_default
          Type: boolean · Is Default
          required
        • name
          Type: string · Name
          required
        • region
          Type: string · Regionnullable
          required
        • runnable
          Type: boolean · Runnable
          required
        • service_tier
          Type: string · Service Tier
          required
        • standard_pricing
          Type: object · CatalogPricingnullable
          required

          Standard unit rates before sales discount; null for upstream_cost channels

          • basis
            const:  
            standard
            required
          • billing_kind
            Type: string · Billing Kind
            required
          • channel
            Type: string · Channel
            required
          • currency
            const:  
            USD
            required
          • tiers
            Type: array object[] · Tiers
            required

            Preserve order; first matching tier overrides base rates

            • conditions
              Type: array object[] · Conditions
              required
              • field
                Type: string · Field
                required

                Felo pricing context, e.g. input_context_tokens

              • operator
                Type: string · Operatorenum
                required
                values
                • eq
                • gt
                • gte
              • value
                required
                • Type: string · Value
            • overrides
              Type: object · Overrides
              required
              • propertyName
                Type: string
          • audio
            Type: string · Audionullable

            USD per input audio token

          • completion
            Type: string · Completionnullable

            USD per output token

          • credit
            Type: string · Creditnullable

            USD per credit; billed using the upstream call multiplier

          • input_audio_cache
            Type: string · Input Audio Cachenullable

            USD per cached audio token

          • input_cache_read
            Type: string · Input Cache Readnullable

            USD per cached input token

          • input_cache_write
            Type: string · Input Cache Writenullable

            USD per cache write token

          • input_cache_write_12h
            Type: string · Input Cache Write 12Hnullable

            USD per 12-hour cache write token; separate from default TTL writes

          • input_cache_write_1h
            Type: string · Input Cache Write 1Hnullable

            USD per 1-hour cache write token; separate from default TTL writes

          • input_image
            Type: string · Input Imagenullable

            USD per input image

          • input_image_cache
            Type: string · Input Image Cachenullable

            USD per cached image token

          • input_image_token
            Type: string · Input Image Tokennullable

            USD per input image token

          • input_video_second
            Type: string · Input Video Secondnullable

            USD per input video second

          • internal_reasoning
            Type: string · Internal Reasoningnullable

            USD per reasoning token

          • output_image
            Type: string · Output Imagenullable

            USD per generated image

          • output_image_token
            Type: string · Output Image Tokennullable

            USD per output image token

          • output_video_second
            Type: string · Output Video Secondnullable

            USD per generated video second

          • output_video_token
            Type: string · Output Video Tokennullable

            USD per generated video token

          • prompt
            Type: string · Promptnullable

            USD per input token; null means unavailable, 0 means free

          • request
            Type: string · Requestnullable

            USD per request

          • web_search
            Type: string · Web Searchnullable

            USD per web search request

        • markup_multiplier
          Type: string · Markup Multipliernullable

          Sale markup (>= 1) applied to the purchase price or upstream cost to form the sale price, before discount_multiplier

        • pricing_mode
          Type: string · Pricing Modeenum

          Configured unit rates, or reported media cost times the sales discount

          values
          • configured_rates
          • upstream_cost
        • reference_pricing
          nullable

          Public video reference before discount; not a final charge

          • as_of
            Type: string · As Of
            required
          • canonical_slug
            Type: string · Canonical Slug
            required
          • pricing_type
            const:  
            per_second
            required
          • request_defaults
            Type: object · Request Defaults
            required
            • propertyName
              • Type: string
          • reservation
            Type: object · VideoReservation
            required
            • max_duration_seconds
              Type: integer · Max Duration Seconds
              greater than:  
              0
              required

              Integer numbers.

            • output_count
              const:  
              1

              Integer numbers.

            • strategy
              const:  
              requested_duration_or_model_max
          • rows
            Type: array object[] · Rows
            required
            • input_image_billing
              Type: string · Input Image Billingenum
              required
              values
              • per_image
              • included
              • not_applicable
            • input_mode
              Type: string · Input Modeenum
              required
              values
              • text_to_video
              • image_to_video
              • first_last_frame
            • max_duration_output_estimate_usd
              Type: string · Max Duration Output Estimate Usd
              required
            • resolution
              Type: string · Resolution
              required
            • unit
              Type: string · Unitenum
              required
              values
              • output_video_second
              • video_token
            • unit_price_usd
              Type: string · Unit Price Usd
              required
            • aspect_ratio
              Type: string · Aspect Rationullable
            • derived_output_second_usd
              Type: string · Derived Output Second Usdnullable
            • generate_audio
              Type: boolean · Generate Audionullable
            • input_image_price_usd
              Type: string · Input Image Price Usdnullable
            • reservation_supported
              const:  
              true
            • reservation_unavailable_reason
              Type: null · Reservation Unavailable Reason
            • size
              Type: string · Sizenullable
          • seed_supported
            Type: boolean · Seed Supported
            required
          • snapshot_id
            Type: string · Snapshot Id
            required
          • source_model_id
            Type: string · Source Model Id
            required
          • supported_aspect_ratios
            Type: array string[] · Supported Aspect Ratios
            required
          • supported_durations
            Type: array integer[] · Supported Durations
            required
          • supported_frame_images
            Type: array string[] · Supported Frame Images
            required
          • supported_resolutions
            Type: array string[] · Supported Resolutions
            required
          • basis
            const:  
            public_reference_before_discount
          • currency
            const:  
            USD
          • settlement_basis
            const:  
            upstream_cost
          • version
            const:  
            1

            Integer numbers.

        • sale_pricing
          Type: object · VideoSalePricingnullable

          Video sale unit prices (purchase price times markup_multiplier), before discount; null when no synchronized video rates are frozen

          • basis
            const:  
            sale_before_discount
            required
          • currency
            const:  
            USD
            required
          • rows
            Type: array object[] · Rows
            required

            Per-spec sale unit prices. Final charge uses the upstream-reported usage, so the billed amount is upstream cost times markup_multiplier times discount_multiplier; a minimum billable duration may apply.

            • conditions
              Type: object · Conditions
              required

              Equality-condition summary; predicates retain the complete rule semantics

              • propertyName
                Type: anything
            • rates
              Type: object · Rates
              required

              USD sale unit prices (purchase price times markup_multiplier), before discount

              • propertyName
                Type: string
            • predicates
              Type: array object[] | null · Predicatesnullable

              Ordered rule predicates including range comparisons

              • field
                Type: string · Field
                required

                Felo pricing context, e.g. input_context_tokens

              • operator
                Type: string · Operatorenum
                required
                values
                • eq
                • gt
                • gte
              • value
                required
                • Type: string · Value
          • minimum_charge_usd
            Type: string · Minimum Charge Usdnullable

            Marked-up minimum charge in USD, before discount; null if none

          • selection
            const:  
            first_match

            First matching rule wins; the final empty rule is the default

          • unit
            Type: string · Unitnullable

            Primary billing unit, e.g. output_video_second or video_token

        • second_pricing
          Type: object · VideoSecondPricingnullable

          Per-second sale prices by resolution/mode (markup applied, before discount). For video_token models the per-second value is an estimate; settlement uses token usage

          • basis
            const:  
            sale_before_discount
            required
          • currency
            const:  
            USD
            required
          • rows
            Type: array object[] · Rows
            required
            • estimated
              Type: boolean · Estimated
              required

              True when derived from a video_token rate via the pixel-frame formula

            • per_second_usd
              Type: string · Per Second Usd
              required

              USD per output second (sale price before discount); markup already applied

            • aspect_ratio
              Type: string · Aspect Rationullable
            • generate_audio
              Type: boolean · Generate Audionullable
            • input_image_usd
              Type: string · Input Image Usdnullable

              USD per input image (sale price before discount); null if none

            • input_mode
              Type: string · Input Modenullable
            • predicates
              Type: array object[] | null · Predicatesnullable

              Full conditions for this per-second price row

              • field
                Type: string · Field
                required

                Felo pricing context, e.g. input_context_tokens

              • operator
                Type: string · Operatorenum
                required
                values
                • eq
                • gt
                • gte
              • value
                required
                • Type: string · Value
            • resolution
              Type: string · Resolutionnullable
          • second_basis
            Type: string · Second Basisenum
            required

            exact for per-second models; token_pixel_frames_estimate when per_second_usd is derived from the video_token rate (token price x resolution pixels x fps 24 / 1024). Token models still settle on reported token usage; per-second price is for display.

            values
            • exact
            • token_pixel_frames_estimate
          • pricing_type
            Type: string · Pricing Typenullable

            per_second or video_token

        • settlement_policy
          Type: object · PublicSettlementPolicynullable

          Published primary pricing and missing-usage fallback policy

          • fallback
            Type: string · Fallbackenum
            required
            values
            • upstream_cost
            • review_required
          • primary
            const:  
            configured_rates
            required
          • version
            const:  
            1
            required

            Integer numbers.

      • default_channel
        Type: string · Default Channelnullable
      • parameter_definitions
        Type: object · Parameter Definitions

        Supported parameters keyed by name, using OpenRouter type/values/min/max format (not JSON Schema); preserves unknown fields; an empty definition means supported with unspecified constraints. An empty object means no parameter metadata. No defaults or options are inferred.

        • propertyName
          Type: object
          • propertyName
            Type: anything
      • recommended_protocol
        Type: string · Recommended Protocolenumnullable

        Model-wide client recommendation only; null for non-chat models; does not restrict callable protocols

        values
        • responses
        • messages
    • locale
      Type: string · Localeenum
      required
      values
      • en
      • zh-CN
      • zh-TW
      • ja
      • ko
    • schema_version
      const:  
      2
      required

      Integer numbers.

    application/json
  • 304

    Unchanged representation; empty body

  • 400

    Invalid model name or locale

  • 404

    Model not found

  • 422

    Missing model query parameter

  • 503

    Model catalog unavailable

Request Example for get/api/platform/model-catalog/model
curl 'https://openapi.felo.ai/api/platform/model-catalog/model?model='
{
  "schema_version": 2,
  "locale": "en",
  "data": {
    "id": "example-model",
    "slug": "example/example-model",
    "name": "Example model",
    "short_name": "Example",
    "author": "example",
    "author_display_name": "Example",
    "icon_url": null,
    "model_kind": "chat",
    "recommended_protocol": "messages",
    "summary": "Example model.",
    "description": "Illustrative text, not a real model.",
    "best_for": [],
    "content_locale": "en",
    "available_content_locales": [
      "en"
    ],
    "document": {
      "notice": null,
      "extra": {},
      "updated_at": "2026-10-14T00:00:00Z"
    },
    "latency_class": null,
    "trial_status": "unknown",
    "released_at": null,
    "sort_order": 0,
    "updated_at": "2026-10-14T00:00:00Z",
    "context_length": 32768,
    "max_completion_tokens": 4096,
    "input_modalities": [
      "text"
    ],
    "output_modalities": [
      "text"
    ],
    "capabilities": [],
    "supported_parameters": [
      "temperature"
    ],
    "reasoning": null,
    "video_spec": null,
    "default_channel": "standard",
    "channels": [
      {
        "code": "standard",
        "name": "Standard",
        "service_tier": "standard",
        "region": null,
        "is_default": true,
        "runnable": true,
        "standard_pricing": {
          "channel": "standard",
          "currency": "USD",
          "basis": "standard",
          "billing_kind": "token",
          "prompt": "0.000001",
          "completion": "0.000002",
          "input_cache_write": "0.00000125",
          "input_cache_write_1h": "0.000002",
          "input_cache_write_12h": "0.000004",
          "tiers": []
        },
        "discount_multiplier": "0.8",
        "pricing_mode": "configured_rates"
      },
      {
        "code": "priority",
        "name": "Priority",
        "service_tier": "priority",
        "region": null,
        "is_default": false,
        "runnable": false,
        "standard_pricing": null,
        "discount_multiplier": null,
        "pricing_mode": "configured_rates"
      }
    ],
    "parameter_definitions": {
      "temperature": {}
    }
  }
}
Get a public model by name

Need help?