routing

Recommend the best route for a capability

post/domains/{domainKey}/capabilities/{capabilityId}/recommend

Path parameters

domainKeystring required

Domain identifier such as email, search, text, web, enrichment, or social.

capabilityIdstring required

Capability identifier inside the selected domain, such as send, answer, analyze, people-search, or extract.

Headers

Authorizationstring required

Bearer authentication

Request body

CapabilityInput required

Capability-specific request body. Use the contract endpoint for exact fields.

Response

Route recommendation

successtrue required
productKeystring
preferenceSourcestring
optimizationPreferencesstring[]
recommendedProviderstring required
recommendedRouteKeystring required
recommendedRouteMode'managed' | 'byo' | 'redirect' required
canExecuteNowboolean required
bestExecutableProviderstring
bestExecutableRouteKeystring
bestExecutableRouteModestring
blockingRequirementsstring[] required
nextActionsstring[] required

Changes

No recorded changes to this endpoint across all 1 revision of this API.