Skip to content

Get AI feature status

GET
/api/ai/status
curl --request GET \
--url https://gateway.example.com/api/ai/status \
--header 'Authorization: Bearer <token>'

Successful response

Media typeapplication/json
object
enabled
required
boolean
providerType
required
string
Allowed values: openai_compatible gateway_inference
defaultModel
required
string
allowUserModelSelection
required
boolean
allowUserReasoningEffortSelection
required
boolean
reasoningEfforts
required
Array<string>
defaultReasoningEffort
required
string | null
supportsImages
required
boolean
models
required
Array<object>
object
id
required
string
displayName
required
string
supportsImages
required
boolean
maxContextTokens
required
number
maxOutputTokens
required
number | null
reasoningEfforts
required
Array<string>
defaultReasoningEffort
required
string | null
Example
{
"enabled": true
}

Bad request

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"details": [
{
"path": [
"name"
],
"message": "Required"
}
]
}

Authentication required

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "UNAUTHORIZED",
"message": "Authentication required"
}

Forbidden

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "FORBIDDEN",
"message": "Insufficient permissions"
}

Not found

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "NOT_FOUND",
"message": "Resource not found"
}

Conflict

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "CONFLICT",
"message": "Resource already exists"
}

Unprocessable entity

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "UNPROCESSABLE_ENTITY",
"message": "Request could not be processed"
}

Internal server error

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
"code": "INTERNAL_ERROR",
"message": "Internal server error"
}