v4

latestOpenAPI 3.1.02026-08-03553368548.9 KB

public

Create usecase

Create an outbound usecase in the authenticated workspace.

post/api/v1/public/usecases

Request body

namestring required

selectedKnowledgeBaseIdstring nullable

descriptionstring nullable

industrystring nullable

promptstring nullable

useCaseGoalsstring nullable

conclusionstring nullable

type'OUTBOUND' | 'INBOUND' | 'ONE_WAY'

agentIdstring nullable

escalationEnabledboolean

maxAttemptsinteger nullable

escalationWindowDaysinteger nullable

callsPerWeekinteger nullable

escalationUseCaseIdstring nullable

phoneNumberstring nullable

inboundNumberstring nullable

enableManagerTransferboolean

scheduleEnabledboolean

callbackTasksEnabledboolean

scheduledCallRetryDelayHoursinteger

scheduledCallMaxRetryAttemptsinteger

startTimestring

endTimestring

integrationsstring[]

taskTypesstring[]

concurrencyinteger

defaultTtsLanguagestring

defaultTtsVoicestring

defaultTtsPacenumber

defaultTtsPitchnumber

promptAiSessionIdstring nullable

tasksSchedulerConfigobject nullable

Response

Successful Response

UseCaseEnvelopeResponse required