SuperAI Flow Platform

Sections

Theme switcher

List all available task executors

Header Parameters

Authorizationstring

Response

200
Object
List of task executors successfully retrieved

Response Attributes

flow_input_schemanull
is_input_task_executorboolean Required

Whether this executor can trigger flow execution from external sources.

Input executors (true):

  • Receive data from external systems (webhooks, emails, files, schedules)
  • Can be first task in a flow
  • Have flow_input_schema defining received data structure
  • Examples: receive_email, receive_file, webhook_receive, scheduled_trigger

Non-input executors (false):

  • Process data within flow execution
  • Cannot trigger flows (must be downstream of input executor)
  • No flow_input_schema
  • ...
is_schedulable_executorboolean Required

Whether this executor supports scheduled/recurring execution.

Schedulable executors (true):

  • Can run on cron schedules (hourly, daily, weekly, custom)
  • Support time-based triggers
  • Often paired with input executors
  • Examples: scheduled_url (fetch data periodically), scheduled_db_query

Non-schedulable executors (false):

  • Event-driven only (triggered by upstream tasks or external events)
  • Cannot run on schedule
  • Examples: send_email, classify_document, receive_email (event-driv...
parameters_schemaobject Required

JSON Schema defining configuration parameters for this task executor. Describes required and optional parameters, their types, and validation rules. Clients use this schema to generate configuration UIs and validate inputs.

Schema Format: JSON Schema Draft 2020-12 specification

Common properties: type, required, properties, additionalProperties, description, examples, enum, default, minimum, maximum, pattern

Used for: UI form generation, parameter validation, API documentation

...

task_executor_agent_promptstring Required

Prompt template used by AI agents when configuring this task executor. Provides context to LLM agents about executor capabilities and parameters. Guides automated flow generation and task configuration.

Format: Natural language instructions for AI agents describing when and how to use this executor.

Used by: Flow Builder AI Assistant, Auto-configuration agents

task_executor_descriptionstring Required

Human-readable description of what this task executor does. Explains the executor's purpose, behavior, and typical use cases. Displayed in UI flow builders and documentation.

Should be 1-3 sentences focusing on capabilities and outcomes. Written in present tense, active voice.

Min length
10
task_executor_namestring Required

Unique identifier for this task executor type. Used in flow definition YAML to reference this executor. Case-sensitive and immutable.

Naming convention: snake_case with descriptive action verbs.

Examples: 'send_email', 'doc_to_structured', 'classify_document', 'receive_file', 'webhook_notification', 'external_db'

Min length
1
500
Object
Internal Server Error - An unexpected error occurred

Response Attributes

errorobject Required

Standard error detail structure.

This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.

Show child attributes

request_idnull
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot