Skip to main content
Manage async jobs using the praisonai-ts CLI.

​
Quick Start

1

Simple Usage

npm install -g praisonai-ts
praisonai-ts run submit "Analyse this data"
2

With Configuration

praisonai-ts run submit "Long task" --recipe news-analyzer --wait --stream

​
Commands Overview

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

​
Submit a Job

# Basic submission
praisonai-ts run submit "Analyze this data"

# With recipe
praisonai-ts run submit "Analyze AI trends" --recipe news-analyzer

# With recipe config
praisonai-ts run submit "Analyze" --recipe analyzer --recipe-config '{"format": "json"}'

# Wait for completion
praisonai-ts run submit "Quick task" --wait

# Stream progress
praisonai-ts run submit "Long task" --stream

# With timeout
praisonai-ts run submit "Complex task" --timeout 7200

# With webhook
praisonai-ts run submit "Task" --webhook-url https://example.com/callback

# With idempotency
praisonai-ts run submit "Task" --idempotency-key order-123

# JSON output
praisonai-ts run submit "Task" --json

# Custom API URL
praisonai-ts run submit "Task" --api-url http://localhost:8080

​
Submit Options

OptionDescription
--recipeRecipe name to execute
--recipe-configRecipe config as JSON
--timeoutTimeout in seconds (default: 3600)
--waitWait for completion
--streamStream progress
--idempotency-keyKey to prevent duplicates
--webhook-urlWebhook URL for completion
--session-idSession ID for grouping
--jsonOutput JSON
--api-urlJobs API URL

​
Check Status

praisonai-ts run status run_abc123
praisonai-ts run status run_abc123 --json

​
Get Result

praisonai-ts run result run_abc123
praisonai-ts run result run_abc123 --json

​
Stream Progress

praisonai-ts run stream run_abc123
praisonai-ts run stream run_abc123 --json

​
List Jobs

praisonai-ts run list
praisonai-ts run list --status running
praisonai-ts run list --json

​
Cancel Job

praisonai-ts run cancel run_abc123

​
Examples

​
Complete Workflow

# 1. Submit job with recipe
praisonai-ts run submit "Analyze news" --recipe news-analyzer --json

# 2. Check status
praisonai-ts run status run_abc123

# 3. Stream progress
praisonai-ts run stream run_abc123

# 4. Get result
praisonai-ts run result run_abc123

​
Scripting

#!/bin/bash

RESULT=$(praisonai-ts run submit "Analyze" --recipe analyzer --json)
JOB_ID=$(echo $RESULT | jq -r '.jobId')

while true; do
    STATUS=$(praisonai-ts run status $JOB_ID --json | jq -r '.status')
    if [ "$STATUS" = "succeeded" ] || [ "$STATUS" = "failed" ]; then
        break
    fi
    sleep 5
done

praisonai-ts run result $JOB_ID --json

Async Jobs

SDK documentation

Background Tasks CLI

Background task CLI

Jobs

Jobs API overview