neon.data_apis.request

Call the Neon Data API (PostgREST) HTTP endpoint

Issue an HTTP request against a Neon Data API (PostgREST) base URL.

The Neon connection / console API key cannot authenticate Data API queries. Pass a JWT in jwt (Bearer), or omit it when the target allows anonymous access. Never log or persist jwt.

Inputs:

• data_api_url: PostgREST base URL ending in /rest/v1 (required).
• method: GET/POST/PATCH/PUT/DELETE (default GET).
• path: table or relative path (e.g. posts).
• query: query-string object (select, filters, limit, …).
• headers: extra headers (Prefer, Accept-Profile, …).
• body: JSON object/list or string body.
• jwt: optional Bearer JWT (sensitive — scrubbed from terminal state).
• fail_on_http_error: default true.

Outputs:

• response_status_code, response_body, response_json, response_headers, request_url

Overview

Property	Value
Workflow type	Atomic
Library	App-neon
Version	1.0

Input Schema

Field	Type	Required	Default	Description
data_api_url	string	Yes	—	PostgREST base URL from neon.data_apis.get (…/rest/v1)
method	string	No	—	HTTP method (default GET)
path	string	No	—	Table or path relative to the Data API base
query	json	No	—	Query-string parameters (PostgREST select/filters)
headers	json	No	—	Extra request headers
body	json	No	—	JSON request body
jwt	string	No	—	Bearer JWT for the Data API (not the Neon API key)
fail_on_http_error	boolean	No	—	Fail on 4xx/5xx (default true)
timeout_seconds	integer	No	—	—

Output Schema

Field	Type	Required	Default	Description
data_api_url	string	No	—	—
method	string	No	—	—
path	string	No	—	—
query	json	No	—	—
headers	json	No	—	—
body	json	No	—	—
jwt	string	No	—	—
fail_on_http_error	boolean	No	—	—
timeout_seconds	integer	No	—	—
request_url	string	No	—	—
response_status_code	integer	No	—	—
response_body	string	No	—	—
response_json	json	No	—	—
response_headers	json	No	—	—
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_action	string	No	—	—
failed_at_state	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	—
completed	No	Yes	Yes	—	—
failed	No	Yes	No	—	—

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	—
* (any state)	fail	failed	—

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "neon.data_apis.request",
  "initial_data": {
    "data_api_url": "value"
  }
}