Parameters

Retrieves all configurable parameters for a given flow.

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/api/v1/flows/{flowId}/parameters

Path parameters

flowId*string

Query parameters

Response

200

OK

Body

text/plainapplication/jsontext/json

tokennullable string

promptTemplatePromptTemplate (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/flows/{flowId}/parameters', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "token": "text",
    "promptTemplate": {
      "id": "text",
      "idCreated": "2024-11-21T10:03:59.965Z",
      "key": "text",
      "name": "text",
      "template": "text",
      "language": "text",
      "llm": "text"
    }
  }
]