Get provider
Retrieve a single AI provider so clients can inspect its availability and endpoint settings.
GET
/api/provider/{providerID}Path parameters
providerIDstringrequiredQuery parameters
locationobject | anyResponses
200Success
locationLocation.InforequiredShow propertiesHide properties
directorystringrequiredworkspaceIDobjectShow propertiesHide properties
objectprojectobjectrequiredShow propertiesHide properties
idstringrequireddirectorystringrequireddataProviderV2.InforequiredShow propertiesHide properties
idstringrequiredintegrationIDstringnamestringrequireddisabledbooleanpackagestringrequiredsettingsobjectheadersobjectbodyobject400InvalidRequestError
_tagstringrequiredAllowed:
InvalidRequestErrormessagestringrequiredkindstring | anyShow propertiesHide properties
Any of:
string
stringany
anyfieldstring | anyShow propertiesHide properties
Any of:
string
stringany
any401UnauthorizedError
_tagstringrequiredAllowed:
UnauthorizedErrormessagestringrequired404ProviderNotFoundError
_tagstringrequiredAllowed:
ProviderNotFoundErrorproviderIDstringrequiredmessagestringrequired503ServiceUnavailableError
_tagstringrequiredAllowed:
ServiceUnavailableErrormessagestringrequiredservicestring | anyShow propertiesHide properties
Any of:
string
stringany
anyRequest
curl -X GET "/api/provider/string"const response = await fetch("/api/provider/string", {
method: "GET"
});import requests
response = requests.get(
"/api/provider/string",
)Response
{
"location": {
"directory": "string",
"workspaceID": {},
"project": {
"id": "string",
"directory": "string"
}
},
"data": {
"id": "string",
"integrationID": "string",
"name": "string",
"disabled": true,
"package": "string",
"settings": {},
"headers": {},
"body": {}
}
}{
"_tag": "InvalidRequestError",
"message": "string",
"kind": "string",
"field": "string"
}{
"_tag": "UnauthorizedError",
"message": "string"
}{
"_tag": "ProviderNotFoundError",
"providerID": "string",
"message": "string"
}{
"_tag": "ServiceUnavailableError",
"message": "string",
"service": "string"
}