Get LLM Provider Definition

Endpoint

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

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
definitionName	string	Yes	Provider catalog definition 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",
      "wireProtocol": "OPENAI_COMPATIBLE",
      "defaultChatCompletionPath": "/chat/completions",
      "defaultEmbeddingPath": "/embeddings",
      "defaultAudioTranscriptionPath": "/audio/transcriptions",
      "defaultAudioSpeechPath": "/audio/speech",
      "defaultImageGenerationPath": "/images/generations",
      "defaultResponsesPath": "/responses",
      "supportsEmbedding": true,
      "supportsResponses": true
    }
  ],
  "resultCount": 1
}

Response Fields

Field	Type	Description
status	string	Response status: SUCCESS or FAILURE
resultList	array	Single-element list containing the requested definition
resultCount	integer	Always 1 on success

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)
displayName	string	UI label
defaultEndpoint	string	Default base API URL
defaultApiVersion	string	Default API version
defaultAuthScheme	string	Default auth scheme enum constant (BEARER, API_KEY_HEADER, BASIC, AWS_SIGV4, OAUTH2, NONE, CUSTOM)
defaultAuthHeaderName	string	Default credential header name
iconUrl	string	Provider icon URL (optional)
docsUrl	string	Vendor documentation deep link (optional)
builtIn	boolean	true for platform-shipped catalog entries (read-only); false for project custom entries
lastUpdatedAt	string	ISO-8601 timestamp of the last update (read-only)
wireProtocol	string	The adapter family this provider's wire format resolves against — one of OPENAI_COMPATIBLE, ANTHROPIC, GEMINI, BEDROCK, VLLM; null when the catalog doesn't vouch for a specific wire format (a Cohere-style provider that only falls through to the OpenAI adapter, for example)
defaultChatCompletionPath	string	Default chat-completion endpoint path (e.g. /chat/completions, /messages)
defaultEmbeddingPath	string	Default embedding endpoint path; null when supportsEmbedding is false
defaultAudioTranscriptionPath	string	Default speech-to-text endpoint path (optional)
defaultAudioSpeechPath	string	Default text-to-speech endpoint path (optional)
defaultImageGenerationPath	string	Default image-generation endpoint path (optional)
defaultResponsesPath	string	Default OpenAI Responses API-style endpoint path (optional)
supportsEmbedding	boolean	Whether this provider has an embedding endpoint
supportsResponses	boolean	Whether this provider supports the Responses-style endpoint

wireProtocol and the path fields can be null

These nine fields were added after the original catalog shape and are backward-compatible: any provider definition saved before they existed simply returns them as null, and nothing about existing behavior changes because of it. See the Provider Type Catalog section for what a null value falls back to.

EnumStatus

• SUCCESS - Operation successful
• FAILURE - Operation failed

Error Response (400 Bad Request)

{
  "status": "FAILURE",
  "resultMessage": "Provider definition (name: internal-llm-gateway) was not found!"
}

or

{
  "status": "FAILURE",
  "resultMessage": "Provider definition name can not be empty!"
}

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/openai/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Notes and Warnings

• Name-based Lookup:
  • definitionName is matched case-insensitively against the definition name, across the caller's visible scope (built-in ∪ this project's custom entries)
  • A non-existent name — or a name that only exists in another project's custom scope — returns a 400 Bad Request with a "was not found" message
• No Secrets:
  • The entity carries no @SecretData fields; nothing is masked in this response

Related Documentation

• List LLM Provider Definitions - List all definitions visible to a project
• Update LLM Provider Definition - Update an existing custom definition
• Delete LLM Provider Definition - Delete a custom definition
• LLM Provider Definitions API - Resource overview, permissions and the LlmProviderDefinition vs. LLM Provider distinction