Embabel Agent Documentation/com.embabel.common.ai.model/CredentialEndpoint/OpenAiCompatible

OpenAiCompatible

data class OpenAiCompatible constructor(val provider: String, val baseUrl: String?, val pricingModel: <Error class: unknown class> = PricingModel.ALL_YOU_CAN_EAT, val knowledgeCutoffDate: LocalDate? = null) : CredentialEndpoint

The OpenAI wire protocol, which most providers now speak: OpenAI itself, DeepSeek, Mistral, Gemini and Atlas Cloud all reach the platform this way, as does the average self-hosted gateway.

Constructors

OpenAiCompatible

constructor(provider: String, baseUrl: String?, pricingModel: <Error class: unknown class> = PricingModel.ALL_YOU_CAN_EAT, knowledgeCutoffDate: LocalDate? = null)

Properties

baseUrl

open override val baseUrl: String?

Base URL to talk to, or null for the protocol's default host.

knowledgeCutoffDate

open override val knowledgeCutoffDate: LocalDate? = null

Null unless you know it for the model the role named. The name comes from configuration and may be one this framework version has never heard of, so a cutoff stated here would be a guess, and it reaches the LLM as a prompt contribution.

pricingModel

open override val pricingModel: <Error class: unknown class>

Defaults to PricingModel.ALL_YOU_CAN_EAT - zero - because a BYOK call is billed to the user's own key rather than to the deployment, so charging it to the deployment's cost accounting would be wrong in the one direction that matters. Set it only if you are reselling the call and do want it counted.

provider

open override val provider: String

Provider name the built service reports, which is what cost accounting and metadata lookups key on. Usually the same name the credential carries, but it need not be: a credential holds whatever spelling the application stored, and this is the framework's own.