Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

Get a public model by name

سرور:https://openapi.felo.ai
کتابخانه‌های کلاینت

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.

پارامترهای پرس‌وجو
  • model
    نوع: string
    حداقل طول:  
    1
    حداکثر طول:  
    256
    الزامی

    Exact case-sensitive public model name or registered alias

  • locale
    نوع: string فهرست مقادیر

    Document language; falls back to English when unavailable

    مقادیر
    • en
    • zh-CN
    • zh-TW
    • ja
    • ko
هدرها
  • If-None-Match
    نوع: string

    Previous ETag; matching content returns 304

پاسخ‌ها
  • 200
    نوع: object · ModelCatalogModelResponse

    Public model details

    • data
      نوع: object · CatalogModel
      الزامی
      • author
        نوع: string · Authorتهی‌پذیر
        الزامی
      • author_display_name
        نوع: string · Author Display Nameتهی‌پذیر
        الزامی
      • available_content_locales
        نوع: array string[] · Available Content Localesفهرست مقادیر
        الزامی
        مقادیر
        • en
        • zh-CN
        • zh-TW
        • ja
        • ko
      • best_for
        نوع: array string[] · Best For
        الزامی
      • capabilities
        نوع: array string[] · Capabilities
        الزامی
      • content_locale
        نوع: string · Content Localeفهرست مقادیرتهی‌پذیر
        الزامی
        مقادیر
        • en
        • zh-CN
        • zh-TW
        • ja
        • ko
      • context_length
        نوع: integer · Context Lengthتهی‌پذیر
        الزامی

        Integer numbers.

      • description
        نوع: string · Descriptionتهی‌پذیر
        الزامی
      • document
        نوع: object · PublicDocumentتهی‌پذیر
        الزامی

        فقط زبان انتخاب‌شده؛ summary/description/best_for روی مدل می‌مانند

        • extra
          نوع: object · Extra
          الزامی
          • propertyName
            نوع: anything
        • notice
          نوع: object · CatalogNoticeتهی‌پذیر
          الزامی
          • body
            نوع: string · Body
            الزامی
          • link_text
            نوع: string · Link Textتهی‌پذیر
            الزامی
          • target_slug
            نوع: string · Target Slugتهی‌پذیر
            الزامی
          • title
            نوع: string · Titleتهی‌پذیر
            الزامی
        • updated_at
          نوع: string · Updated At
          الزامی

          زمان به‌روزرسانی سند زبان انتخاب‌شده

      • icon_url
        نوع: string · Icon Urlتهی‌پذیر
        الزامی
      • id
        نوع: string · Id
        الزامی
      • input_modalities
        نوع: array string[] · Input Modalities
        الزامی
      • latency_class
        نوع: string · Latency Classتهی‌پذیر
        الزامی
      • max_completion_tokens
        نوع: integer · Max Completion Tokensتهی‌پذیر
        الزامی

        Integer numbers.

      • model_kind
        نوع: string · Model Kindفهرست مقادیر
        الزامی
        مقادیر
        • chat
        • image_generation
        • video_generation
        • decisions
      • name
        نوع: string · Name
        الزامی
      • output_modalities
        نوع: array string[] · Output Modalities
        الزامی
      • reasoning
        نوع: object · Reasoningتهی‌پذیر
        الزامی

        شیء JSON استدلال بالادست؛ فیلدهای ناشناخته را حفظ می‌کند؛ در صورت عدم دسترسی null

        • propertyName
          نوع: anything
      • released_at
        نوع: string · Released Atتهی‌پذیر
        الزامی

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

      • short_name
        نوع: string · Short Name
        الزامی
      • slug
        نوع: string · Slug
        الزامی
      • sort_order
        نوع: integer · Sort Order
        الزامی

        Integer numbers.

      • summary
        نوع: string · Summaryتهی‌پذیر
        الزامی
      • supported_parameters
        نوع: array string[] · Supported Parameters
        الزامی
      • trial_status
        نوع: string · Trial Status
        الزامی
      • updated_at
        نوع: string · Updated Atتهی‌پذیر
        الزامی
      • video_spec
        نوع: object · VideoSpecتهی‌پذیر
        الزامی
        • aspect_ratios
          نوع: array string[] | null · Aspect Ratiosتهی‌پذیر
        • audio
          نوع: object · AudioSpecتهی‌پذیر
          • input
            نوع: boolean · Inputتهی‌پذیر
          • output
            نوع: boolean · Outputتهی‌پذیر
          • output_optional
            نوع: boolean · Output Optionalتهی‌پذیر
        • constraints
          نوع: object · Constraintsتهی‌پذیر

          JSON Schema فقط‌داده برای ترکیب‌های معتبر درخواست

          • propertyName
            نوع: anything
        • duration_seconds
          نوع: object · DurationSpecتهی‌پذیر
          • max
            نوع: number · Max
            بزرگ‌تر از:  
            0
            الزامی
          • min
            نوع: number · Min
            حداقل:  
            0
            الزامی
          • step
            نوع: number · Step
            بزرگ‌تر از:  
            0
            الزامی
        • example_request
          نوع: object · Example Requestتهی‌پذیر
          • propertyName
            نوع: anything
        • input_modes
          نوع: array string[] | null · Input Modesتهی‌پذیر
        • reference_limits
          نوع: object · Reference Limitsتهی‌پذیر
          • propertyName
            تهی‌پذیر
            • نوع: integer

              Integer numbers.

        • request_defaults
          نوع: object · Request Defaultsتهی‌پذیر
          • propertyName
            نوع: anything
        • resolutions
          نوع: array string[] | null · Resolutionsتهی‌پذیر
      • channels
        نوع: array object[] · Channels
        • code
          نوع: string · Code
          الزامی
        • discount_multiplier
          نوع: string · Discount Multiplierتهی‌پذیر
          الزامی

          ضریب فروش دقیق از 0 تا 1؛ یک‌بار روی نرخ‌های پیکربندی‌شده یا هزینه بالادست اعمال شود

        • is_default
          نوع: boolean · Is Default
          الزامی
        • name
          نوع: string · Name
          الزامی
        • region
          نوع: string · Regionتهی‌پذیر
          الزامی
        • runnable
          نوع: boolean · Runnable
          الزامی
        • service_tier
          نوع: string · Service Tier
          الزامی
        • standard_pricing
          نوع: object · CatalogPricingتهی‌پذیر
          الزامی

          نرخ‌های واحد استاندارد پیش از تخفیف فروش؛ برای کانال‌های upstream_cost مقدار null

          • basis
            مقدار ثابت:  
            standard
            الزامی
          • billing_kind
            نوع: string · Billing Kind
            الزامی
          • channel
            نوع: string · Channel
            الزامی
          • currency
            مقدار ثابت:  
            USD
            الزامی
          • tiers
            نوع: array object[] · Tiers
            الزامی

            ترتیب را حفظ کنید؛ اولین سطح منطبق نرخ‌های پایه را بازنویسی می‌کند

            • conditions
              نوع: array object[] · Conditions
              الزامی
              • field
                نوع: string · Field
                الزامی

                بافت قیمت‌گذاری Felo، مثلاً input_context_tokens

              • operator
                نوع: string · Operatorفهرست مقادیر
                الزامی
                مقادیر
                • eq
                • gt
                • gte
              • value
                الزامی
                • نوع: string · Value
            • overrides
              نوع: object · Overrides
              الزامی
              • propertyName
                نوع: string
          • audio
            نوع: string · Audioتهی‌پذیر

            دلار آمریکا به ازای هر توکن صدای ورودی

          • completion
            نوع: string · Completionتهی‌پذیر

            دلار آمریکا به ازای هر توکن خروجی

          • credit
            نوع: string · Creditتهی‌پذیر

            USD per credit; billed using the upstream call multiplier

          • input_audio_cache
            نوع: string · Input Audio Cacheتهی‌پذیر

            دلار آمریکا به ازای هر توکن صدای کش‌شده

          • input_cache_read
            نوع: string · Input Cache Readتهی‌پذیر

            دلار آمریکا به ازای هر توکن ورودی کش‌شده

          • input_cache_write
            نوع: string · Input Cache Writeتهی‌پذیر

            دلار آمریکا به ازای هر توکن نوشتن کش

          • input_cache_write_12h
            نوع: string · Input Cache Write 12Hتهی‌پذیر

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

          • input_cache_write_1h
            نوع: string · Input Cache Write 1Hتهی‌پذیر

            دلار آمریکا به ازای هر توکن نوشتن کش 1 ساعته؛ جدا از نوشتن‌های TTL پیش‌فرض

          • input_image
            نوع: string · Input Imageتهی‌پذیر

            دلار آمریکا به ازای هر تصویر ورودی

          • input_image_cache
            نوع: string · Input Image Cacheتهی‌پذیر

            USD per cached image token

          • input_image_token
            نوع: string · Input Image Tokenتهی‌پذیر

            دلار آمریکا به ازای هر توکن تصویر ورودی

          • input_video_second
            نوع: string · Input Video Secondتهی‌پذیر

            دلار آمریکا به ازای هر ثانیه ویدیوی ورودی

          • internal_reasoning
            نوع: string · Internal Reasoningتهی‌پذیر

            دلار آمریکا به ازای هر توکن استدلال

          • output_image
            نوع: string · Output Imageتهی‌پذیر

            دلار آمریکا به ازای هر تصویر تولیدشده

          • output_image_token
            نوع: string · Output Image Tokenتهی‌پذیر

            دلار آمریکا به ازای هر توکن تصویر خروجی

          • output_video_second
            نوع: string · Output Video Secondتهی‌پذیر

            دلار آمریکا به ازای هر ثانیه ویدیوی تولیدشده

          • output_video_token
            نوع: string · Output Video Tokenتهی‌پذیر

            USD per generated video token

          • prompt
            نوع: string · Promptتهی‌پذیر

            دلار آمریکا به ازای هر توکن ورودی؛ null یعنی در دسترس نیست، 0 یعنی رایگان

          • request
            نوع: string · Requestتهی‌پذیر

            دلار آمریکا به ازای هر درخواست

          • web_search
            نوع: string · Web Searchتهی‌پذیر

            دلار آمریکا به ازای هر درخواست جستجوی وب

        • markup_multiplier
          نوع: string · Markup Multiplierتهی‌پذیر

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

        • pricing_mode
          نوع: string · Pricing Modeفهرست مقادیر

          نرخ‌های واحد پیکربندی‌شده، یا هزینه رسانه گزارش‌شده ضرب‌در تخفیف فروش

          مقادیر
          • configured_rates
          • upstream_cost
        • reference_pricing
          تهی‌پذیر

          Public video reference before discount; not a final charge

          • as_of
            نوع: string · As Of
            الزامی
          • canonical_slug
            نوع: string · Canonical Slug
            الزامی
          • pricing_type
            مقدار ثابت:  
            per_second
            الزامی
          • request_defaults
            نوع: object · Request Defaults
            الزامی
            • propertyName
              • نوع: string
          • reservation
            نوع: object · VideoReservation
            الزامی
            • max_duration_seconds
              نوع: integer · Max Duration Seconds
              بزرگ‌تر از:  
              0
              الزامی

              Integer numbers.

            • output_count
              مقدار ثابت:  
              1

              Integer numbers.

            • strategy
              مقدار ثابت:  
              requested_duration_or_model_max
          • rows
            نوع: array object[] · Rows
            الزامی
            • input_image_billing
              نوع: string · Input Image Billingفهرست مقادیر
              الزامی
              مقادیر
              • per_image
              • included
              • not_applicable
            • input_mode
              نوع: string · Input Modeفهرست مقادیر
              الزامی
              مقادیر
              • text_to_video
              • image_to_video
              • first_last_frame
            • max_duration_output_estimate_usd
              نوع: string · Max Duration Output Estimate Usd
              الزامی
            • resolution
              نوع: string · Resolution
              الزامی
            • unit
              نوع: string · Unitفهرست مقادیر
              الزامی
              مقادیر
              • output_video_second
              • video_token
            • unit_price_usd
              نوع: string · Unit Price Usd
              الزامی
            • aspect_ratio
              نوع: string · Aspect Ratioتهی‌پذیر
            • derived_output_second_usd
              نوع: string · Derived Output Second Usdتهی‌پذیر
            • generate_audio
              نوع: boolean · Generate Audioتهی‌پذیر
            • input_image_price_usd
              نوع: string · Input Image Price Usdتهی‌پذیر
            • reservation_supported
              مقدار ثابت:  
              true
            • reservation_unavailable_reason
              نوع: null · Reservation Unavailable Reason
            • size
              نوع: string · Sizeتهی‌پذیر
          • seed_supported
            نوع: boolean · Seed Supported
            الزامی
          • snapshot_id
            نوع: string · Snapshot Id
            الزامی
          • source_model_id
            نوع: string · Source Model Id
            الزامی
          • supported_aspect_ratios
            نوع: array string[] · Supported Aspect Ratios
            الزامی
          • supported_durations
            نوع: array integer[] · Supported Durations
            الزامی
          • supported_frame_images
            نوع: array string[] · Supported Frame Images
            الزامی
          • supported_resolutions
            نوع: array string[] · Supported Resolutions
            الزامی
          • basis
            مقدار ثابت:  
            public_reference_before_discount
          • currency
            مقدار ثابت:  
            USD
          • settlement_basis
            مقدار ثابت:  
            upstream_cost
          • version
            مقدار ثابت:  
            1

            Integer numbers.

        • sale_pricing
          نوع: object · VideoSalePricingتهی‌پذیر

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

          • basis
            مقدار ثابت:  
            sale_before_discount
            الزامی
          • currency
            مقدار ثابت:  
            USD
            الزامی
          • rows
            نوع: array object[] · Rows
            الزامی

            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
              نوع: object · Conditions
              الزامی

              Equality-condition summary; predicates retain the complete rule semantics

              • propertyName
                نوع: anything
            • rates
              نوع: object · Rates
              الزامی

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

              • propertyName
                نوع: string
            • predicates
              نوع: array object[] | null · Predicatesتهی‌پذیر

              Ordered rule predicates including range comparisons

              • field
                نوع: string · Field
                الزامی

                بافت قیمت‌گذاری Felo، مثلاً input_context_tokens

              • operator
                نوع: string · Operatorفهرست مقادیر
                الزامی
                مقادیر
                • eq
                • gt
                • gte
              • value
                الزامی
                • نوع: string · Value
          • minimum_charge_usd
            نوع: string · Minimum Charge Usdتهی‌پذیر

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

          • selection
            مقدار ثابت:  
            first_match

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

          • unit
            نوع: string · Unitتهی‌پذیر

            Primary billing unit, e.g. output_video_second or video_token

        • second_pricing
          نوع: object · VideoSecondPricingتهی‌پذیر

          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
            مقدار ثابت:  
            sale_before_discount
            الزامی
          • currency
            مقدار ثابت:  
            USD
            الزامی
          • rows
            نوع: array object[] · Rows
            الزامی
            • estimated
              نوع: boolean · Estimated
              الزامی

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

            • per_second_usd
              نوع: string · Per Second Usd
              الزامی

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

            • aspect_ratio
              نوع: string · Aspect Ratioتهی‌پذیر
            • generate_audio
              نوع: boolean · Generate Audioتهی‌پذیر
            • input_image_usd
              نوع: string · Input Image Usdتهی‌پذیر

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

            • input_mode
              نوع: string · Input Modeتهی‌پذیر
            • predicates
              نوع: array object[] | null · Predicatesتهی‌پذیر

              Full conditions for this per-second price row

              • field
                نوع: string · Field
                الزامی

                بافت قیمت‌گذاری Felo، مثلاً input_context_tokens

              • operator
                نوع: string · Operatorفهرست مقادیر
                الزامی
                مقادیر
                • eq
                • gt
                • gte
              • value
                الزامی
                • نوع: string · Value
            • resolution
              نوع: string · Resolutionتهی‌پذیر
          • second_basis
            نوع: string · Second Basisفهرست مقادیر
            الزامی

            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.

            مقادیر
            • exact
            • token_pixel_frames_estimate
          • pricing_type
            نوع: string · Pricing Typeتهی‌پذیر

            per_second or video_token

        • settlement_policy
          نوع: object · PublicSettlementPolicyتهی‌پذیر

          Published primary pricing and missing-usage fallback policy

          • fallback
            نوع: string · Fallbackفهرست مقادیر
            الزامی
            مقادیر
            • upstream_cost
            • review_required
          • primary
            مقدار ثابت:  
            configured_rates
            الزامی
          • version
            مقدار ثابت:  
            1
            الزامی

            Integer numbers.

      • default_channel
        نوع: string · Default Channelتهی‌پذیر
      • parameter_definitions
        نوع: 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
          نوع: object
          • propertyName
            نوع: anything
      • recommended_protocol
        نوع: string · Recommended Protocolفهرست مقادیرتهی‌پذیر

        فقط توصیه کلاینت در سطح مدل؛ برای مدل‌های غیرچت null؛ پروتکل‌های قابل فراخوانی را محدود نمی‌کند

        مقادیر
        • responses
        • messages
    • locale
      نوع: string · Localeفهرست مقادیر
      الزامی
      مقادیر
      • en
      • zh-CN
      • zh-TW
      • ja
      • ko
    • schema_version
      مقدار ثابت:  
      2
      الزامی

      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

به کمک نیاز دارید؟

  • برای پرسش‌های مربوط به API، صورت‌حساب و حساب کاربری با پشتیبانی در تماس باشید.
  • با توسعه‌دهندگان Felo در Discord گفت‌وگو کنید.
  • تاریخچه تغییرات ما را ببینید.
  • به قیمت‌گذاری حجمی یا کمک در خرید نیاز دارید؟ تماس با فروش.
  • با LLM می‌سازید؟ llms.txt را بخوانید.