Skip to main content
Version: v5.2

Providers

Use the Providers API to list the supported LLM provider keys configured for AI Service.

List providers​

Endpoint​

GET /aisvc/api/v1/providers

Request​

Query parameters​

ParameterTypeRequiredDescription
detailedBooleanNoWhen true, return detailed provider objects that also include each provider's credentials-vault secret name. Omit (or false) to return the default response — a plain list of provider names.
Request examples​
GET /aisvc/api/v1/providers
GET /aisvc/api/v1/providers?detailed=true

Response​

Codes​

CodeDescription
200Success
401Unauthorized
500Server Error

Response body example​

Default (detailed omitted or false) — a list of provider identifiers:

[
"openai",
"anthropic"
]

With detailed=true — provider objects including the secret name:

{
"_providers": [
{ "_name": "openai", "_secretName": "OPENAI_API_KEY" },
{ "_name": "anthropic", "_secretName": "ANTHROPIC_API_KEY" }
]
}
FieldDescription
_nameProvider identifier (the value used in an agent's provider field).
_secretNameThe credentials-vault secret name that must hold this provider's API key (for example, OPENAI_API_KEY, ANTHROPIC_API_KEY).