Skip to main content
POST
/
agents
/
{name}
/
workflow
JavaScript
import Reminix from '@reminix/sdk';

const client = new Reminix({
  apiKey: process.env['REMINIX_API_KEY'], // This is the default and can be omitted
});

const response = await client.agents.startWorkflow('name');

console.log(response.run_id);
{
  "run_id": "<string>",
  "status": "<string>",
  "state": {},
  "pendingAction": {},
  "execution": {
    "id": "<string>",
    "url": "<string>",
    "type": "agent_invoke",
    "status": "success",
    "duration_ms": 123
  }
}

Authorizations

Authorization
string
header
required

API Key or Personal Access Token (PAT). When using PAT, include X-Project header.

Path Parameters

name
string
required

Unique, URL-safe agent name within the project

Minimum string length: 1
Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json
input
object

Input data for the workflow agent

stream
boolean

Enable streaming response (SSE)

context
object

Optional context: identity (run scoping), attributes, and pass-through

Response

Workflow run started

run_id
string
required

Workflow run ID

status
string
required

Workflow run status

state
object
required

Full workflow state (steps, result, etc.)

pendingAction
object

Pending action details when paused

execution
object

Execution reference for tracking