Skip to content
TriedDocs
Conversation flows

Get flow component

Retrieve a library component and the flows that use it.

GEThttps://api.tried.com.au/get-conversation-flow-component/{component_id}

Returns a library component, with linked_conversation_flow_ids: the flows whose latest version has a component node pointing at it.

Request#

Path parameters#

Parameter Type Required Description
component_id string Yes The component.

Example request#

curl "https://api.tried.com.au/get-conversation-flow-component/component_8a9b0c1d2e3f4a5b6c7d8e9f" \
  -H "Authorization: Bearer $TRIED_API_KEY"
const res = await fetch("https://api.tried.com.au/get-conversation-flow-component/component_8a9b0c1d2e3f4a5b6c7d8e9f", {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const data = await res.json();
import os, requests

res = requests.get(
    "https://api.tried.com.au/get-conversation-flow-component/component_8a9b0c1d2e3f4a5b6c7d8e9f",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
data = res.json()

Response#

200 OK

{
  "component_id": "component_8a9b0c1d2e3f4a5b6c7d8e9f",
  "name": "Collect callback number",
  "start_node_id": "node_ask",
  "nodes": [],
  "version": 3,
  "last_modification_timestamp": 1792310400000,
  "linked_conversation_flow_ids": ["conversation_flow_2c3d4e5f6a7b8c9d0e1f2a3b"]
}

Errors#

Status When
401 Missing or invalid API key.
403 The key's IP allowlist or scopes reject the request. This route needs the agents scope.
404 The component does not exist.
429 Rate limit exceeded. See Rate limits.

See Errors for the body format.