Documentation

/api/workflows routes

28 routes under /api/workflows that an account can call. Columns are explained on the HTTP routes page; type a path, a scope or a tool name to filter.

/api/workflows (28)

MethodsPathScope402ReceiptAccessTools
GET PUT PATCH DELETE/api/workflows/[id]workflows:read workflows:writekey
POST/api/workflows/[id]/analyze-target-urlsworkflows:writekey
GET/api/workflows/[id]/articleworkflows:readkey
POST/api/workflows/[id]/auto-generate-v2workflows:writekey
POST/api/workflows/[id]/auto-generate-v3workflows:writekey
POST/api/workflows/[id]/client-style-polish/startworkflows:writekey
POST/api/workflows/[id]/generate-listicle/syncworkflows:writeself-serve keyworkflow_generate_listicle_sync
GET/api/workflows/[id]/line-item-idworkflows:readkey
GET/api/workflows/[id]/line-itemsworkflows:readkey
POST/api/workflows/[id]/link-insertion/contextual/startworkflows:writeself-serve key
POST/api/workflows/[id]/link-insertion/listicle/startworkflows:writeself-serve key
POST/api/workflows/[id]/outline-generation/retryworkflows:writekey
POST/api/workflows/[id]/outline-generation/startworkflows:writekey
POST/api/workflows/[id]/outline-generation/start-v2workflows:writekey
GET POST/api/workflows/[id]/step-completedworkflows:read workflows:writekey
GET POST/api/workflows/[id]/step-sync-status/[stepId]nonesession only
PATCH/api/workflows/[id]/steps/[stepId]/outputsworkflows:writekey
POST/api/workflows/[id]/steps/generate-insertion-brief/manual-listicleworkflows:writekeyworkflow_brief_set_manual_listicle
POST/api/workflows/[id]/topic-generation/finalizeworkflows:writekey
POST/api/workflows/[id]/topic-generation/phase-1/auto-selectworkflows:writekey
POST/api/workflows/[id]/trigger/resumeworkflows:write402receiptself-serve keyworkflow_trigger_resume
POST/api/workflows/[id]/trigger/startworkflows:write402receiptself-serve keyworkflow_trigger_start
GET/api/workflows/[id]/trigger/statusworkflows:readkeyworkflow_trigger_status
GET POST/api/workflows/[id]/verify-publicationpublishers:read publishers:write402receiptsession only (scope)
POST/api/workflows/[id]/verify-publication/startworkflows:write402key
POST/api/workflows/resolve-target-urlworkflows:readkey
POST/api/workflows/send-article-to-publisherworkflows:writeself-serve keyworkflow_send_to_publisher
POST/api/workflows/send-pre-approvalworkflows:writesession only