Get Expanded Design - Crego APIs

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

id

string

required

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

Schema defining the configuration of a flow with stages, graph, and metadata.

id

string <uuid>

Design ID

read-onlyrequired

Globally unique identifier for the design.

Example:

123e4567-e89b-12d3-a456-426614174000

flow_id

string <uuid>

Flow ID

required

Globally unique identifier for the specific instance of the flow.

Example:

123e4567-e89b-12d3-a456-426614174001

secret_id

string <uuid>

required

is_current

boolean

Is Current

required

Indicates if this design is the currently active one.

Examples:

truefalse

graph

object

Flow Graph

required

Graph structure defining the nodes and edges of the flow.

nodes

array[object (Base Node) {5}]

Nodes

required

List of nodes in the graph. Each node must be a non-empty string.

Examples:

node1node2node3

edges

$ref(#/definitions/4291925)[]

Edges

optional

Connections between nodes in the graph. Each edge must be a non-empty string.

Examples:

edge1edge2edge3

start_node

string

Start Node

required

Default starting node in the graph.

Example:

node1

store_schema

object

Schema Reference

required

Reference to the schema definition for the flow.

Additional properties

integer | number | string | boolean

optional

created_at

string <date-time>

Created At

read-onlyrequired

ISO 8601 timestamp when the design was created.

Example:

2024-11-27T00:00:00Z

updated_at

string <date-time> | null

Updated At

read-onlyoptional

ISO 8601 timestamp when the design was last updated.

Example:

2024-11-27T01:00:00Z

updated_by

string | null

Updated By

optional

The identifier of the user who updated the edge. Must be 5-20 characters, allowing alphanumeric, dots, underscores, and dashes.

Match pattern:

"^[a-zA-Z0-9._-]{3,50}$"

created_by

string

Created By

required

The identifier of the user who created the edge. Must be 5-20 characters, allowing alphanumeric, dots, underscores, and dashes.

Match pattern:

^[a-zA-Z0-9._-]{3,50}$

Example

{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "flow_id": "123e4567-e89b-12d3-a456-426614174001",
    "secret_id": "9e739c43-5a0b-4293-91b3-7c10894ec3f4",
    "is_current": true,
    "graph": {
        "nodes": "node1",
        "edges": "edge1",
        "start_node": "node1"
    },
    "store_schema": {},
    "created_at": "2024-11-27T00:00:00Z",
    "updated_at": "2024-11-27T01:00:00Z",
    "updated_by": "string",
    "created_by": "string"
}