API ReferencePlatform API

Api Pulses Behaviors Custom Retrieve

GET/PATCH/DELETE /api/pulses/behaviors/custom/{id}/ — retrieve/update/delete.

PATCH edits polarity/description metadata and/or persisted draft examples. name is immutable (delete + recreate). PUT → 405.

Authentication

AuthorizationBearer
JWT access token or Respan API key

Path parameters

idstringRequired

Response

idstringRead-only
namestring<=128 characters
exampleslist of objectsRead-only
statusenum
  • draft - Draft
  • training - Training
  • ready - Ready
  • failed - Failed
created_atdatetimeRead-only
updated_atdatetimeRead-only
tagslist of objectsRead-only
augmented_countintegerRead-only
feedback_countintegerRead-only
augmentationmap from strings to any or nullRead-only
descriptionstring
polarityenum
  • positive - Positive
  • negative - Negative
  • neutral - Neutral