Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hilos Flow Execution API

The Flow Execution API from Hilos — 3 operation(s) for flow execution.

Hilos Flow Execution API is one of 6 APIs that Hilos publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Flow Execution. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 26 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.hilos.io.

3 operations 3 paths 26 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.hilos.io/api/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Hilos Flow Execution API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (tokenAuth). By default, every request must be authenticated.

  • tokenAuth — Token-based authentication with required prefix "Token"

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Flow Execution 3
GET
/api/flow-execution
List Flow Executions
List Flow Execution 4 params → 200
GET
/api/flow-execution/{id}
Get Flow Execution
Get Flow Execution 1 param → 200
POST
/api/flow/{id}/run
Create a Flow Execution
Create a Flow Execution 1 param body → 201

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are FlowExecutionReadDetail (24 properties), PatchedContactEdit (21 properties), FlowExecutionEdit (21 properties), FlowExecutionList (19 properties). Each schema is shown below with its type and property counts.

PaginatedFlowExecutionListList
object
4 properties
InboundTriggerWithEnum
string
FlowExecutionTypeEnum
string
ComparisonEnum
string
FlowVersionSimpleRead
object
16 properties 5 required
FlowExecutionCreateRequestExecuteForEnum
string
ChannelTypeEnum
string
FlowExecutionContactFilterEdit
object
4 properties 3 required
ContactNote
object
5 properties 4 required
FlowExecutionEdit
object
21 properties 2 required
ChannelStatusEnum
string
ChannelProviderEnum
string
FlowExecutionStatusEnum
string
FlowExecutionExecuteForEnum
string
PatchedContactEdit
object
21 properties
UserRoleEnum
string
FlowStatusEnum
string
FlowSimpleRead
object
9 properties 4 required
SimpleUser
object
6 properties 1 required
FlowExecutionReadDetail
object
24 properties 7 required
FlowExecutionEditSourceEnum
string
FlowExecutionCreateRequest
object
3 properties 2 required
FlowExecutionExecutionTypeEnum
string
ContactTag
object
2 properties 2 required
SimpleChannel
object
8 properties 2 required
FlowExecutionList
object
19 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hilos-flow-execution-api-openapi.yml Raw ↑

Other APIs Hilos publishes across the network.

Hilos Contact API
Hilos Conversation API
Hilos Flow Execution Contact API
Hilos User API
Hilos WhatsApp API