RArapidata
RankingFlowItem

Creates a new flow item for the specified flow.

Changed on
post/flow/ranking/{flowId}/item

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/flow/ranking/{flowId}/item
  • Auth
    OpenID Connect (https://auth.rapidata.ai/.well-known/openid-configuration, scopes: openid, profile, email, offline_access, api)

Path parameters

flowIdstring required

The ID of the flow to create the item in.

Request body

datasetIdstring required

The ID of the dataset to use for this flow item.

contextstring nullable

Optional context to provide additional ranking guidance.

timeToLiveInSecondsinteger nullable

Optional time-to-live in seconds before the flow item expires. Must be between 20 seconds and 1 hour, and must exceed the drain duration by at least 20 seconds; defaults to 4 minutes when omitted.

drainDurationInSecondsinteger nullable

Optional drain duration in seconds. When set, rapids are paused this many seconds before TTL expiry to allow in-flight responses to complete.

Response

OK

flowItemIdstring required

The ID of the created flow item.

Changes