Skip to main content
The run command manages async job execution for agents and recipes via a jobs server.

Quick Start

Commands Overview

CommandDescription
praisonai run submitSubmit a new job
praisonai run status <id>Get job status
praisonai run result <id>Get job result
praisonai run stream <id>Stream job progress
praisonai run listList all jobs
praisonai run cancel <id>Cancel a job

Starting the Jobs Server

Before using job commands, start the jobs server:

Submit a Job

Basic Submission

Submit with Recipe

Submit with Agent File

Advanced Options

Submit Options

OptionDescription
--agent-filePath to agents.yaml
--recipeRecipe name (mutually exclusive with —agent-file)
--recipe-configRecipe config as JSON string
--frameworkFramework to use (default: praisonai)
--timeoutTimeout in seconds (default: 3600)
--waitWait for completion
--streamStream progress after submission
--idempotency-keyKey to prevent duplicates
--idempotency-scopeScope: none, session, global
--webhook-urlWebhook URL for completion
--session-idSession ID for grouping
--metadataCustom metadata (KEY=VALUE, repeatable)
--jsonOutput JSON for scripting
--api-urlJobs API URL (default: http://127.0.0.1:8005)

Check Job Status

Status Output

Get Job Result

Stream Job Progress

Stream real-time progress updates via SSE:

Stream Output

List Jobs

Cancel a Job

Idempotency

Prevent duplicate job submissions:

Idempotency Scopes

ScopeDescription
noneNo idempotency (default)
sessionUnique within session
globalUnique across all sessions

Webhooks

Configure webhooks to receive notifications when jobs complete:
Webhook payload:

Session Grouping

Group related jobs by session:

Python API

Complete Workflow Example

Scripting with JSON

See Also