List LLM Provider Definitions

Endpoint

GET /apiops/projects/{projectName}/llm-provider-definitions/

Authentication

Requires a Personal API Access Token.

Header

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header	Value	Required
Authorization	Bearer {token}	Yes

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name

Query Parameters

None

Response

Success Response (200 OK)

{
  "status": "SUCCESS",
  "resultList": [
    {
      "id": "6702a1f4e1b2c3d4e5f60101",
      "projectId": null,
      "name": "openai",
      "code": "openai",
      "displayName": "OpenAI",
      "defaultEndpoint": "https://api.openai.com/v1",
      "defaultApiVersion": null,
      "defaultAuthScheme": "BEARER",
      "defaultAuthHeaderName": "Authorization",
      "iconUrl": "https://cdn.apinizer.com/ai-icons/openai.svg",
      "docsUrl": "https://platform.openai.com/docs",
      "builtIn": true,
      "lastUpdatedAt": "2026-05-10T08:00:00Z"
    },
    {
      "id": "6712b2f4e1b2c3d4e5f60222",
      "projectId": "660f1e2a9c4b5a6d7e8f9012",
      "name": "internal-llm-gateway",
      "code": "internal-llm-gateway",
      "displayName": "Internal LLM Gateway",
      "defaultEndpoint": "https://llm-gateway.internal.example.com/v1",
      "defaultApiVersion": "v1",
      "defaultAuthScheme": "API_KEY_HEADER",
      "defaultAuthHeaderName": "x-api-key",
      "iconUrl": null,
      "docsUrl": null,
      "builtIn": false,
      "lastUpdatedAt": "2026-07-20T14:32:00Z"
    }
  ],
  "resultCount": 2
}

Response Fields

Field	Type	Description
status	string	Response status: SUCCESS or FAILURE
resultList	array	List of LLM provider catalog definition objects
resultCount	integer	Total number of definitions returned

LLM Provider Definition Object Fields

Field	Type	Description
id	string	Internal identifier (read-only)
projectId	string	Owning project identifier; null for built-in (global) entries (read-only)
name	string	Definition name — unique within its visible scope
code	string	Provider type code (e.g. openai, anthropic, azure-openai); matches EnumLlmProviderType values for built-in entries
displayName	string	UI label (e.g. OpenAI, Anthropic Claude)
defaultEndpoint	string	Default base API URL; blank for tenant-specific providers (Azure/Bedrock/Vertex)
defaultApiVersion	string	Default API version (e.g. 2024-02-15-preview for Azure)
defaultAuthScheme	string	Default auth scheme enum constant (BEARER, API_KEY_HEADER, BASIC, AWS_SIGV4, OAUTH2, NONE, CUSTOM)
defaultAuthHeaderName	string	Default credential header name (e.g. Authorization, x-api-key, api-key)
iconUrl	string	Provider icon URL (optional)
docsUrl	string	Vendor documentation deep link (optional)
builtIn	boolean	true for platform-shipped catalog entries (read-only, seeded by Mongock); false for project custom entries
lastUpdatedAt	string	ISO-8601 timestamp of the last update (read-only)

EnumStatus

• SUCCESS - Operation successful
• FAILURE - Operation failed

Error Response (400 Bad Request)

{
  "status": "FAILURE",
  "resultMessage": "Project (name: MyProject) was not found!"
}

Error Response (401 Unauthorized)

{
  "status": "FAILURE",
  "resultMessage": "Token is not valid!"
}

cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/llm-provider-definitions/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Notes and Warnings

• Read Scope:
  • Returns the union of built-in catalog entries (projectId: null) and the calling project's own custom entries — not other projects' custom entries
• No Secrets:
  • The entity carries no @SecretData fields (endpoint/API-version/auth-scheme defaults only); nothing is masked in this response
• Enum Serialization:
  • defaultAuthScheme serializes as the enum constant name (e.g. BEARER, API_KEY_HEADER), not lowercase
• Empty List:
  • If the project has no custom entries and no built-in catalog is seeded, an empty resultList with resultCount: 0 is returned

Related Documentation

• Get LLM Provider Definition - Retrieve a single definition by name
• Create LLM Provider Definition - Create or upsert a custom definition
• LLM Provider Definitions API - Resource overview, permissions and the LlmProviderDefinition vs. LLM Provider distinction
• Authentication Guide - How to obtain and use API tokens