Run Flow

Get Run From Id

get

Gets the logged metadata of a run.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
org_idstringRequired
flow_idstringRequired

The flow ID. Learn how to get it.

Query parameters
run_idstringOptional

Run ID of the flow

Responses
200

Successful Response

application/json
get
/inference/v0/run/{org_id}/{flow_id}/metadata
GET /inference/v0/run/{org_id}/{flow_id}/metadata HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Run Deployed Flow

post

Run a flow and get the result.

Authorizations
OAuth2passwordRequired
Token URL:
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

Input parameters for the flow

Other propertiesanyOptional
Responses
200

Successful Response

application/json
Responseany
post
/inference/v0/run/{org_id}/{flow_id}
POST /inference/v0/run/{org_id}/{flow_id} HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
No content

Stream Deployed Flow

post

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

Authorizations
OAuth2passwordRequired
Token URL:
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

Input parameters for the flow

Other propertiesanyOptional
Responses
200

Successful Response

application/json
Responseany
post
/inference/v0/stream/{org_id}/{flow_id}
POST /inference/v0/stream/{org_id}/{flow_id} HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
No content

Stream Deployed Flow With Sso

post

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

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
org_idstringRequired
flow_idstringRequired
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

Input parameters for the flow

Other propertiesanyOptional
Responses
200

Successful Response

application/json
Responseany
post
/inference/v0/sso/stream/{org_id}/{flow_id}
POST /inference/v0/sso/stream/{org_id}/{flow_id} HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
No content

Give Feedback

post

Send a feedback message for a given run.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
flow_idstringRequired

The flow ID. Learn how to get it.

org_idstringRequired
Body

Input parameters: feedback, inputs, outputs

run_idstringRequired
feedbackstringRequired
Responses
200

Successful Response

application/json
post
/inference/v0/feedback/{org_id}/{flow_id}
POST /inference/v0/feedback/{org_id}/{flow_id} HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "run_id": "text",
  "feedback": "text"
}
{
  "ANY_ADDITIONAL_PROPERTY": 1
}
PreviousToolsNextConversations

Last updated

Was this helpful?