Skip to content
OpenCode
Esc
navigateopen⌘Jpreview

Get provider

Retrieve a single AI provider so clients can inspect its availability and endpoint settings.

GET/api/provider/{providerID}
Path parameters
providerIDstringrequired
Query parameters
locationobject | any
Responses
200Success
locationLocation.Inforequired
Show properties
directorystringrequired
workspaceIDobject
Show properties
object
projectobjectrequired
Show properties
idstringrequired
directorystringrequired
dataProviderV2.Inforequired
Show properties
idstringrequired
integrationIDstring
namestringrequired
disabledboolean
packagestringrequired
settingsobject
headersobject
bodyobject
400InvalidRequestError
_tagstringrequired
Allowed:InvalidRequestError
messagestringrequired
kindstring | any
Show properties
Any of:
string
string
any
any
fieldstring | any
Show properties
Any of:
string
string
any
any
401UnauthorizedError
_tagstringrequired
Allowed:UnauthorizedError
messagestringrequired
404ProviderNotFoundError
_tagstringrequired
Allowed:ProviderNotFoundError
providerIDstringrequired
messagestringrequired
503ServiceUnavailableError
_tagstringrequired
Allowed:ServiceUnavailableError
messagestringrequired
servicestring | any
Show properties
Any of:
string
string
any
any
Request
curl -X 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": {}
  }
}