Project Workflows
Manage project workflows and automation runs.
GET
Get a workflow run and its tasks
/organizations/{id}/projects/{projectId}/workflows/runs/{runId}Parameters
idRequired
path · stringOrganization ID
projectIdRequired
path · stringProject ID
runIdRequired
path · stringWorkflow run ID
SDK
import { createGiantContext } from "@giantcontext/sdk-typescript";
const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });
const { data: workflowRun } = await gc.projectWorkflows.getWorkflowRun({ id: "workflow_id", projectId: "project_id", runId: "run_id"});DELETE
Dismiss a workflow run
/organizations/{id}/projects/{projectId}/workflows/runs/{runId}Soft-hide a run from the default list view. The run itself is preserved for audit and can still be fetched by ID or listed with includeDismissed=true.
Parameters
idRequired
path · stringOrganization ID
projectIdRequired
path · stringProject ID
runIdRequired
path · stringWorkflow run ID
SDK
import { createGiantContext } from "@giantcontext/sdk-typescript";
const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });
const { data: run } = await gc.projectWorkflows.dismissWorkflowRun({ id: "workflow_123", projectId: "project_123", runId: "run_123"});GET
List workflow runs
/organizations/{id}/projects/{projectId}/workflows/runsReturns a paginated list of workflow runs for the project. Filter by status (pending/running/succeeded/failed/cancelled) or workflow type. Dismissed runs are hidden by default.
Parameters
page
query · number
pageSize
query · number
status
query · union
type
query · string
includeDismissed
query · stringWhen 'true', include runs that have been dismissed by the user.
idRequired
path · stringOrganization ID
projectIdRequired
path · stringProject ID
SDK
import { createGiantContext } from "@giantcontext/sdk-typescript";
const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });
const { data: workflowRuns } = await gc.projectWorkflows.listWorkflowRuns({ id: "workflow-id", projectId: "project-id"});POST
Start a workflow run
/organizations/{id}/projects/{projectId}/workflows/runsPersists a new run of the given workflow type and enqueues its root tasks (tasks with no dependencies). The orchestrator will pick them up on its next tick.
Parameters
idRequired
path · stringOrganization ID
projectIdRequired
path · stringProject ID
BodyRequired
typeRequired
stringWorkflow type identifier (must match a registered shape)
input
objectArbitrary input payload forwarded to the root task.
title
stringDisplay title. Defaults to the shape's title.
SDK
import { createGiantContext } from "@giantcontext/sdk-typescript";
const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });
const { data: workflowRun } = await gc.projectWorkflows.createWorkflowRun({ id: "workflow-id", projectId: "project-id", data: {}});Built byHuman
This content was designed and written by a human.