API Endpoints
Learn how to configure and manage API endpoint configurations in the Management Portal.
Overview
API Endpoints define the connection configurations for external services used by FoundationaLLM, including AI model providers, authentication services, and other backend systems.
Accessing API Endpoints
- In the Management Portal sidebar, click API Endpoints under the Models and Endpoints section
- The endpoints list loads, showing all configured endpoints
Endpoint List
The table displays:
| Column | Description |
|---|---|
| Name | Endpoint identifier |
| Category | Type of endpoint |
| Subcategory | More specific classification |
| Edit | Settings icon to modify configuration |
| Delete | Trash icon to remove the endpoint |
Searching and Managing
- Use the search box to filter by name or description
- Click the refresh button to reload the list
- Click column headers to sort
Endpoint Categories
| Category | Description |
|---|---|
| LLM | Large Language Model endpoints |
| Embedding | Embedding model endpoints |
| Authorization | Authentication and authorization services |
| Storage | Storage service endpoints |
| Search | Search service endpoints |
Creating an API Endpoint
- Click Create API Endpoint at the top right of the page
- Configure the endpoint settings
Endpoint Configuration
TODO: Document specific API endpoint configuration fields when available in the UI, including:
| Field | Description |
|---|---|
| Endpoint Name | Unique identifier |
| Category | Endpoint type |
| Subcategory | Specific classification |
| URL | Service endpoint URL |
| Authentication | Auth configuration |
Azure OpenAI Endpoints
For Azure OpenAI services:
| Field | Description |
|---|---|
| Endpoint URL | https://<resource>.openai.azure.com/ |
| API Version | API version (e.g., 2024-02-01) |
| Authentication | API Key or Managed Identity |
Other Service Endpoints
For other services, configure:
- Service URL
- Authentication method
- Required headers or parameters
Authentication Configuration
API Key Authentication
- Select API Key authentication
- Enter the key value (stored securely)
- Configure header name if non-standard
Managed Identity
- Select Managed Identity authentication
- Ensure the identity has required permissions
- No credentials required in configuration
OAuth/Token Authentication
- Configure token endpoint
- Set client credentials
- Configure scopes as needed
Editing Endpoints
- Locate the endpoint in the list
- Click the Settings icon (⚙️)
- Modify settings as needed
- Click Save Changes
Deleting Endpoints
- Click the Trash icon (🗑️) for the endpoint
- Confirm deletion in the dialog
Warning: Deleting an endpoint affects any models or services referencing it. Verify dependencies before deleting.
Endpoint References
API Endpoints are referenced by:
- AI Models: Models use endpoints for API connectivity
- Data Sources: Some sources reference endpoints for authentication
- Internal Services: Platform services use configured endpoints
Access Control
Configure who can access and manage endpoints:
| Permission | Description |
|---|---|
FoundationaLLM.Configuration/apiEndpointConfigurations/read |
View endpoints |
FoundationaLLM.Configuration/apiEndpointConfigurations/write |
Edit endpoints |
FoundationaLLM.Configuration/apiEndpointConfigurations/delete |
Delete endpoints |
Best Practices
Naming Conventions
- Use descriptive names indicating service and purpose
- Include environment when relevant (dev, prod)
- Example:
azure-openai-eastus-prod,search-service-main
Security
- Use Managed Identity when possible
- Rotate API keys regularly
- Avoid hardcoding credentials
Organization
- Group related endpoints logically
- Document endpoint purposes
- Maintain consistent naming
Troubleshooting
Connection Failures
- Verify endpoint URL is correct
- Check authentication credentials
- Review network/firewall configuration
Authentication Errors
- Verify API key or credentials
- Check managed identity permissions
- Review token expiration
Endpoint Not Available
- Verify the endpoint exists
- Check your permissions
- Ensure the service is running