uipath-api-workflow

Author, validate, run, and publish UiPath API workflow JSON files via the uip CLI.

9|6|Updated Aug 25, 2017
One-click install
npx skills add https://github.com/sergueik/springboot_study --skill uipath-api-workflow-sergueik
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: uipath-api-workflow
Source: https://github.com/sergueik/springboot_study/tree/main/basic-uipath-skills/.github/skills/uipath-api-workflow
Command: npx skills add https://github.com/sergueik/springboot_study --skill uipath-api-workflow-sergueik

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve? Writing UiPath API workflows by hand is error-prone: the JSON must conform to the CNCF Serverless Workflow DSL with UiPath activity extensions, StudioWeb's designer silently corrupts certain shapes on save, and connector activities require tenant-specific metadata that cannot be guessed. This Skill encodes the exact structural rules, CLI commands, and validation loops needed to produce workflows that run locally, render in StudioWeb, and deploy to UiPath Cloud. ## Core Features & Use Cases - Workflow authoring: Create and edit JSON workflows with Sequence, Assign, JavaScript, If, ForEach, DoWhile, Break, TryCatch, Wait, and Response activities, including deeply nested control-flow patterns. - Connector activity discovery: Resolve and stub HTTP and Integration Service connector activities (Gmail, Outlook, GitHub, Slack) via uip api-workflow registry resolve/stub, with connection verification and required-field cross-checks. - Lifecycle operations: Scaffold projects with uip api-workflow init, validate statically, run locally with --no-auth, and pack/publish/deploy through uip solution. - Use Case: A user asks for a workflow that reads the newest Outlook email and posts a summary to Slack. The Skill resolves both connector activities, verifies pinged connections, stubs the activities with correct metadata, assembles the JSON, validates it, and walks through publish and deployment. ## Quick Start Ask the assistant to create a UiPath API workflow that fetches data from a public API and returns the result, then validate it with uip api-workflow validate.

Frequently Asked Questions about uipath-api-workflow

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a UiPath API workflow project?

Run `uip api-workflow init <name>` from inside the solution directory containing the .uipx file. It scaffolds project.uiproj, Workflow.json, entry-points.json, and bindings_v2.json, and auto-registers the project in the solution. Never hand-assemble the project files.

How do I add a Gmail or Outlook connector activity to an API workflow?

Use `uip api-workflow registry resolve "<keyword>"` to find the activity GUID, verify a connection with `uip is connections ping <uuid>`, then run `uip api-workflow registry stub <guid> --connection-id <uuid>`. Drop the emitted Activity object into the root sequence and cross-check required fields.

Why does my API workflow fail after saving in StudioWeb?

StudioWeb's designer normalizes unwrapped string literals in Assign, Response, and If fields into expressions, causing ReferenceError at runtime. Wrap string literals as "${'literal'}" and use the single-expression form for object-valued Response payloads.

Can I run a UiPath API workflow locally without authentication?

Yes, run `uip api-workflow run <file> --no-auth` for control-flow-only workflows or Http kind activities using ImplicitConnection. IntSvc vendor connector activities always require `uip login` because the IS proxy needs a bearer token.

How do I publish a UiPath API workflow to the cloud?

Pack the solution with `uip solution pack <solutionDir> <outputDir>`, then publish with `uip solution publish <package.zip>`. There is no `uip api-workflow publish` command; publishing always goes through the solution packager.

When should I not use API workflows?

Do not use API workflows for .flow Maestro flows, .xaml or coded RPA automations, coded agents, or Coded Web Apps. Those project types are handled by the uipath-maestro-flow, uipath-rpa, uipath-agents, and uipath-coded-apps skills respectively.