POST/api/models

Create a custom model

Creates an organization-owned model row, its deployments (always customer_managed, billed to your own provider or endpoint) and its default chain. Idempotent: an exact replay answers 200 with the existing rows; the same slug with different attributes answers 409, and a public model's slug answers 409 model_slug_reserved (add a deployment to the public model instead). A deployment with a base_url needs a verified payment method and counts toward 10 new endpoints per hour.

認証: AuthorizationヘッダーにBearer形式のAPIキー

リクエストボディ

  • org_idstring | null

    Owning organization. Implied by a key; a session caller must name one.

  • slugstring必須

    Letter first, lowercase alphanumerics with single ., _ or - separators. Becomes the model name requests send.

  • display_namestring必須
  • descriptionstring | null
  • release_datestring | null
  • context_windowinteger | null
  • max_output_tokensinteger | null
  • input_modalitiesarray<enum>
    デフォルト: ["text"]
  • output_modalitiesarray<enum>
    デフォルト: ["text"]
  • supported_paramsobject

    Parameters the model supports, for example {"temperature": true, "tools": true}.

    デフォルト: {}
  • categorystring | null
  • tagsarray<string>
    デフォルト: []
  • providersarray<object>必須
    providers
    • providerenum必須
      "openai""anthropic""gemini""azure_openai""openrouter""bedrock""local""fireworks""modal""experiential_cloud"
    • provider_model_idstring必須
    • base_urlstring | null

      Required for local and modal; forbidden for fixed-origin providers. An explicit http(s) endpoint with optional port and path, no userinfo, query or fragment.

    • regionstring | null
    • api_versionstring | null
    • provider_connection_idstring | null

      Pin to one of your API-key BYOK connections of the same provider; null resolves by provider at request time.

    • input_nano_usd_per_millioninteger | null

      Integer nano-USD per million tokens; null = unknown.

    • cached_input_nano_usd_per_millioninteger | null
    • cache_write_input_nano_usd_per_millioninteger | null
    • cache_write_1h_input_nano_usd_per_millioninteger | null
    • long_context_cache_write_input_nano_usd_per_millioninteger | null
    • long_context_cache_write_1h_input_nano_usd_per_millioninteger | null
    • output_nano_usd_per_millioninteger | null
    • reasoning_nano_usd_per_millioninteger | null
    • pricing_sourcestring | null

      Where the rates come from (for example self-reported). provider-free-tier is reserved and refused.

    • capabilitiesobject

      Wire capabilities. Seeded from the model's supported_params; explicit keys win.

      デフォルト: {}
    • uptime_30dnumber | null
    • throughput_tpsnumber | null
    • latency_p50_msnumber | null
    • stats_sourceenum
      "openrouter""observed""estimate"null
    • endpoint_api_keystring | null

      local only. Sent to your endpoint as Authorization: Bearer <key>. Stored in a vault, never returned.

レスポンス

  • 201

    Created. A replay of an identical request answers 200 with the same body.

    レスポンス
    • modelobject

      One catalog model row.

      model
      • idstring
      • slugstring

        The name a request sends as model.

      • display_namestring
      • descriptionstring | null
      • release_datestring | null

        ISO date.

      • context_windowinteger | null

        Advertised window in tokens. For most makers it is a total that includes the maximum output.

      • max_output_tokensinteger | null
      • max_input_tokensinteger | null

        The prompt budget a caller can actually send (the window minus the maximum output when the window is a total). Pin client compaction to this, not context_window.

      • input_modalitiesarray<enum>
      • output_modalitiesarray<enum>
      • supported_paramsobject

        Logical parameters the model supports, for example {"tools": true}.

      • categorystring | null
      • tagsarray<string>
      • iconstring | null

        Maker family key used for the icon.

      • makerstring | null
      • owning_org_idstring | null

        Your organization id for a custom model; null for a public model.

      • preferred_rankinteger | null

        Curated rank (lower first); null when unranked.

      • statusstring

        active or hidden.

      • created_atstring
      • updated_atstring
    • providersarray<object>
      providers
      • idstring

        Deployment id, or byok:{connection_id} for a lane served by your own provider connection. This is the token a waterfall write uses.

      • model_idstring
      • providerstring

        Provider id as shown to you; platform lanes run on our own capacity show experiential_cloud.

      • provider_model_idstring

        The provider's wire id.

      • base_urlstring | null

        Endpoint of a customer-run (local, modal) deployment.

      • regionstring | null
      • api_versionstring | null
      • owning_org_idstring | null

        Your organization for a private lane; null for a public lane.

      • provider_connection_idstring | null

        The pinned BYOK connection, if any.

      • connection_aliasstring | null

        On BYOK lanes only: the connection's account alias, which tells two same-provider accounts apart.

      • route_idstring | null

        Opaque per-organization handle for selecting exactly this lane on a request. Null without an organization context or when the lane cannot serve your traffic.

      • provider_statusobject

        The provider's own public status report for this lane. Advisory only, never routing input.

        provider_status
        • stateenum
          "incident_reported""no_incident_reported""stale_unavailable""no_verified_feed"
        • official_urlstring | null
        • checked_atstring | null
        • scopestring
        • limitationstring
        • incidentsarray<object>
        • advisoryboolean
      • provider_logo_urlstring

        Registry provider logo, when one exists. Omitted otherwise.

      • billing_sourceenum

        host_managed bills your credits; customer_managed bills your own provider or endpoint.

        "host_managed""customer_managed"
      • input_nano_usd_per_millioninteger | null
      • cached_input_nano_usd_per_millioninteger | null
      • cache_write_input_nano_usd_per_millioninteger | null
      • cache_write_1h_input_nano_usd_per_millioninteger | null
      • long_context_cache_write_input_nano_usd_per_millioninteger | null
      • long_context_cache_write_1h_input_nano_usd_per_millioninteger | null
      • cache_write_12h_input_nano_usd_per_millioninteger | null

        Null on a lane supporting 12-hour cache means 2.5 times the input rate.

      • output_nano_usd_per_millioninteger | null
      • reasoning_nano_usd_per_millioninteger | null
      • image_output_nano_usd_per_millioninteger | null

        Generated-image tokens rate; null bills them as output.

      • long_context_threshold_tokensinteger | null

        Once reported input tokens reach this, the long_context_* rates price the whole request. Null means flat pricing.

      • long_context_input_nano_usd_per_millioninteger | null
      • long_context_cached_input_nano_usd_per_millioninteger | null
      • long_context_output_nano_usd_per_millioninteger | null
      • long_context_reasoning_nano_usd_per_millioninteger | null
      • unit_pricesobject

        A per-unit lane's only meter.

        unit_prices
        • kindenum
          "character""audio_second""video_second""image"
        • ratesobject

          Integer nano-USD per unit by variant ("" is the flat rate).

      • off_peak_pricingobject

        Off-peak price card with its weekly UTC peak windows (prices, peak_windows, off_peak_dates). The headline rates are the peak price. Omitted when absent.

      • pricing_sourcestring | null
      • pricing_effective_atstring | null
      • capabilitiesobject

        Wire capabilities the gateway enforces (for example supports_tools, supported_reasoning_efforts).

      • uptime_30dnumber | null

        Percent.

      • uptime_recentnumber | null

        Completed share (percent) of the route's most recent requests; null under 50 requests.

      • uptime_recent_requestsinteger | null
      • throughput_tpsnumber | null

        Observed decode tokens per second.

      • latency_p50_msnumber | null

        Observed median time to first token.

      • request_latency_p50_msnumber | null

        Observed median end-to-end latency of calls with no first token.

      • stats_sourceenum
        "openrouter""observed""estimate"null
      • statusstring
      • routableboolean | null

        Whether the gateway's active plan routes this platform lane. Null when not applicable.

      • requires_paymentboolean

        Paid-only lane (a completed top-up opens it).

      • requires_purchaseboolean

        Purchase-required lane (a real purchase, not the $1 verification, opens it).

      • zdr_onlyboolean

        Serves only requests routed under zero data retention.

      • hidden_fallbackboolean
      • available_to_orgboolean | null

        Whether your organization may use this closed lane. Null without an organization context or for an open lane.

      • zero_data_retentionboolean | null

        Detail route only. Null means no posture coverage, which a require-ZDR policy treats as non-compliant.

      • zero_data_retention_on_requestboolean | null

        ZDR only when dispatched under the gateway's per-request ZDR constraint.

      • processing_region_setsarray<array<string>>
      • plan_discountsobject | null
        いずれか

        object

        • freenumber
        • pronumber
        • maxnumber
        • ultranumber
      • service_tier_ratesobject | null

        Per-tier rate cards (flex, priority) in nano-USD per million tokens when the lane prices processing tiers.

      • ladder_rankinteger | null

        Display-only position among the model's public platform lanes.

      • ladder_lane_countinteger | null
      • ladder_scorenumber | null
      • ladder_factorsobject | null
      • endpoint_credential_last4string | null

        Last four characters of a stored endpoint API key.

      • created_atstring
      • updated_atstring
    • default_waterfallarray<object>
      default_waterfall
      • idstring
      • positioninteger

        0 is tried first.

      • model_provider_idstring | null
      • provider_connection_idstring | null
      • target_kindenum
        "deployment""connection""model"
      • referenced_model_idstring | null
      • referenced_modelobject | null
        いずれか

        object

        • idstring
        • slugstring
        • display_namestring
        • statusstring
      • providerstring | null
      • provider_model_idstring | null
      • base_urlstring | null
      • statusstring
      • rungstring | null

        The token to send in a PUT or PATCH: the deployment id, byok:{connection_id} or model:{model_id}.

      • fundingenum
        "platform""own_key""own_endpoint""fallback_model"null
      • healthobject | null
        いずれか

        object

        • statestring

          Fleet verdict, for example healthy, degraded, recovering, throttled, circuit_open, disabled. A BYOK rung reports its connection status.

        • reasonstring | null
        • lifecycleenum
          "active""draining""retired"
    • retentionenum

      Zero data retention across the platform lanes: all, at least one, or none.

      "zdr_all_rungs""zdr_enforceable""not_zdr"null
    • huggingface_urlstring | null
    • release_urlstring | null
    • benchmarksarray<object>
      benchmarks
      • benchmarkstring
      • display_namestring
      • unitstring
      • higher_is_betterboolean
      • scorenumber
      • sourcestring
      • source_urlstring | null
      • retrieved_atstring
    • promotionsarray<object>
      promotions
      • labelstring
      • listedboolean
      • badge_styleenum
        "allowance""free"
      • display_onlyboolean
    • promotional_listedboolean
    • ads_on_all_requestsboolean

      Sponsored ads may appear on every platform-funded request to this model.

  • 401

    Missing, unknown or revoked API key.

    レスポンス
    • errorstring必須

      Human-readable message.

    • codestring

      Stable machine reason, when the route defines one (for example pro_required).

    • actionstring

      Stable remediation action, when the route defines one.

    • detailsobject

      Customer-safe string facts the caller needs to act (for example a suggested identifier).

  • 403

    The organization is under review (org_under_review), or a base_url deployment needs a verified payment method (endpoint_requires_verified_payment).

    レスポンス
    • errorstring必須

      Human-readable message.

    • codestring

      Stable machine reason, when the route defines one (for example pro_required).

    • actionstring

      Stable remediation action, when the route defines one.

    • detailsobject

      Customer-safe string facts the caller needs to act (for example a suggested identifier).

  • 404

    org_id names an organization you cannot act in, or provider_connection_id is not one of your connections.

    レスポンス
    • errorstring必須

      Human-readable message.

    • codestring

      Stable machine reason, when the route defines one (for example pro_required).

    • actionstring

      Stable remediation action, when the route defines one.

    • detailsobject

      Customer-safe string facts the caller needs to act (for example a suggested identifier).

  • 409

    The slug exists with different attributes, or is a public model's slug (model_slug_reserved).

    レスポンス
    • errorstring必須

      Human-readable message.

    • codestring

      Stable machine reason, when the route defines one (for example pro_required).

    • actionstring

      Stable remediation action, when the route defines one.

    • detailsobject

      Customer-safe string facts the caller needs to act (for example a suggested identifier).

  • 422

    Body validation failed, or a rule the schema enforces (for example pricing_source_reserved, a connection of the wrong provider, or plan_connection_not_pinnable).

  • 429

    The organization created 10 custom endpoints in the last hour (endpoint_creation_rate_limited). Retry-After gives the seconds to wait.

    レスポンス
    • errorstring必須

      Human-readable message.

    • codestring

      Stable machine reason, when the route defines one (for example pro_required).

    • actionstring

      Stable remediation action, when the route defines one.

    • detailsobject

      Customer-safe string facts the caller needs to act (for example a suggested identifier).

リクエスト

curl -X POST https://api.experientiallabs.ai/api/models \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "slug": "my-local-model",
  "display_name": "My Local Model",
  "supported_params": {
    "temperature": true,
    "tools": true
  },
  "context_window": 131072,
  "providers": [
    {
      "provider": "local",
      "provider_model_id": "my-model",
      "base_url": "https://models.acme.dev:8000/v1",
      "endpoint_api_key": "sk-acme-endpoint-4f9a2c7e1b",
      "input_nano_usd_per_million": 0,
      "output_nano_usd_per_million": 0,
      "pricing_source": "self-reported"
    }
  ]
}'

レスポンス

{
  "model": {
    "id": "0b8f3d2a-5c61-4e7f-9a12-7d4e6b1c9f30",
    "slug": "my-local-model",
    "display_name": "My Local Model",
    "description": null,
    "release_date": null,
    "context_window": 131072,
    "max_output_tokens": null,
    "max_input_tokens": 131072,
    "input_modalities": [
      "text"
    ],
    "output_modalities": [
      "text"
    ],
    "supported_params": {
      "temperature": true,
      "tools": true
    },
    "category": null,
    "tags": [],
    "icon": null,
    "maker": null,
    "owning_org_id": "3f6c2a1e-8b7d-4c2a-9e51-6a0d4b2f7c10",
    "preferred_rank": null,
    "status": "active",
    "created_at": "2026-11-19T15:02:11.104512+00:00",
    "updated_at": "2026-11-19T15:02:11.104512+00:00"
  },
  "providers": [
    {
      "id": "5d2e9a71-3b4c-4f80-8e16-2a9c7b0d4e53",
      "model_id": "0b8f3d2a-5c61-4e7f-9a12-7d4e6b1c9f30",
      "provider": "local",
      "provider_model_id": "my-model",
      "base_url": "https://models.acme.dev:8000/v1",
      "region": null,
      "api_version": null,
      "owning_org_id": "3f6c2a1e-8b7d-4c2a-9e51-6a0d4b2f7c10",
      "provider_connection_id": null,
      "billing_source": "customer_managed",
      "input_nano_usd_per_million": 0,
      "cached_input_nano_usd_per_million": null,
      "cache_write_input_nano_usd_per_million": null,
      "cache_write_1h_input_nano_usd_per_million": null,
      "long_context_cache_write_input_nano_usd_per_million": null,
      "long_context_cache_write_1h_input_nano_usd_per_million": null,
      "output_nano_usd_per_million": 0,
      "reasoning_nano_usd_per_million": null,
      "long_context_threshold_tokens": null,
      "long_context_input_nano_usd_per_million": null,
      "long_context_cached_input_nano_usd_per_million": null,
      "long_context_output_nano_usd_per_million": null,
      "long_context_reasoning_nano_usd_per_million": null,
      "pricing_source": "self-reported",
      "pricing_effective_at": "2026-11-19T15:02:11.104512+00:00",
      "capabilities": {
        "supports_temperature": true,
        "supports_tools": true
      },
      "uptime_30d": null,
      "throughput_tps": null,
      "latency_p50_ms": null,
      "stats_source": null,
      "status": "active",
      "endpoint_credential_last4": "7e1b",
      "created_at": "2026-11-19T15:02:11.104512+00:00",
      "updated_at": "2026-11-19T15:02:11.104512+00:00"
    }
  ],
  "default_waterfall": [
    {
      "id": "9c1a4e72-6d3b-4f85-b2e0-1f7a8c5d3e94",
      "position": 0,
      "model_provider_id": "5d2e9a71-3b4c-4f80-8e16-2a9c7b0d4e53",
      "provider_connection_id": null,
      "target_kind": "deployment",
      "referenced_model_id": null,
      "referenced_model": null,
      "provider": "local",
      "provider_model_id": "my-model",
      "base_url": "https://models.acme.dev:8000/v1",
      "status": "active",
      "rung": "5d2e9a71-3b4c-4f80-8e16-2a9c7b0d4e53",
      "funding": "own_endpoint",
      "health": null
    }
  ],
  "retention": null,
  "huggingface_url": null,
  "release_url": null,
  "benchmarks": [],
  "promotions": [],
  "promotional_listed": false,
  "ads_on_all_requests": false
}

https://api.experientiallabs.ai/api/models