FastGPTFastGPT

Get Available Model Catalog

Retrieve all models, providers, and default model IDs available to the caller with optional version caching and custom sorting.

Endpoint Overview

  • Method : GET
  • Path : /api/core/ai/model/catalog
  • Module : Core Features / Models
  • Authentication : Authorization: Bearer <apiKey>—Personal API Key (access scoped by team member permissions) (see API Getting Started )
  • Interactive Try-It-Out : Open in Scalar API Explorer (self-hosted instances: replace the origin with <instance>/apidoc/systemopenapi#tag/%E6%A8%A1%E5%9E%8B%E7%AE%A1%E7%90%86/GET/core/ai/model/catalog )

Description & Notes

Returns available models, providers, and effective default model IDs for the authenticated member or share-link identity in a single request, with content version negotiation. Passing orderBy=custom orders by own team models, shared team models, and system models sorted by rank ; omitting preserves runtime order. Members may pass includeSourceMember=true to attach creator details (always returning the full catalog; ignored for share links).

Request Parameters

Query Parameters

FieldTypeRequiredDefaultConstraints & Description
versionstringNo-Client-cached catalog version hash. minLength: 1
includeSourceMemberbooleanNo-Attach source member metadata (members only; always returns the full catalog without version cache)
orderBy"custom"No-Catalog display sorting: custom orders own team, shared team, and system models by rank; omit to keep runtime order. Fixed: "custom"
outLinkAuthDatastringNo-Share-link auth payload used to evaluate permissions via the link publisher identity

Request Examples

Replace YOUR_API_KEY and placeholder IDs before running. Self-hosted users should replace the base URL with <instance>/api .

cURL Example

curl --fail-with-body -X GET "https://cloud.fastgpt.io/api/core/ai/model/catalog" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response Schema & Examples

Successful /api/* calls return the standard FastGPT envelope { "code": 200, "statusText": "", "message": "", "data": ... } , where data matches the 200 schema below (when a payload schema is declared; otherwise refer to the status description for runtime data semantics).

HTTP 200

Returns the full catalog when the version changes or includeSourceMember=true ; otherwise returns only version

Content-Type : application/json

FieldTypeRequiredDefaultConstraints & Description
versionstringYes-Current model catalog version hash
dataobjectNo-Full catalog payload (omitted when client version matches and creator details are not requested)
data.modelsobject[]Yes--
data.providersobject[]Yes--
data.providers[].providerstringYes-Model provider identifier
data.providers[].valueobjectYes--
data.providers[].value.enstringYes--
data.providers[].value.zh-CNstringYes--
data.providers[].value.zh-HantstringYes--
data.providers[].avatarstringYes-Model provider icon URL
data.defaultModelIdsobjectYes--
data.defaultModelIds.llmstringNo--
data.defaultModelIds.embeddingstringNo--
data.defaultModelIds.ttsstringNo--
data.defaultModelIds.sttstringNo--
data.defaultModelIds.rerankstringNo--
data.defaultModelIds.datasetTextLLMstringNo--
data.defaultModelIds.datasetImageLLMstringNo--
data.defaultModelIds.chatTitleLLMstringNo--
Edit on GitHub

Last updated

On this page

Put your business knowledge to work with AI

Import company documents and build accurate, reliable, traceable AI answers.