Pular para o conteúdo
Healthing CRM

List Agent Instances

GET
/api/v1/ai/agents/instances

List agent instances for current tenant

Authorizations

Seção intitulada “Authorizations ”

Parameters

Seção intitulada “ Parameters ”

Query Parameters

Seção intitulada “Query Parameters ”
page
Page
integer
default: 1 >= 1
per_page
Per Page
integer
default: 20 >= 1 <= 100
template_id
Any of:
integer
status
Any of:
string
is_active
Any of:
boolean
search
Any of:
string

Header Parameters

Seção intitulada “Header Parameters ”
x-tenant-id
Any of:
integer

Responses

Seção intitulada “ Responses ”

200

Seção intitulada “200 ”

Successful Response

AgentListResponse

Resposta paginada de agentes

object
items
required
Items
Array<object>
AgentInstanceResponse

Schema de resposta para AgentInstance

object
name
required
Name
string
>= 1 characters <= 255 characters
description
Any of:
string
custom_config
Any of:
object
execution_schedule
Any of:
string
<= 100 characters
auto_execute
Auto Execute
boolean
context_filter
Any of:
object
tags
Tags
Array<string>
extra_metadata
Extra Metadata
object
id
required
Id
integer
template_id
Any of:
integer
template_type
Any of:
string
status
required
AgentStatusEnum

Status de um agente

string
Allowed values: active paused disabled
is_active
required
Is Active
boolean
created_by
required
Created By
integer
assigned_to
required
Any of:
integer
total_executions
required
Total Executions
integer
successful_executions
required
Successful Executions
integer
failed_executions
required
Failed Executions
integer
last_execution_at
required
Any of:
string format: date-time
total_cost
required
Total Cost
object
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
pages
required
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