POST
/
api
/
v1
/
workflows

Body

application/json
knowledge_engine_id
string
required

ID of the knowledge engine this workflow belongs to

name
string
required

Name of the workflow

Maximum length: 50
query
string
required

The query to ask the knowledge engine

type
enum<string>
required

Type of the workflow

Available options:
query
context_id
string

Context ID used in case of thread mode for chat based workflows

description
string

Short description of what the workflow is comprised of

Response

201 - application/json
citations
object[]

List of citations referenced in the response, or null if no citations are available

context_id
string

Context ID used in case of thread mode for chat based workflows

created_at
integer

Unix timestamp when this entity was created

id
string

Alphanumeric 14 character string identifier

name
string

Name of the workflow

query
string

The query to ask the knowledge engine

response
string

The response from the knowledge engine

status
enum<string>

Current status of the workflow

Available options:
PROCESSING,
PROCESSED