KEkeywordsai
Behaviors

Get a custom behavior

Changed on

Returns one custom behavior with its tags.

get/api/pulses/behaviors/custom/{id}/

Request

  • Base URL
    https://api.respan.ai
  • URL
    https://api.respan.ai/api/pulses/behaviors/custom/{id}/
  • Auth
    HTTP bearer

Path parameters

idstring required

Custom behavior ID.

Response

The behavior.

idstring required

Custom behavior ID. It is also the behavior's key in analytics, filters and span verdicts.

namestring nullable required

Display name. Optional and not unique; behaviors are identified by id.

descriptionstring required

The plain-language definition span-01 scores each span against. Say what counts and what doesn't. At least 3 characters after trimming.

polarity'negative' | 'positive' | 'neutral' required

Whether the behavior firing is good or bad: negative (an Issue), positive (a Win) or neutral (Info). Display metadata only; it does not change how spans are scored.

created_atstring date-time required
updated_atstring date-time required
has_write_accessboolean required

Whether the caller can edit the behavior. Always true for an API key of the behavior's organization.

Example response

{
  "id": "6f1c2a9e-3b7d-4c55-9a0e-2d8f4b1c7e93",
  "name": "Refund promise",
  "description": "The assistant promises a refund, credit, or compensation that the policy in the system prompt does not allow.",
  "polarity": "negative",
  "created_at": "2026-09-28T17:41:09.512340Z",
  "updated_at": "2026-09-28T17:41:09.512340Z",
  "tags": [
    {
      "id": "0b7e5f0c-2a61-4d3e-9a47-5c8f1e2d3b4a",
      "name": "Support",
      "color": "#2563EB",
      "created_at": "2026-09-12T09:30:00Z",
      "updated_at": "2026-09-12T09:30:00Z"
    }
  ],
  "has_write_access": true
}

Changes

  • c30bcb383ee8Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      api operation id behaviors_retrieveCustomBehavior removed and replaced with retrieveCustomBehavior

    • info

      api tag Behaviors added

    • info

      api tag behaviors removed

    • info

      added subschema #2 to the response body allOf list for the response status

  • b830b79cfd52Revision changes
    • info

      endpoint added