PUT /api/v1/ai/provider
Authentication
Use an agent API key and secret.
Request body
AI provider configuration
Required: Yes.
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| provider | string | Yes | AI provider name |
| api_key | string | Yes | API key for provider |
Responses
200
AI provider updated successfully
Content type: application/json.
| Field | Type | Required | Description |
|---|---|---|---|
| status | string | No | example: "success" |
| data | boolean | No | example: true |
401
Unauthorized
500
Internal server error
Specification
Download the complete OpenAPI specification.
OpenAPI definition for this endpoint
openapi: 3.0.0
info:
title: Libredesk API
description: >-
REST API documentation for Libredesk helpdesk system.
## Authentication
The Libredesk API supports two authentication methods:
### 1. Basic Authentication
Use your API key and secret with Basic authentication:
```
Authorization: Basic <base64_encoded_api_key:api_secret>
```
### 2. Token Authentication
Use your API key and secret with token authentication:
```
Authorization: token api_key:api_secret
```
To obtain API credentials, generate them from your agent profile in the
Libredesk dashboard.
version: 1.0.0
servers:
- url: http://localhost:8080
description: Local development server
security:
- basicAuth: []
- tokenAuth: []
paths:
/api/v1/ai/provider:
put:
tags:
- AI completions
summary: Update A I Provider
operationId: handleUpdateAIProvider
requestBody:
description: AI provider configuration
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AIProviderRequest'
responses:
'200':
description: AI provider updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
'401':
description: Unauthorized
'500':
description: Internal server error
security:
- basicAuth: []
- tokenAuth: []
components:
schemas:
AIProviderRequest:
type: object
required:
- provider
- api_key
properties:
provider:
type: string
description: AI provider name
api_key:
type: string
description: API key for provider
SuccessResponse:
type: object
properties:
status:
type: string
example: success
data:
type: boolean
example: true
securitySchemes:
basicAuth:
type: http
scheme: basic
description: >-
Basic authentication using base64 encoded API key and secret. Format:
`Authorization: Basic <base64(api_key:api_secret)>`
tokenAuth:
type: apiKey
name: Authorization
in: header
description: >-
Token authentication using API key and secret. Format: `Authorization:
token api_key:api_secret`
