Updated August 12, 2026

On this page

Strict pydantic (extra='forbid') parameter models for every capability-eligible service function, covering only user-facing arguments -- injected infrastructure like pool or backend is excluded.

#services.src.orxtra.services._params

#`services.src.orxtra.services._params`

Pydantic parameter models for capability-eligible service functions.

Each model captures the user-facing parameters of a service function, omitting infrastructure dependencies (pool, backend, bus) that are injected by the dispatcher.

#`StartRunParams`

StartRunParams
Field	Type	Default
`config_path`	`str`	`Field(description='Path to run config file.')`
`intent`	`str`	`Field(description='Intent description for the run.')`

#`ListRunsParams`

python

class ListRunsParams(BaseModel):

#`GetRunParams`

GetRunParams
Field	Type	Default
`run_id`	`str`	`Field(description='Run ID.', json_schema_extra={'format': 'uuid'})`

#`AbortRunParams`

AbortRunParams
Field	Type	Default
`run_id`	`str`	`Field(description='Run ID.', json_schema_extra={'format': 'uuid'})`

#`PauseRunParams`

PauseRunParams
Field	Type	Default
`run_id`	`str`	`Field(description='Run ID.', json_schema_extra={'format': 'uuid'})`

#`ResumeRunParams`

ResumeRunParams
Field	Type	Default
`run_id`	`str`	`Field(description='Run ID.', json_schema_extra={'format': 'uuid'})`

#`ListInboxParams`

ListInboxParams
Field	Type	Default
`run_id`	`str`	`Field(description='Run ID.', json_schema_extra={'format': 'uuid'})`
`status`	`str	None`	`Field(default=None, description='Status filter.')`

#`GetInboxItemParams`

GetInboxItemParams
Field	Type	Default
`item_id`	`str`	`Field(description='Inbox item ID.', json_schema_extra={'format': 'uuid'})`

#`RespondToInboxParams`

RespondToInboxParams
Field	Type	Default
`item_id`	`str`	`Field(description='Inbox item ID.', json_schema_extra={'format': 'uuid'})`
`answer`	`str`	`Field(description='The answer text.')`

#`SkipInboxItemParams`

SkipInboxItemParams
Field	Type	Default
`item_id`	`str`	`Field(description='Inbox item ID.', json_schema_extra={'format': 'uuid'})`

#`RejectInboxItemParams`

RejectInboxItemParams
Field	Type	Default
`item_id`	`str`	`Field(description='Inbox item ID.', json_schema_extra={'format': 'uuid'})`
`reason`	`str`	`Field(description='Reason for rejection.')`

#`ListTasksParams`

ListTasksParams
Field	Type	Default
`run_id`	`str`	`Field(description='Run ID.', json_schema_extra={'format': 'uuid'})`

#`GetTaskAttemptsParams`

GetTaskAttemptsParams
Field	Type	Default
`task_id`	`str`	`Field(description='Task ID.', json_schema_extra={'format': 'uuid'})`

#`GetTranscriptParams`

GetTranscriptParams
Field	Type	Default
`session_id`	`str`	`Field(description='Session ID.', json_schema_extra={'format': 'uuid'})`

#`SearchTranscriptParams`

SearchTranscriptParams
Field	Type	Default
`session_id`	`str`	`Field(description='Session ID.', json_schema_extra={'format': 'uuid'})`
`query`	`str`	`Field(description='Search query.')`

#`QueryEventsParams`

QueryEventsParams
Field	Type	Default
`run_id`	`str`	`Field(description='Run ID.', json_schema_extra={'format': 'uuid'})`
`event_type`	`str	None`	`Field(default=None, description='Filter by event type.')`
`since`	`str	None`	`Field(default=None, description='Only events after this timestamp.', json_schema_extra={'format': 'date-time'})`
`limit`	`int`	`Field(default=100, description='Maximum events to return.')`

#`GetNotepadParams`

GetNotepadParams
Field	Type	Default
`run_id`	`str`	`Field(description='Run ID.', json_schema_extra={'format': 'uuid'})`

#`FireEventParams`

FireEventParams
Field	Type	Default
`run_id`	`str`	`Field(description='Run ID.', json_schema_extra={'format': 'uuid'})`
`event_name`	`str`	`Field(description='Event name.')`
`payload`	`dict[str, Any]	None`	`Field(default=None, description='Event payload.')`

#`ShowConfigParams`

ShowConfigParams
Field	Type	Default
`run_id`	`str`	`Field(description='Run ID.', json_schema_extra={'format': 'uuid'})`

#`ShowPricingParams`

python

class ShowPricingParams(BaseModel):

#`ValidateAgentParams`

ValidateAgentParams
Field	Type	Default
`path`	`str`	`Field(description='Path to agent TOML file.')`

#`ValidateWorkflowParams`

ValidateWorkflowParams
Field	Type	Default
`path`	`str`	`Field(description='Path to workflow TOML file.')`

#`ValidateCategoriesParams`

ValidateCategoriesParams
Field	Type	Default
`path`	`str`	`Field(description='Path to categories TOML file.')`

#`SubscribeParams`

SubscribeParams
Field	Type	Default
`filter`	`dict[str, Any]`	`Field(description='Filter predicate for matching events.')`
`actions`	`list[dict[str, Any]]`	`Field(description='List of action configurations.')`
`storage`	`str`	`Field(default='persistent', description='Storage type for the subscription.')`

#`UnsubscribeParams`

UnsubscribeParams
Field	Type	Default
`subscription_id`	`str`	`Field(description='Subscription ID.', json_schema_extra={'format': 'uuid'})`

#`ListSubscriptionsParams`

ListSubscriptionsParams
Field	Type	Default
`enabled_only`	`bool`	`Field(default=True, description='Only show enabled subscriptions.')`
`principal_id`	`str	None`	`Field(default=None, description='Only show subscriptions owned by this principal.', json_schema_extra={'format': 'uuid'})`

#`CreateSourceParams`

CreateSourceParams
Field	Type	Default
`slug`	`str`	`Field(description='URL-friendly source identifier.')`
`name`	`str`	`Field(description='Human-readable source name.')`
`credential_id`	`str	None`	`Field(default=None, description='Credential ID for source authentication.', json_schema_extra={'format': 'uuid'})`
`config`	`dict[str, Any]	None`	`Field(default=None, description='Per-source mapping config (event_type extraction, etc.).')`

#`GetSourceParams`

GetSourceParams
Field	Type	Default
`source_id`	`str`	`Field(description='Source ID.', json_schema_extra={'format': 'uuid'})`

#`GetSourceBySlugParams`

GetSourceBySlugParams
Field	Type	Default
`slug`	`str`	`Field(description='URL-friendly source identifier.')`

#`ListSourcesParams`

python

class ListSourcesParams(BaseModel):

#`DeleteSourceParams`

DeleteSourceParams
Field	Type	Default
`source_id`	`str`	`Field(description='Source ID.', json_schema_extra={'format': 'uuid'})`

#`CreatePrincipalParams`

CreatePrincipalParams
Field	Type	Default
`kind`	`str`	`Field(description='Principal kind (validated against the registry).')`
`external_ref`	`str`	`Field(description='External reference the principal points at.', json_schema_extra={'format': 'uuid'})`
`display_name`	`str	None`	`Field(default=None, description='Optional human-readable display name.')`
`notification_event_types`	`list[str]	None`	`Field(default=None, description='Event types for self-subscription. Required for consumer and app-registered kinds; must be None for run/source/system.')`

#`GetPrincipalParams`

GetPrincipalParams
Field	Type	Default
`principal_id`	`str`	`Field(description='Principal ID.', json_schema_extra={'format': 'uuid'})`

#`ListPrincipalsParams`

ListPrincipalsParams
Field	Type	Default
`kind`	`str	None`	`Field(default=None, description='Filter by principal kind.')`

#`DeletePrincipalParams`

DeletePrincipalParams
Field	Type	Default
`principal_id`	`str`	`Field(description='Principal ID.', json_schema_extra={'format': 'uuid'})`

#`ListDeliveriesParams`

ListDeliveriesParams
Field	Type	Default
`unacknowledged_only`	`bool`	`Field(default=True, description='Only show unacknowledged deliveries.')`
`cursor`	`str	None`	`Field(default=None, description='Cursor for pagination (delivery ID).', json_schema_extra={'format': 'uuid'})`
`limit`	`int`	`Field(default=50, description='Maximum deliveries to return.')`

#`AcknowledgeDeliveryParams`

AcknowledgeDeliveryParams
Field	Type	Default
`delivery_id`	`str`	`Field(description='Delivery ID.', json_schema_extra={'format': 'uuid'})`

#services.src.orxtra.services._params

#services.src.orxtra.services._params

#StartRunParams

#ListRunsParams

#GetRunParams

#AbortRunParams

#PauseRunParams

#ResumeRunParams

#ListInboxParams

#GetInboxItemParams

#RespondToInboxParams

#SkipInboxItemParams

#RejectInboxItemParams

#ListTasksParams

#GetTaskAttemptsParams

#GetTranscriptParams

#SearchTranscriptParams

#QueryEventsParams

#GetNotepadParams

#FireEventParams

#ShowConfigParams

#ShowPricingParams

#ValidateAgentParams

#ValidateWorkflowParams

#ValidateCategoriesParams

#SubscribeParams

#UnsubscribeParams

#ListSubscriptionsParams

#CreateSourceParams

#GetSourceParams

#GetSourceBySlugParams

#ListSourcesParams

#DeleteSourceParams

#CreatePrincipalParams

#GetPrincipalParams

#ListPrincipalsParams

#DeletePrincipalParams

#ListDeliveriesParams

#AcknowledgeDeliveryParams

#`services.src.orxtra.services._params`

#`StartRunParams`

#`ListRunsParams`

#`GetRunParams`

#`AbortRunParams`

#`PauseRunParams`

#`ResumeRunParams`

#`ListInboxParams`

#`GetInboxItemParams`

#`RespondToInboxParams`

#`SkipInboxItemParams`

#`RejectInboxItemParams`

#`ListTasksParams`

#`GetTaskAttemptsParams`

#`GetTranscriptParams`

#`SearchTranscriptParams`

#`QueryEventsParams`

#`GetNotepadParams`

#`FireEventParams`

#`ShowConfigParams`

#`ShowPricingParams`

#`ValidateAgentParams`

#`ValidateWorkflowParams`

#`ValidateCategoriesParams`

#`SubscribeParams`

#`UnsubscribeParams`

#`ListSubscriptionsParams`

#`CreateSourceParams`

#`GetSourceParams`

#`GetSourceBySlugParams`

#`ListSourcesParams`

#`DeleteSourceParams`

#`CreatePrincipalParams`

#`GetPrincipalParams`

#`ListPrincipalsParams`

#`DeletePrincipalParams`

#`ListDeliveriesParams`

#`AcknowledgeDeliveryParams`