Skip to content

Get optimal cadence schedule

GET
/api/v1/ai/schedule/optimal

Get optimal schedule for a cadence type.

Returns default fixed schedule when no prediction data exists (cold start).

Args: agent_role: Which agent role owns this cadence. cadence_type: Type of cadence. user: Authenticated user context.

Returns: Optimal schedule recommendation.

Authorizations

Parameters

Query Parameters

agent_role
required
string
cadence_type
required
string

Responses

200

Successful Response

Recommended optimal schedule for an agent cadence.

object
agent_role
required
string
cadence_type
required
string
confidence
required
number
<= 1
optimal_day
Any of:
integer
<= 6
optimal_hour
required
integer
<= 23
using_prediction
required
boolean

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string