Guideflow API

Name: Guideflow API
Brand: Guideflow API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentMarketingContent ManagementapiKey4 EndpointsREST

For Agents

Subscribe to Guideflow webhook events and list interactive demos in a workspace.

Install Jentic One Beta

Connect the Guideflow API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Guideflow API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Guideflow API.

Create a rest-hook webhook so an external system is notified on Guideflow events

List the active webhooks registered against the workspace for visibility and audit

Delete a webhook by id when an integration is deprecated or rotated

GET STARTED

Start building with Guideflow API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Guideflow API, keeping it validated and agent-ready. Guideflow is a platform for creating interactive product demos and walkthroughs (called guideflows) that go on marketing sites, in onboarding emails, and inside sales decks. The API is intentionally small (4 endpoints) and focuses on two integration patterns: managing rest-hook webhooks so that external systems are notified when guideflow events happen, and listing guideflows by workspace for catalogue or syndication purposes. Authentication is by an Api-Authorization header.

Use Cases

Patterns agents use Guideflow API for, with concrete tasks.

★ Webhook-driven analytics

Pipe Guideflow events into a data warehouse or marketing analytics tool by registering a rest-hook webhook against the workspace. The integration calls POST /user/hooks with the destination URL, confirms via GET /hooks, and ultimately uses DELETE /hooks/{id} when the destination is rotated or retired. This avoids polling for guideflow events and keeps the analytics surface close to real time without bespoke ingestion code.

Call POST /user/hooks with the warehouse ingestion URL and confirm via GET /hooks that the subscription is active.

Demo catalogue syndication

Surface the workspace's guideflows in an external catalogue, partner portal, or in-app help drawer by listing them through GET /flow/byWorkspace. The result lets a sales-enablement site, partner extranet, or self-serve onboarding flow render the latest interactive demos without a manual content sync. Combined with embedding logic on the front end this keeps the demo library always-in-sync with what marketing has published in Guideflow.

Call GET /flow/byWorkspace and render the returned guideflows on the partner portal demos page.

Webhook lifecycle management

Keep webhook subscriptions tidy across environments by listing, recreating, and deleting them through the API. When rotating credentials or moving from staging to production, the integration deletes stale subscriptions with DELETE /hooks/{id} and creates fresh ones via POST /user/hooks. GET /hooks gives the operator an authoritative view of what is currently subscribed at any time.

List all hooks via GET /hooks, delete the staging URLs with DELETE /hooks/{id}, and recreate the production hook with POST /user/hooks.

AI agent integration through Jentic

Let a marketing-ops agent manage Guideflow webhooks and demo listings through Jentic so a manager can ask things like 'add an analytics webhook to the production workspace' or 'list the demos we shipped this quarter'. The agent searches Jentic for the relevant intent, loads the operation schema, and executes it against app.guideflow.com. Jentic stores the Api-Authorization key in its vault, so the agent never sees the raw secret.

Through Jentic, search 'create a Guideflow webhook', load the operation, and execute it for the production destination URL.

Key Endpoints

4 endpoints — jentic publishes the only available openapi specification for guideflow api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/user/hooks

Create a rest-hook webhook

GET

/hooks

List active webhooks

DELETE

/hooks/{id}

Delete a webhook by id

GET

/flow/byWorkspace

List guideflows in the workspace

POST

/user/hooks

Create a rest-hook webhook

GET

/hooks

List active webhooks

DELETE

/hooks/{id}

Delete a webhook by id

GET

/flow/byWorkspace

List guideflows in the workspace

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The Guideflow Api-Authorization header value is stored encrypted in the Jentic vault. Agents authenticate to Jentic with a scoped agent key (ak_*); the raw Guideflow secret never enters the agent's context.

Intent-based discovery

Agents search Jentic with intents like 'create a Guideflow webhook' or 'list guideflows by workspace' and Jentic returns the matching operation schema, including the Api-Authorization header requirement, ready to execute.

Time to first call

Direct Guideflow integration: under an hour because the API has only four endpoints. Through Jentic: under 15 minutes once the secret is vaulted, because the agent uses search-load-execute against pre-defined schemas.

FAQs

Specific to using Guideflow API through Jentic.

Why is there no official OpenAPI spec for Guideflow API?

Guideflow does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Guideflow API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Guideflow API use?

Guideflow uses an Api-Authorization header on every request. The key is generated in the Guideflow workspace settings and is workspace-scoped. Through Jentic the key is stored encrypted in the vault, and the agent calls Jentic with a scoped agent key (ak_*) instead of the raw Guideflow secret.

Can I list every guideflow in a workspace?

Yes. GET /flow/byWorkspace returns all guideflows in the authenticated workspace, which is enough to drive a syndicated catalogue, partner portal, or internal demos library without manual sync.

What are the rate limits for the Guideflow API?

The published spec does not document explicit rate limits. Guideflow applies platform-level throttling per workspace; back off on HTTP 429 responses and avoid creating duplicate webhooks for the same event stream.

How do I create a webhook through Jentic?

Install Jentic with pip install jentic, search for 'create a Guideflow webhook', load the matching operation, and execute it with the destination URL. Jentic resolves the call to POST /user/hooks and returns the created hook record.

How do I clean up old webhooks?

List the active hooks with GET /hooks, identify the ones to remove (for example staging or rotated URLs), then call DELETE /hooks/{id} for each. This is the standard lifecycle pattern when moving between environments or rotating credentials.