Skip to main content
GET
/
api
/
v2
/
public
/
workflow
/
request-structure
/
:workflow_id
curl -X GET "https://app.refold.ai/api/v2/public/workflow/request-structure/{workflow_id}" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "linked_account_id: YOUR_LINKED_ACCOUNT_ID"

{
  "payload": null,
  "schema": null,
  "schema_interpreted": null
}
Return the structure a workflow expects when you execute it — its JSON Schema (if defined) and/or a structure derived from the workflow’s manual_execution_payload. Use this to build a valid execute payload.
This authenticates as a linked account, so it resolves the structure for that account’s private workflow.

​
Authentication

This endpoint is scoped to a linked account, so it accepts either authentication method. Option 1 — API key
​
x-api-key
string
Your Refold API key.
​
linked_account_id
string
The linked account that owns the workflow.
Option 2 — Session token
​
Authorization
string
Session token. Format: Bearer YOUR_SESSION_TOKEN

​
Path Parameters

​
workflow_id
string
required
The workflow ID.

​
Response

​
payload
object
A sample payload derived from manual_execution_payload, or null.
​
schema
object
The workflow’s JSON Schema, or null.
​
schema_interpreted
object
A friendly interpretation of the schema, or null.
{
  "payload": null,
  "schema": null,
  "schema_interpreted": null
}

curl -X GET "https://app.refold.ai/api/v2/public/workflow/request-structure/{workflow_id}" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "linked_account_id: YOUR_LINKED_ACCOUNT_ID"