neon.data_api.request

Resolve the Neon Data API URL via connection, then call PostgREST to read/write data

Overview

Property	Value
Workflow type	Linear
Library	App-neon
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	—
cloud_connection_uuid	uuid	Yes	—	—
neon_branch_uuid	uuid	Yes	—	—
neon_database_uuid	uuid	No	—	—
db_name	string	No	—	—
method	string	No	—	HTTP method (default GET)
table	string	No	—	PostgREST table name (sets path); ignored if path is set
path	string	No	—	Path relative to /rest/v1 (overrides table)
query	json	No	—	PostgREST query params, e.g.
headers	json	No	—	—
body	json	No	—	—
jwt	string	No	—	Bearer JWT; omit to mint anonymous via Neon connection
auth_base_url	string	No	—	Optional Neon Auth URL override for anonymous mint
fail_on_http_error	boolean	No	—	—
actor	string	No	—	—

Output Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	—
cloud_connection_uuid	uuid	Yes	—	—
neon_branch_uuid	uuid	Yes	—	—
neon_database_uuid	uuid	No	—	—
db_name	string	No	—	—
method	string	No	—	HTTP method (default GET)
table	string	No	—	PostgREST table name (sets path); ignored if path is set
path	string	No	—	Path relative to /rest/v1 (overrides table)
query	json	No	—	PostgREST query params, e.g.
headers	json	No	—	—
body	json	No	—	—
jwt	string	No	—	Bearer JWT; omit to mint anonymous via Neon connection
auth_base_url	string	No	—	Optional Neon Auth URL override for anonymous mint
fail_on_http_error	boolean	No	—	—
actor	string	No	—	—
neon_project_id	string	No	—	—
neon_branch_id	string	No	—	—
data_api_url	string	No	—	—
jwt_source	string	No	—	—
request_url	string	No	—	—
response_status_code	integer	No	—	—
response_body	string	No	—	—
response_json	json	No	—	—
response_headers	json	No	—	—
rows	list	No	—	—
failed_at	string	No	—	—
failure_reason	string	No	—	Engine-stamped human-readable failure reason
failed_at_state	string	No	—	Engine-stamped state when the workflow failed
failed_step	string	No	—	Engine-stamped step name (DAG path)
failed_layer	integer	No	—	Engine-stamped layer index (DAG path)
error	string	No	—	Engine-stamped exception message
error_type	string	No	—	Engine-stamped exception class name
failure_type	string	No	—	Engine-stamped failure category (atomic path)
failed_action	string	No	—	Engine-stamped action method that raised (atomic path)

States

State	Initial	Terminal	Success	Auto-advance	Description
initiated	Yes	No	—	resolve	Inputs accepted
requesting	No	No	—	complete	Calling neon.data_apis.request
resolving	No	No	—	request	Resolving data_api_url via neon.data_apis.get
completed	No	Yes	Yes	—	Data API request finished
failed	No	Yes	No	—	Request failed

State Diagram

Transitions

From	Action	To	Description
initiated	resolve	resolving	—
resolving	request	requesting	—
requesting	complete	completed	—
* (any state)	fail	failed	—

API Usage

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

{
  "workflow_type": "neon.data_api.request",
  "initial_data": {
    "organization_uuid": "value",
    "cloud_connection_uuid": "value",
    "neon_branch_uuid": "value"
  }
}