commands.events

Event commands for the agent-runtimes CLI.

events_callback

@app.callback()
def events_callback(ctx: typer.Context) -> None

Agent event management commands.

events_list

@app.command(name="list")
def events_list(
        agent_id: Optional[str] = typer.Option(
            None, "--agent-id", help="Filter events by agent runtime ID."),
        kind: Optional[str] = typer.Option(None,
                                           "--kind",
                                           help="Filter events by kind."),
        token: Optional[str] = typer.Option(
            None,
            "--token",
            help="Authentication token (Bearer token for API requests)."),
        base_url: Optional[str] = typer.Option(None,
                                               "--base-url",
                                               help="Datalayer run base URL.")
) -> None

List agent events.

events_ls

@app.command(name="ls")
def events_ls(
        agent_id: Optional[str] = typer.Option(
            None, "--agent-id", help="Filter events by agent runtime ID."),
        kind: Optional[str] = typer.Option(None,
                                           "--kind",
                                           help="Filter events by kind."),
        token: Optional[str] = typer.Option(
            None,
            "--token",
            help="Authentication token (Bearer token for API requests)."),
        base_url: Optional[str] = typer.Option(None,
                                               "--base-url",
                                               help="Datalayer run base URL.")
) -> None

List agent events (alias for list).

events_get

@app.command(name="get")
def events_get(
        event_id: str = typer.Argument(...,
                                       help="ID of the event to retrieve."),
        agent_id: Optional[str] = typer.Option(
            None,
            "--agent-id",
            help="Agent runtime ID owning the event (recommended)."),
        token: Optional[str] = typer.Option(
            None,
            "--token",
            help="Authentication token (Bearer token for API requests)."),
        base_url: Optional[str] = typer.Option(None,
                                               "--base-url",
                                               help="Datalayer run base URL.")
) -> None

Get a single event by ID.

events_create

@app.command(name="create")
def events_create(
        agent_id: str = typer.Argument(..., help="Agent runtime ID."),
        title: str = typer.Argument(..., help="Event title."),
        kind: str = typer.Option("generic", "--kind", help="Event kind."),
        status: str = typer.Option("pending", "--status",
                                   help="Event status."),
        token: Optional[str] = typer.Option(
            None,
            "--token",
            help="Authentication token (Bearer token for API requests)."),
        base_url: Optional[str] = typer.Option(None,
                                               "--base-url",
                                               help="Datalayer run base URL.")
) -> None

Create a new agent event.

events_delete

@app.command(name="delete")
def events_delete(
        event_id: str = typer.Argument(..., help="ID of the event to delete."),
        agent_id: Optional[str] = typer.Option(
            None,
            "--agent-id",
            help="Agent runtime ID owning the event (recommended)."),
        token: Optional[str] = typer.Option(
            None,
            "--token",
            help="Authentication token (Bearer token for API requests)."),
        base_url: Optional[str] = typer.Option(None,
                                               "--base-url",
                                               help="Datalayer run base URL.")
) -> None

Delete an event by ID.

events_mark_read

@app.command(name="mark-read")
def events_mark_read(
        event_id: str = typer.Argument(
            ..., help="ID of the event to mark as read."),
        agent_id: Optional[str] = typer.Option(
            None,
            "--agent-id",
            help="Agent runtime ID owning the event (recommended)."),
        token: Optional[str] = typer.Option(
            None,
            "--token",
            help="Authentication token (Bearer token for API requests)."),
        base_url: Optional[str] = typer.Option(None,
                                               "--base-url",
                                               help="Datalayer run base URL.")
) -> None

Mark an event as read.

events_mark_unread

@app.command(name="mark-unread")
def events_mark_unread(
        event_id: str = typer.Argument(
            ..., help="ID of the event to mark as unread."),
        agent_id: Optional[str] = typer.Option(
            None,
            "--agent-id",
            help="Agent runtime ID owning the event (recommended)."),
        token: Optional[str] = typer.Option(
            None,
            "--token",
            help="Authentication token (Bearer token for API requests)."),
        base_url: Optional[str] = typer.Option(None,
                                               "--base-url",
                                               help="Datalayer run base URL.")
) -> None

Mark an event as unread.