Emend
Schemas

Enums

Enumeration types used in the Emend API.

SessionOutcomeKindenum

Terminal outcome supplied by an external system for a session.

  • SUCCESS ("success") — The session achieved the caller's goal
  • FAILURE ("failure") — The session did not achieve the caller's goal
  • UNKNOWN ("unknown") — The domain cannot determine a terminal result
SessionOutcomeFailureReasonenum

Machine-readable reasons why a valid outcome request was not recorded.

  • CONFLICTING_FINALIZATION ("conflicting_finalization") — The session already has an immutable outcome and the retry changed its payload, outcome contract, or finalized trajectory
  • UNKNOWN_SESSION ("unknown_session")
  • OCCURRED_BEFORE_SESSION ("occurred_before_session")
  • OCCURRED_IN_FUTURE ("occurred_in_future")
  • AFTER_OUTCOME_WINDOW ("after_outcome_window")
  • SUBJECT_NOT_WRITABLE ("subject_not_writable")
  • STORAGE_ERROR ("storage_error")
UserActionTypeenum

Represents different types of user actions that can be tracked.

  • CLICK — Click interaction
  • SCROLL — Scroll interaction
  • TYPE — Type interaction
  • NONE — No specific interaction
ProfileTimeToLiveenum

Defines the time-to-live options for user profiles.

  • ONE_DAY — Profile expires after one day
  • ONE_WEEK — Profile expires after one week
  • ONE_MONTH — Profile expires after one month
  • ONE_QUARTER — Profile expires after one quarter
  • ONE_YEAR — Profile expires after one year
  • INFINITY — Profile never expires
Statusenum

Represents the processing status for profiles and playbooks.

  • CURRENT (None) — Active profile/playbook currently in use
  • ARCHIVED — Profile/playbook has been archived (old versions)
  • PENDING — New profile/playbook that is pending approval or processing (from rerun operations)
  • ARCHIVE_IN_PROGRESS — Temporary status during downgrade operation
PlaybookStatusenum

Represents the approval status of a playbook.

  • PENDING — Playbook is pending review
  • APPROVED — Playbook has been approved
  • REJECTED — Playbook has been rejected
SearchModeenum

Controls how search queries are processed.

  • VECTOR — Pure vector similarity search using embeddings
  • FTS — Pure full-text search using PostgreSQL tsvector
  • HYBRID — Combined search using Reciprocal Rank Fusion (RRF)
OperationStatusenum

Represents the status of long-running operations.

  • IN_PROGRESS — Operation is currently running
  • COMPLETED — Operation has completed successfully
  • FAILED — Operation has failed
  • CANCELLED — Operation was cancelled by the user
RegularVsShadowenum

Indicates the relative performance between regular and shadow agent versions during evaluation.

  • REGULAR_IS_BETTER — Regular version performed significantly better
  • REGULAR_IS_SLIGHTLY_BETTER — Regular version performed slightly better
  • SHADOW_IS_BETTER — Shadow version performed significantly better
  • SHADOW_IS_SLIGHTLY_BETTER — Shadow version performed slightly better
  • TIED — Both versions performed equally