How to Create an Endpoint

This guide shows you how to expose a published Flow at a custom HTTP method and path (see Custom Endpoints).

Prerequisites

A published Flow in the Space that produces the data you want to return.
Admin access to the Space.
At least one authentication strategy on the Space (Space Settings → Auth), for the public App front door.

Steps

In Studio, open Space Settings → Endpoints.
Click Create Endpoint.
Fill in:
- Name — an internal label.
- Method — GET, POST, PUT, PATCH, or DELETE.
- Path — the caller-chosen path, for example tasks/{taskId}/update-status. Each {param} segment becomes a typed path parameter.
- Flow — the Flow to run for matching requests.
Click Create. The Endpoint is created in draft status.
Open the Endpoint and click Publish to make it available on the public front door.
Grant execute on the handler Flow to each Space role that should be able to call the Endpoint (for example, the Guest role for anonymous callers). Callers without it get the same 404 as an unknown path.

Result: The Endpoint has published status and is available on the public App front door. Callers with execute on the handler Flow can call it; others get the same 404 as an unknown path.

Testing Before Publishing

While the Endpoint is a draft, test it on the Studio preview front door:

/spaces/{spaceId}/endpoints/tasks/{taskId}/update-status

Preview serves draft Endpoints (falling back to published), so you can iterate without affecting the public URL.

Path Parameters

Path params ({param} segments) are typed by the path template and validated against that type.

Response Body

The response body is built from the Endpoint's response contract; values can be literals, Flow node outputs, or run context. Either map them into object fields or return a single value as the root of the body.

To let the Flow decide the status, headers, and body instead, set Response → Source to Controlled by flow; see How to Redirect and Set Cookies from an Endpoint.

Limitations

Only published Endpoints are served on the public front door.

Custom Endpoints

Endpoints let a Space expose a published Flow at a caller-chosen HTTP method and path. They are the programmatic counterpart to Experiences: where an Experience renders a UI at a path, an Endpoint returns a JSON body at a path.

How to Authenticate Requests with a JWT

This guide shows you how to let an external system call a Space's App (for example, an Endpoint, see How to Create an Endpoint) with a bearer JWT issued by its own identity provider.

How to Redirect and Set Cookies from an Endpoint

This guide shows you how to let a Flow decide an Endpoint's response (see Custom Endpoints): redirect the caller, set cookies, or return a status other than the Endpoint's fixed one.