PromptShuttle API
  • Quickstart
  • About
  • API reference
    • Models
    • Flows
      • Parameters
      • Runs
    • Chat
      • Completions
    • Inference
    • Specification
Powered by GitBook
On this page
  1. API reference
  2. Flows

Parameters

Retrieves all configurable parameters for a given flow.

PreviousFlowsNextRuns

Last updated 10 months ago

Note that this depends on a number of variables: Version and environment can be used to resolve the active version (as described in Flows)

The entrypoint is relevant to determine which part of the subtree to inspect. It's best to look at an example. Imagine there are three templates:

  • main

  • available_types

  • similarity_matcher

// Main template: construct graph RAG knowlegde graph
You are a ...
Only use nodes of types [[available_types]]
// available_types: These are the default values when none are provided by the API
Person, Skill, Job, Degree
// similarity_matcher: Find similarity between nodes
You are a ... your job is to identify which of the following identifiers refer to
the same entity: [[nodes]]

In this example, there are two largely independent prompts, the 'main' prompt for creating a graph and the similarity_matcher. The main prompt has available_types as a parameter whereas similarity_matcher has nodes.

get
Path parameters
flowIdstringRequired
Query parameters
versionstringOptional
environmentstringOptional
entrypointstringOptional
Responses
200
OK
get
GET /api/v1/flows/{flowId}/parameters HTTP/1.1
Host: 
Accept: */*
200

OK

[
  {
    "token": "text",
    "promptTemplate": {
      "id": "text",
      "idCreated": "2025-05-22T16:14:07.792Z",
      "key": "text",
      "name": "text",
      "template": "text",
      "language": "text",
      "llm": "text"
    }
  }
]