Schemas
Enums
Enumeration types used in the Emend API.
SessionOutcomeKindenumTerminal outcome supplied by an external system for a session.
SUCCESS ("success")— The session achieved the caller's goalFAILURE ("failure")— The session did not achieve the caller's goalUNKNOWN ("unknown")— The domain cannot determine a terminal result
SessionOutcomeFailureReasonenumMachine-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 trajectoryUNKNOWN_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")
UserActionTypeenumRepresents different types of user actions that can be tracked.
CLICK— Click interactionSCROLL— Scroll interactionTYPE— Type interactionNONE— No specific interaction
ProfileTimeToLiveenumDefines the time-to-live options for user profiles.
ONE_DAY— Profile expires after one dayONE_WEEK— Profile expires after one weekONE_MONTH— Profile expires after one monthONE_QUARTER— Profile expires after one quarterONE_YEAR— Profile expires after one yearINFINITY— Profile never expires
StatusenumRepresents the processing status for profiles and playbooks.
CURRENT (None)— Active profile/playbook currently in useARCHIVED— 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
PlaybookStatusenumRepresents the approval status of a playbook.
PENDING— Playbook is pending reviewAPPROVED— Playbook has been approvedREJECTED— Playbook has been rejected
SearchModeenumControls how search queries are processed.
VECTOR— Pure vector similarity search using embeddingsFTS— Pure full-text search using PostgreSQL tsvectorHYBRID— Combined search using Reciprocal Rank Fusion (RRF)
OperationStatusenumRepresents the status of long-running operations.
IN_PROGRESS— Operation is currently runningCOMPLETED— Operation has completed successfullyFAILED— Operation has failedCANCELLED— Operation was cancelled by the user
RegularVsShadowenumIndicates the relative performance between regular and shadow agent versions during evaluation.
REGULAR_IS_BETTER— Regular version performed significantly betterREGULAR_IS_SLIGHTLY_BETTER— Regular version performed slightly betterSHADOW_IS_BETTER— Shadow version performed significantly betterSHADOW_IS_SLIGHTLY_BETTER— Shadow version performed slightly betterTIED— Both versions performed equally