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.

  • CLICKClick interaction
  • SCROLLScroll interaction
  • TYPEType interaction
  • NONENo specific interaction
ProfileTimeToLiveenum

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

  • ONE_DAYProfile expires after one day
  • ONE_WEEKProfile expires after one week
  • ONE_MONTHProfile expires after one month
  • ONE_QUARTERProfile expires after one quarter
  • ONE_YEARProfile expires after one year
  • INFINITYProfile never expires
Statusenum

Represents the processing status for profiles and playbooks.

  • CURRENT (None)Active profile/playbook currently in use
  • ARCHIVEDProfile/playbook has been archived (old versions)
  • PENDINGNew profile/playbook that is pending approval or processing (from rerun operations)
  • ARCHIVE_IN_PROGRESSTemporary status during downgrade operation
PlaybookStatusenum

Represents the approval status of a playbook.

  • PENDINGPlaybook is pending review
  • APPROVEDPlaybook has been approved
  • REJECTEDPlaybook has been rejected
SearchModeenum

Controls how search queries are processed.

  • VECTORPure vector similarity search using embeddings
  • FTSPure full-text search using PostgreSQL tsvector
  • HYBRIDCombined search using Reciprocal Rank Fusion (RRF)
OperationStatusenum

Represents the status of long-running operations.

  • IN_PROGRESSOperation is currently running
  • COMPLETEDOperation has completed successfully
  • FAILEDOperation has failed
  • CANCELLEDOperation was cancelled by the user
RegularVsShadowenum

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

  • REGULAR_IS_BETTERRegular version performed significantly better
  • REGULAR_IS_SLIGHTLY_BETTERRegular version performed slightly better
  • SHADOW_IS_BETTERShadow version performed significantly better
  • SHADOW_IS_SLIGHTLY_BETTERShadow version performed slightly better
  • TIEDBoth versions performed equally