Beatra

Model detail with typed media interface cards

GET
/v1/catalog/models/{model}

Path Parameters

model
Required
Model

Header Parameters

Authorization
Required
string

Bearer API key.

X-Request-Idstring

Optional client request id echoed in the response.

curl -X GET "https://example.com/v1/catalog/models/string" \
  -H "Authorization: string" \
  -H "X-Request-Id: string"

Successful Response

{
  "model": "string",
  "display_name": "string",
  "owned_by": "Beatra",
  "description": "string",
  "status": "available",
  "interfaces": [
    {
      "schema_version": "image-interface.v1",
      "model": "string",
      "display_name": "string",
      "owned_by": "Beatra",
      "capability": "text_to_image",
      "quality_tier": "pro",
      "status": "available",
      "controls": [
        {
          "field": "string",
          "value_type": "string",
          "required": true,
          "nullable": true,
          "default": "string",
          "model_default": true,
          "omitted_behavior": "invalid",
          "null_behavior": "invalid",
          "allowed_values": [
            "string"
          ],
          "minimum": 0,
          "maximum": 0,
          "min_items": 0,
          "max_items": 0,
          "max_length": 0
        }
      ],
      "prompt": {
        "limit": 0,
        "unit": "characters",
        "overflow": "reject",
        "languages": [
          "en"
        ],
        "counter": "unicode_characters",
        "counter_is_exact": true,
        "counter_unavailable_behavior": "reject"
      },
      "inputs": {
        "minimum_count": 0,
        "public_max_count": 4,
        "native_max_count": 0,
        "formats": [
          "string"
        ],
        "hard_constraints": {
          "max_bytes": 0,
          "edge_pixels": {
            "minimum": 0,
            "maximum": 0
          },
          "aspect_ratio": {
            "minimum": "string",
            "maximum": "string"
          },
          "alpha": "allowed"
        },
        "recommendations": {
          "edge_pixels": {
            "minimum": 0,
            "maximum": 0
          }
        },
        "animation": {
          "property1": "as_provided",
          "property2": "as_provided"
        },
        "transport": {
          "accepted_kinds": [
            "artifact"
          ],
          "https_only": true,
          "data_uri_max_encoded_length": 0
        },
        "ordering": "none",
        "source_aspect_anchor": "none"
      },
      "outputs": {
        "public_max_count": 1,
        "native_max_independent_count": 1,
        "native_max_sequence_count": 1,
        "relationships": [
          "independent"
        ],
        "format": "image/png"
      },
      "canvas": {
        "default": {
          "property1": "string",
          "property2": "string"
        },
        "preset_tiers": [
          "1K"
        ],
        "target": {
          "supported": true,
          "minimum_total_pixels": 0,
          "maximum_total_pixels": 0,
          "minimum_aspect_ratio": "string",
          "maximum_aspect_ratio": "string",
          "normalization_multiple": 0,
          "actual_dimensions_may_differ": true
        },
        "source_aspect_anchor": "none"
      },
      "rules": [
        {
          "id": "string",
          "when": [
            {
              "field": "string",
              "operator": "equals",
              "value": "string"
            }
          ],
          "effect": {
            "type": "allow",
            "field": "string",
            "value": "string"
          }
        }
      ],
      "pricing": {
        "unit_credits": "string",
        "unit": "image",
        "billing_basis": "successful_image_count"
      },
      "auto": {
        "default_model": "auto",
        "basic_request_preference": "string",
        "request_dependent": true,
        "persisted_selection_field": "resolved_model",
        "description": "string"
      }
    }
  ]
}