Pular para o conteúdo
Healthing CRM

List Assistants

GET
/api/v1/ai/assistants

List available AI assistant templates (read-only).

Returns global templates from shared database. All tenants see the same templates.

  • page: Page number (default 1)
  • per_page: Items per page (default 20, max 100)
  • type: Filter by assistant type
  • is_active: Filter by active status (default True)
  • is_built_in: Filter built-in templates
  • search: Search in name/description

Authorizations

Seção intitulada “Authorizations ”

Parameters

Seção intitulada “ Parameters ”

Query Parameters

Seção intitulada “Query Parameters ”
page
Page
integer
default: 1
per_page
Per Page
integer
default: 20
type
Any of:
AssistantTypeEnum
string
Allowed values: pipeline_insights business_strategy custom lead_qualifier proposal_generator email_writer meeting_summarizer objection_handler churn_predictor
is_active
Any of:
boolean
is_built_in
Any of:
boolean
search
Any of:
string

Responses

Seção intitulada “ Responses ”

200

Seção intitulada “200 ”

Successful Response

AIAssistantTemplateListResponse

Paginated template list (for /api/v1/ai/assistants endpoint).

object
items
required
Items
Array<object>
AIAssistantTemplateResponse

Schema for built-in assistant template response (from shared DB).

object
id
required
Id
integer
code
required
Code
string
name
required
Name
string
description
required
Any of:
string
type
required
AssistantTypeEnum
string
Allowed values: pipeline_insights business_strategy custom lead_qualifier proposal_generator email_writer meeting_summarizer objection_handler churn_predictor
provider
required
LLMProviderEnum
string
Allowed values: openai anthropic custom
model
required
Model
string
temperature
required
Temperature
number
max_tokens
required
Any of:
integer
system_prompt
required
System Prompt
string
initial_message
required
Any of:
string
tools_enabled
required
Tools Enabled
Array<string>
response_format
required
Response Format
string
enable_streaming
required
Enable Streaming
boolean
enable_memory
required
Enable Memory
boolean
is_active
required
Is Active
boolean
is_built_in
required
Is Built In
boolean
version
required
Version
integer
cost_per_message
required
Cost Per Message
number
tags
required
Tags
Array<string>
icon
required
Any of:
string
color
required
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
total
required
Total
integer
page
required
Page
integer
per_page
required
Per Page
integer
total_pages
required
Total Pages
integer

422

Seção intitulada “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string