List models
List public catalog models and active private models available to your organization.
GET /v1/models
Authorization
Authorizationheader · string- Optional. A bearer API key adds your organization\u2019s active private models.
Request
Request · cURL
curl https://api.boardwalk.cloud/v1/models \
-H "Authorization: Bearer $BOARDWALK_API_KEY"Parameters
This endpoint accepts no request body or query parameters.
Response
Example response. IDs, token counts, and rates are illustrative.
200 · application/json
{
"object": "list",
"data": [
{
"id": "support-agent",
"object": "model",
"created": 1789516800,
"owned_by": "your-organization",
"display_name": "Support agent",
"hf_repo": "your-org/support-agent",
"hf_revision": "0123456789abcdef0123456789abcdef01234567",
"config_revision": "cfg_example",
"dtype": "bfloat16",
"quantization": "none",
"max_model_len": 32768,
"supports_reasoning": true,
"engine": "vllm",
"engine_version": "example",
"price_in_micros_per_mtok": "100000",
"price_out_micros_per_mtok": "300000",
"price_cache_read_micros_per_mtok": "50000",
"price_cache_write_micros_per_mtok": "0",
"status": "active",
"input_modalities": ["text"],
"output_modalities": ["text"],
"supports_tool_calls": true,
"supports_json_mode": true,
"supports_structured_output": true,
"supports_image_input": false,
"supports_image_output": false,
"supports_streaming": true,
"max_output_tokens": 32768,
"supported_endpoints": [
"/v1/chat/completions",
"/v1/completions",
"/v1/tokenize"
],
"supported_parameters": [
"model",
"stream",
"stream_options",
"max_tokens",
"temperature",
"top_p",
"n",
"stop",
"presence_penalty",
"frequency_penalty",
"seed",
"logprobs",
"top_logprobs",
"logit_bias",
"user",
"messages",
"max_completion_tokens",
"tools",
"tool_choice",
"parallel_tool_calls",
"response_format"
],
"supported_response_formats": ["text", "json_object", "json_schema"],
"capabilities_verified_at": 1789516800
}
]
}object"list"- Object type.
dataobject[]- Available models. Example prices are illustrative; use the returned rates.
Child fields
idstring- Callable model ID. Pass this as model in an inference request.
object"model"- Object type.
createdinteger- Creation time in Unix seconds.
owned_bystring- Boardwalk for public models, or the owning organization slug.
display_namestring- Display name.
hf_repostring- Source Hugging Face repository.
hf_revisionstring- Pinned weight commit.
config_revisionstring- Serving configuration revision.
dtypestring- Serving precision.
quantizationstring- Quantization method, or none.
max_model_leninteger- Maximum combined input and output tokens.
supports_reasoningboolean- Whether the active serving configuration has verified reasoning output.
input_modalitiesstring[]- Accepted input types. Currently ["text"]; image, audio, and video inputs are not accepted by the gateway.
output_modalitiesstring[]- Generated output types. Currently ["text"]; image, audio, and video generation are not supported.
supports_tool_callsboolean- Whether the served revision has verified tool-call parsing.
supports_json_modeboolean | null- Whether response_format.type=json_object passed qualification. Null means not yet checked.
supports_structured_outputboolean | null- Whether response_format.type=json_schema passed schema-enforcement qualification. Null means not yet checked.
supports_image_inputboolean- Whether images can be sent in a request. Currently false.
supports_image_outputboolean- Whether this endpoint can generate images. Currently false.
supports_streamingboolean | null- Whether streaming with usage and a terminal event passed qualification. Null means no recorded check.
max_output_tokensinteger- Ceiling for max_tokens and max_completion_tokens. Input and output share max_model_len, so the remaining context may be smaller.
supported_endpointsstring[]- Available API paths for this model: chat completions, text completions, and tokenization.
supported_parametersstring[]- Top-level Chat Completions fields available for this revision. See supported_response_formats for response_format values. Reasoning output does not imply reasoning_effort controls.
supported_response_formatsstring[]- Supported response_format.type values. Always includes text; json_object and json_schema appear only after their checks pass.
capabilities_verified_atinteger | null- Serving revision qualification time in Unix seconds. Null means no qualification timestamp; individual capability results may still be null.
enginestring- Serving engine.
engine_versionstring- Pinned engine version.
price_in_micros_per_mtokstring- Uncached input rate. Integer micro-dollars per million tokens.
price_out_micros_per_mtokstring- Output rate. Integer micro-dollars per million tokens.
price_cache_read_micros_per_mtokstring- Cache-read rate. Integer micro-dollars per million tokens.
price_cache_write_micros_per_mtokstring- Cache-write rate. Integer micro-dollars per million tokens.
statusstring- Current model status.
Capability results
Capabilities describe this served revision through Boardwalk's API. True means supported; false means unavailable or its qualification check did not pass. Null means the revision has no recorded check. Source-model capabilities alone do not establish support.
JSON mode produces a JSON object. Structured output additionally enforces a JSON schema. Reasoning support means reasoning is returned separately from the answer; it does not imply support for reasoning effort or budget controls.
Errors
Errors use the shared error format. Save the x-request-id response header for receipts and support.