Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.zyeta.io/llms.txt

Use this file to discover all available pages before exploring further.

The LLM Service provides endpoints for managing language model configurations, including adding, listing, and configuring models for use in conversations and other AI-powered features.

Authentication

All endpoints require a valid Bearer token in the Authorization header.

Base URL

/api/llm

Endpoints

Add Model

Add a new language model configuration.
curl -X POST {{baseUrl}}/api/llm/add \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "GPT-4o",
    "provider": "openai",
    "version": "4o",
    "is_active": true,
    "config": {}
  }'
Endpoint: POST /api/llm/add Request Body:
FieldTypeRequiredDescription
namestringYesDisplay name for the model
providerstringYesModel provider (e.g., β€œopenai”, β€œanthropic”)
versionstringYesModel version identifier
is_activebooleanNoWhether the model is active and available for use (default: true)
configobjectNoModel-specific configuration settings
Response:
FieldTypeDescription
idstring (UUID)Model ID
namestringModel display name
providerstringModel provider
versionstringModel version
is_activebooleanActive status
configobjectConfiguration settings
created_atstring (datetime)Creation timestamp
updated_atstring (datetime)Last update timestamp

List Models

Retrieve all language models configured for an organization.
curl -X GET {{baseUrl}}/api/llm/list?org_id=your-org-id \
  -H "Authorization: Bearer YOUR_TOKEN"
Endpoint: GET /api/llm/list Query Parameters:
ParameterRequiredDescription
org_idYesOrganization ID

Error Responses

Status CodeDescription
400Bad Request - Invalid input or validation error
401Unauthorized - Invalid or missing token
403Forbidden - Insufficient permissions
404Not Found - Resource doesn’t exist
500Internal Server Error - Server-side error

Implementation Notes

  • The LLM Service supports multiple providers, including OpenAI and Anthropic
  • Models can be enabled or disabled using the is_active flag
  • Custom configurations can be provided for each model
  • Model configurations are organization-specific
  • The service handles the underlying API integrations with model providers