Skip to content
UltimateTeam.ai Docs

Get optimal cadence schedule

GET
/api/v1/ai/schedule/optimal
curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/ai/schedule/optimal?agent_role=example&cadence_type=example' \
  --header 'X-API-Key: <X-API-Key>'

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

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
agent_role
required
Agent Role
string
cadence_type
required
Cadence Type
string

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
OptimalScheduleResponse

Recommended optimal schedule for an agent cadence.

object
agent_role
required
Agent Role
string
cadence_type
required
Cadence Type
string
confidence
required
Confidence
number
<= 1
optimal_day
Any of:
integer
<= 6
optimal_hour
required
Optimal Hour
integer
<= 23
using_prediction
required
Using Prediction
boolean
Examplegenerated
{
  "agent_role": "example",
  "cadence_type": "example",
  "confidence": 1,
  "optimal_day": 1,
  "optimal_hour": 1,
  "using_prediction": true
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}