Skip to content
Proud to collaborate with Microsoft for Startups

neon.data_api.select ​

Select rows via Neon Data API; mints an anonymous JWT from the Neon connection when jwt is omitted

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-neon
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
cloud_connection_uuiduuidYes——
neon_branch_uuiduuidYes——
neon_database_uuiduuidNo——
db_namestringNo——
tablestringYes—PostgREST table / view name
selectstringNo—PostgREST select= column list (default *)
filterstringNo—Raw filter fragment, e.g. id=eq.1&active=is.true
orderstringNo——
limitintegerNo——
offsetintegerNo——
preferstringNo——
jwtstringNo—Optional caller JWT; when omitted, mint anonymous via connection
auth_base_urlstringNo—Optional Neon Auth URL override for anonymous mint
fail_on_http_errorbooleanNo——
actorstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
cloud_connection_uuiduuidYes——
neon_branch_uuiduuidYes——
neon_database_uuiduuidNo——
db_namestringNo——
tablestringYes—PostgREST table / view name
selectstringNo—PostgREST select= column list (default *)
filterstringNo—Raw filter fragment, e.g. id=eq.1&active=is.true
orderstringNo——
limitintegerNo——
offsetintegerNo——
preferstringNo——
jwtstringNo—Optional caller JWT; when omitted, mint anonymous via connection
auth_base_urlstringNo—Optional Neon Auth URL override for anonymous mint
fail_on_http_errorbooleanNo——
actorstringNo——
neon_project_idstringNo——
neon_branch_idstringNo——
data_api_urlstringNo——
jwt_sourcestringNo—caller
request_urlstringNo——
response_status_codeintegerNo——
response_bodystringNo——
response_jsonjsonNo——
response_headersjsonNo——
rowslistNo——
row_countintegerNo——
failed_atstringNo——
failure_reasonstringNo—Engine-stamped human-readable failure reason
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerintegerNo—Engine-stamped layer index (DAG path)
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name
failure_typestringNo—Engine-stamped failure category (atomic path)
failed_actionstringNo—Engine-stamped action method that raised (atomic path)

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—resolveInputs accepted
requestingNoNo—completeCalling neon.data_apis.request
resolvingNoNo—requestResolving data_api_url + JWT
completedNoYesYes—Select finished
failedNoYesNo—Select failed

State Diagram ​

Transitions ​

FromActionToDescription
initiatedresolveresolving—
resolvingrequestrequesting—
requestingcompletecompleted—
* (any state)failfailed—

API Usage ​

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

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