Agentic API Integration Guide

Part 1 - 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 Procedureflow’s Agentic API to navigate procedures in Procedureflow
• A description of the requirements that entry points must meet to support navigation with Agentic API
• A description of what the Agentic API needs from flows, and what behavior you can expect in return

What this guide is not

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

Early adopter expectations

The Agentic API is an early access feature. It’s designed for teams who are comfortable working with new capabilities that are still evolving.

You can expect:

• The Agentic API follows compatible flows in the same way
• Gradual improvements to what the API can do during the early adopter phase
• If a flow doesn’t meet the requirements, navigation may fail

You should not expect:

• Helpful or detailed error messages in every case
• Automatic checks that catch all flow issues before navigation
• The API to explain why the navigation failed
• Backward compatibility during early access
• Production-level stability, defined performance benchmarks, or formal service guarantees, as the program is intended solely for testing and feedback.

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 presented across the flows and shapes in an entry point
3. Follow actions and decisions as they are defined
4. Stop when the navigation reaches the last End Point Shape of the entry point after navigating all the steps and flows within an entry point 

What the Agentic API cannot do

• Human data input to jump to flows
• Automated system-to-system execution
• Human-like reasoning or judgment

Part 2 - Getting access

How to get access in your environment

Notify your Customer Support team and let us know which environment you want the Agentic API enabled in (for example, sandbox or testing).

Obtain a Procedureflow Personal Access Token (PAT)

You’ll need a PAT that is associated with the same environment. This token will be used to authenticate requests when navigating flows via the Agentic API.

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

Part 3 – Creating workflows for Agentic API navigation

Entry points are navigation boundaries

• An entry point establishes the navigation scope of the Agentic API. The Agentic API cannot support navigation outside the entry point.
• Agentic API can navigate all flows within an entry point.

Guidelines for creating workflows

Please see the guide for creating workflows here

Verifying your entry point

Before using the Agentic API, verify that:

• All flows within the entry point follow the rules 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

Manual or visual review is recommended during early access.

Part 4: Testing the API

There are two primary endpoints used to test the API:

1. Create Session Endpoint
2. Navigation Endpoint

Both endpoints require a Personal Access Token issued by ProcedureFlow. See Part 2 for instructions on generating a token.

For full endpoint details, request/response schemas, and examples, see the Procedureflow API Reference

Include the token 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

Requirements

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

Navigation Endpoint

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

Requirements

Request Body

A request body is not always required.

You only need to include a request body when the current navigation step is a decision shape that requires human input before the navigation can proceed.

If the current step does not require a decision, passing a request body has no effect.

When required, the request body should use the following format:

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

Where decisionId      is the ID of the selected decision shape.

Session Completion

At the end of the navigation process, subsequent calls using the same sessionId      are idempotent. This means they will always respond in the same way.

To start a new navigation session, create a new session using the Create Session Endpoint, then use the new session ID in the sessionId       URL parameter for the Navigation Endpoint.

Part 5 – Navigation outcome

What navigation “success” looks like (minimal signal)

At a minimum:

1. The navigation starts at the first shape within an entry point
2. It moves from one shape to the next shape in the connector logic
3. If a shape is a flow link, the Agentic API:
   1. Navigates into that sub-flow
   2. Then, navigates all shapes and decision paths within that sub-flow
   3. Exits the sub-flow when it reaches an endpoint
   4. Returns to the parent flow and continues navigation at the sub-flow shape, then proceeds to the next shape.
4. Decisions are followed using connector labels
5. Navigation ends when an endpoint is reached at the end of the entry point

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.

Part 5 - 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 is focused on unblocking you so you can continue 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 will schedule a dedicated feedback call to review your experience in detail. This conversation will help us understand what’s working well, where you’re encountering friction, and how we can improve.

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

Appendix

Integration endpoint

• API Documentation: API Documentation