datasets9

env-vars8

evaluations2

external-ids22

folders6

group1

metadata1

otlp1

prompt1

prompt-templates7

prompts1

reports11

request1

rest2

score1

skill-collections5

smart-tables21

spans1

tables22

tool-registry5

tracking8

workflow7

workflow

Run Workflow

post/workflows/{workflow_name}/run

Request

Base URL
https://docs.promptlayer.com (the document declares no server; this is the origin it was published from)
Auth
API key in header X-API-KEY
TypeScript
https://skmtc.dev/promptlayer/apis/promptlayer-api/docs/workflows/:workflow_name/run/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

workflow_namestring required

The name of the workflow to execute.

Request body

workflow_label_namestring nullable

Specify a workflow label name to run a specific labeled version.

workflow_version_numberinteger nullable

Specify a workflow version number to run a specific version.

metadataobject nullable

A dictionary of metadata key-value pairs.

input_variablesobject

A dictionary of input variables required by the workflow.

return_all_outputsboolean

If set to true, all outputs from the workflow execution will be returned.

callback_urlstring uri nullable

HTTP URL where execution results are posted asynchronously. When provided, the API returns 202 Accepted immediately.

Response

Workflow execution created successfully

successboolean required

Indicates if the request was successful.

messagestring required

A message describing the result.

warningstring nullable

Warning about missing or unused input variables, if any.

workflow_version_execution_idinteger required

The ID of the created workflow execution.

Changes

No recorded changes to this operation across all 3 revisions of this API.