Project Workflows
Manage project workflows and automation runs.
GET
Get a workflow run and its tasks
/organizations/{organizationId}/projects/{projectId}/workflows/runs/{runId}Parameters
- organizationIdRequired
- path · string
- projectIdRequired
- path · string
- runIdRequired
- path · string
SDK
import { createGiantContext } from "@giantcontext/sdk-typescript";
const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });
const { organizations: orgs } = await gc.me.listMyOrganizations();const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });
const { run } = await gc.projectWorkflows.getWorkflowRun({ organizationId: orgs[0].id, projectId: projects[0].id, runId: "run_123",});
DELETE
Dismiss a workflow run
/organizations/{organizationId}/projects/{projectId}/workflows/runs/{runId}Parameters
- organizationIdRequired
- path · string
- projectIdRequired
- path · string
- runIdRequired
- path · string
SDK
import { createGiantContext } from "@giantcontext/sdk-typescript";
const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });
const { organizations: orgs } = await gc.me.listMyOrganizations();const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });
const result = await gc.projectWorkflows.dismissWorkflowRun({ organizationId: orgs[0].id, projectId: projects[0].id, runId: "run-123",});
GET
List workflow runs
/organizations/{organizationId}/projects/{projectId}/workflows/runsParameters
- page
- query · number
- pageSize
- query · number
- lite
- query · string
- sort
- query · string
- search
- query · string
- status
- query · string
- type
- query · string
- createdAt
- query · string
- startedAt
- query · string
- completedAt
- query · string
- includeDismissed
- query · string
- organizationIdRequired
- path · string
- projectIdRequired
- path · string
SDK
import { createGiantContext } from "@giantcontext/sdk-typescript";
const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });
const { organizations: orgs } = await gc.me.listMyOrganizations();const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });
const { workflowRuns } = await gc.projectWorkflows.listWorkflowRuns({ organizationId: orgs[0].id, projectId: projects[0].id,});
POST
Start a workflow run
/organizations/{organizationId}/projects/{projectId}/workflows/runsParameters
- organizationIdRequired
- path · string
- projectIdRequired
- path · string
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 { organizations: orgs } = await gc.me.listMyOrganizations();const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });
const { workflowRun } = await gc.projectWorkflows.createWorkflowRun({ organizationId: orgs[0].id, projectId: projects[0].id, data: {}});
BuiltAutonomously With AI
This content was built autonomously. Giant Context analyzed the site, determined what was missing, created and submitted an idea and draft, which Giant Context staff accepted and published.