Preview Changes will not be visible to customers until published.

Agentic API - Integration Guide

In this article

  1. Overview
  2. API Capabilities and Constraints
  3. Getting access
  4. Creating workflows for Agentic API navigation
  5. Testing the API
  6. Navigation outcome
  7. Other things to note
  8. Appendix

Overview

This guide explains how to use Procedureflow’s Agentic API to programmatically navigate Procedureflow procedures step by step.

What this guide is

  • A reference for using the Agentic API to navigate procedures in Procedureflow
  • A description of the requirements an entry point must meet to support Agentic API navigation
  • A description of what the Agentic API needs from your flows, and the behavior you can expect in return

What this guide is not

  • A framework for building autonomous or intelligent agents
  • A general guide or set of best practices for creating all entry points and flows in Procedureflow
  • A complete description of future agent capabilities
  • A replacement for human judgment in complex or ambiguous processes

API Capabilities and Constraints

What the Agentic API can do

  1. Start navigation from a defined entry point
  2. Move through procedures based on the branching logic defined across the flows and shapes in an entry point
  3. Follow actions and decisions as they are defined
  4. Stop when it reaches the entry point's last End Shape, after navigating all applicable steps and flows

What the Agentic API cannot do

  • Accept free-form human input to jump directly to an arbitrary flow — it follows the defined connector paths only
  • Execute automated system-to-system actions or in-flow automations (this release covers navigation only)
  • Apply human-like reasoning or judgment to ambiguous steps

Getting access

Follow these steps to enable the Agentic API in your environment:

Enable Agentic API

Agentic must also be enabled for your organization by Procedureflow — notify your Customer Support team and let them know which environment you want the Agentic API enabled in (for example, sandbox or testing).

Administrative setup

Before you start navigating flows with the Agentic API, complete this one-time admin setup. An Org Admin is required.

Generate a Procedureflow Personal Access Token

  1. Log in to Procedureflow as an Org Admin.
  2. Go to Administration > Developers > Personal Access Tokens > New Access Token.
  3. Create a new access token.
  4. Set the permissions to Read and Write for the Session events .
  5. Save the token securely — you'll need it to authenticate your requests when navigating flows via the Agentic API.

Once the feature is enabled and you have a valid PAT for that environment, you can begin using the Agentic API to navigate flows.

Creating workflows for Agentic API navigation

Entry points are navigation boundaries

  • An entry point establishes the navigation scope for the Agentic API. The Agentic API cannot navigate outside the entry point.
  • Within that boundary, the Agentic API can navigate all flows in the entry point.

Guidelines for creating workflows

See Workflow rules for guidance on building compatible flows.

Verifying your entry point

Before using the Agentic API, verify that:

  • All flows within the entry point follow the workflow rules linked above
  • Each flow has a single start (Action Shape) and at least one End Shape
  • Decision paths are clearly labelled
  • There are no broken or looping connectors

Tip: Manual or visual review is recommended during early access.


Testing the API

Two endpoints are used to navigate a procedure:

  1. Create Session endpoint
  2. Navigation endpoint

Both require a Personal Access Token issued by Procedureflow. See Part 2 for how to obtain one. For full endpoint details, request/response schemas, and examples, see the Procedureflow API Reference.


Authentication

Include your PAT in the Authorization   header using the Bearer token format:

Authorization: Bearer <PAT>

Create Session Endpoint

POST https://api.procedureflow.com/v1/entry-points/:entryPointId/sessions

This endpoint creates a new navigation session for the specified entry point.

Path parameter

Parameter Description
entryPointId         The ID of the entry point to navigate. This must be included as a URL parameter.

Response

A successful call returns the new session, including its id  . Save this value — you'll pass it as the sessionId  in every Navigation request.


POST https://api.procedureflow.com/v1/entry-points/:entryPointId/sessions/:sessionId/navigate

Path parameters

Parameter Description
entryPointId         The ID of the entry point to navigate. This must be included as a URL parameter.
sessionId         The value of the id  field is returned from a successful session creation response. This must also be included as a URL parameter.

Request body

A request body is not always required. Include one only when the current step is a Decision Shape that requires input before navigation can proceed. If the current step is not a decision, a request body has no effect.

When required, use this format:

{
  "decision": {
    "shape": {
      "id": "decisionId"
    }
  }
}

Replace decisionId  with the ID of the Decision Shape you're selecting. The valid Decision Shape IDs come from the previous Navigation response.

Response

Each Navigation response indicates your current position in the flow and whether navigation is complete. When the current step is a Decision Shape, the response lists the Decision Shapes you can choose from — select one and send its ID back in the next request body to advance.

Session Completion

Once navigation reaches the last End Shape, the session is complete. Additional Navigation calls with the same sessionId  return the same completed result — they do not advance or restart navigation. To navigate again, create a new session with the Create Session endpoint and use the new session ID.


Navigation outcome

What navigation "success" looks like (minimal signal)

At a minimum:

  1. Navigation starts at the first shape in the entry point
  2. It moves from one shape to the next according to the connector logic
  3. When a shape is a Flow Link, the Agentic API:
    1. Navigates into that sub-flow
    2. Navigates all shapes and decision paths within the sub-flow
    3. Exits the sub-flow when it reaches an End Shape
    4. Returns to the parent flow at the Flow Link shape, then continues to the next shape
  4. Decisions are followed using connector labels
  5. Navigation ends when the entry point's final End Shape is reached

What to ignore for now

  • Visual layout or styling of flows and shapes
  • Optimization for human readability

Note: Focus on simple structure and explicit paths first.

Other things to note

Your feedback and our Support

The Agentic API is in early access, and your feedback plays an important role in shaping how it evolves.

During your evaluation

If you encounter issues, unexpected behavior, or limitations while using the Agentic API, please let us know. We're happy to connect directly to review what you're seeing, help unblock you, and better understand your experience.

What to expect during evaluation

  • Support during early access focuses on unblocking you so you can keep building
  • Some issues may not have immediate fixes
  • Feedback may inform future improvements rather than result in immediate changes

Post-evaluation

At the end of your evaluation period, we'll schedule a dedicated feedback call to review your experience in detail. This conversation helps us understand what's working well, where you're hitting friction, and how we can improve.

We appreciate your willingness to explore new capabilities early. Your insights directly influence how we make the Agentic API more reliable for everyone.

Appendix

Integration endpoint

Related Articles