Run Flow

Run Deployed Flow

post

Run a flow and get the result.

Path parameters

org_idstringRequired

flow_idstringRequired

The flow ID. Learn how to get it.

Query parameters

versionintegerOptional

Version of the flow

Default: -1

verbosebooleanOptional

Return the full model

Default: true

Body

object · InputsOptional

Input parameters for the flow

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /inference/v0/run/{org_id}/{flow_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

No content

Stream Deployed Flow

post

Run a flow and get the result streamed while the flow is running.

Path parameters

org_idstringRequired

flow_idstringRequired

The flow ID. Learn how to get it.

Query parameters

versionintegerOptional

Version of the flow. -1 for the latest published version.

Default: -1

prefixbooleanOptional

Add a prefix to the output

Default: false

deltabooleanOptional

Stream deltas instead of full output

Default: true

ssebooleanOptional

Use server sent events instead of streaming response

Default: false

verbosebooleanOptional

Return the full model

Default: true

run_draftbooleanOptional

Run the draft version of the flow instead of the published one.

Default: false

Body

object · InputsOptional

Input parameters for the flow

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /inference/v0/stream/{org_id}/{flow_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

No content

Stream Deployed Flow With Sso

post

Run a flow and get the result streamed while the flow is running.

Path parameters

org_idstringRequired

The organization ID. Learn how to get it.

flow_idstringRequired

The flow ID. Learn how to get it.

Query parameters

versionintegerOptional

Version of the flow. -1 for the latest published version.

Default: -1

prefixbooleanOptional

Add a prefix to the output

Default: false

deltabooleanOptional

Stream deltas instead of full output

Default: true

ssebooleanOptional

Use server sent events instead of streaming response

Default: false

verbosebooleanOptional

Return the full model

Default: true

run_draftbooleanOptional

Run the draft version of the flow instead of the published one.

Default: false

tokenstringRequired

Token for authorization

Body

object · InputsOptional

Input parameters for the flow

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /inference/v0/sso/stream/{org_id}/{flow_id}?token=text HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

No content

Give Feedback

post

Send a feedback message for a given run.

Path parameters

flow_idstringRequired

The flow ID. Learn how to get it.

org_idstringRequired

Body

anyOptional

Input parameters: feedback, inputs, outputs

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /inference/v0/feedback/{org_id}/{flow_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": 1
}