WorkflowsGet step

GET /v1/projects/{project}/workflows/{workflow}

Retrieve a single custom workflow step, including its prompts.

curl https://serpon.ai/v1/projects/1/workflows/501 \
  -H "Authorization: Bearer $SERPON_TOKEN" \
  -H "Accept: application/json"
{
  "success": true,
  "data": {
    "id": 501,
    "workflow_id": 12,
    "project_id": 1,
    "article_type": "product_datasheet",
    "step_number": 1,
    "step_name": "Research product details",
    "step_description": "Compile specifications and use cases",
    "step_icon": "search",
    "system": "You are a technical writer specializing in product documentation.",
    "user": "Research and compile detailed specifications for: {title}.",
    "output_format": "json",
    "timeout_seconds": 120,
    "include_additional_context": true,
    "include_additional_instruction": false,
    "include_requirements": false,
    "include_research": false,
    "include_outline": false,
    "json_schema": null,
    "is_custom": true,
    "is_redacted": false,
    "created_at": "2026-07-14T09:00:00.000000Z",
    "updated_at": "2026-07-14T09:00:00.000000Z"
  }
}

Retrieve one workflow step.

GET https://serpon.ai/v1/projects/{project}/workflows/{workflow}

The step must belong to the project in the path. A step that exists elsewhere returns 404.

Authentication

Bearer token in the Authorization header. Requires view access to the project. See Authentication.

Path parameters

path
workflowinteger
Required

The workflow step ID.

Example

Response fields

idinteger
Required

Step ID, used on update, delete, and reorder.

workflow_idinteger
Required

The workflow this step belongs to. Steps are ordered and made unique within this workflow.

project_idinteger

Owning project, taken from the parent workflow. null would indicate a built-in workflow, which these endpoints never return.

article_typestring
Required

The owning workflow's slug. Pass this value as article_type when creating an article.

step_numberinteger
Required

Execution position. Unique within the owning workflow. Numbers need not be contiguous.

step_namestring
Required

Display name; appears as current_step on articles while the step runs.

step_descriptionstring

Free-text note about the step.

step_iconstring

Icon name used in the dashboard.

systemstring

System prompt.

userstring

User prompt, including any {template} variables.

output_formatstring
Required

text, json, or markdown.

timeout_secondsinteger

Per-step time budget, 30–600.

include_additional_contextboolean
Required

Whether {additional_context} is injected.

include_additional_instructionboolean
Required

Whether {additional_instruction} is injected.

include_requirementsboolean
Required

Whether {requirements} — word count, tone, point of view — is injected.

include_researchboolean
Required

Whether {research} is injected. At least one step needs this before articles of this type can enable research.

include_outlineboolean
Required

Whether {outline} is injected.

json_schemaobject

Structured-output schema for output_format: "json".

is_customboolean
Required

true for project-scoped steps — always the case here.

is_redactedboolean
Required

true when prompts have been withheld because the step belongs to a built-in workflow. Always false on these endpoints.

created_atstring
Required

ISO 8601 timestamp.

updated_atstring
Required

ISO 8601 timestamp.

Errors

StatusWhen
401Missing, invalid, or expired token
402Account has no active subscription
403No view access to the project
404No such step, or it belongs to another project
429Rate limit exceeded

See Errors for the full reference.