GET
/
assistant
cURL
curl --request GET \
  --url https://api.clarionhealth.com/v1/assistant \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "name": "<string>",
    "organization_id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "model": {},
    "voice": {},
    "first_message": "<string>",
    "max_duration_seconds": 123,
    "voicemail_message": "<string>",
    "webhook_url": "<string>",
    "is_webhook_secret_set": true,
    "analysis_plan": {}
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer

The maximum number of results to return. Defaults to 100, maximum is 1000.

​
created_at_ge
string<date-time>

Filter assistants created on or after this date (ISO 8601 format)

​
created_at_le
string<date-time>

Filter assistants created on or before this date (ISO 8601 format)

Response

List of Assistants

​
id
integer
required

The unique identifier for the assistant

​
name
string
required

The name of the assistant

​
organization_id
integer
required

The identifier of the organization the assistant belongs to

​
created_at
string<date-time>
required

The timestamp when the assistant was created

​
updated_at
string<date-time>
required

The timestamp when the assistant was last updated

​
model
object

The language model configuration for the assistant

​
voice
object

The voice model configuration for the assistant

​
first_message
string

The initial message the assistant will use

​
max_duration_seconds
integer

The maximum duration in seconds for the assistant's interaction

​
voicemail_message
string

The message the assistant will leave as a voicemail

​
webhook_url
string

The URL the assistant will send the end of call report to

​
is_webhook_secret_set
boolean

Whether a secret is set for the webhook

​
analysis_plan
object

The analysis plan for the assistant