GET
/
blueprint-instance
/
Python (SDK)
from meibelai import Meibelai
import os


with Meibelai(
    api_key_header=os.getenv("MEIBELAI_API_KEY_HEADER", ""),
) as m_client:

    res = m_client.blueprint_instances.get_all_blueprint_instances(include_children=False, include_activities=False, include_events=False, offset=0, limit=10, sort_by="<value>", sort_order="<value>")

    # Handle response
    print(res)
{
  "data": [
    {
      "id": "<string>",
      "blueprint_id": "<string>",
      "workflow_type": "<string>",
      "task_queue": "<string>",
      "workflow_run_id": "<string>",
      "status": "created",
      "start_time": "2023-11-07T05:31:56Z",
      "end_time": "2023-11-07T05:31:56Z",
      "instance_metadata": {},
      "parent_id": "<string>",
      "children": [
        {}
      ],
      "activities": [
        {
          "id": "<string>",
          "blueprint_instance_id": "<string>",
          "activity_type": "<string>",
          "status": "pending",
          "start_time": "2023-11-07T05:31:56Z",
          "end_time": "2023-11-07T05:31:56Z",
          "input_data": {},
          "output_data": {},
          "error": "<string>",
          "group_id": "<string>"
        }
      ],
      "events": [
        {
          "id": "<string>",
          "activity_id": "<string>",
          "blueprint_instance_id": "<string>",
          "event_type": "instance_started",
          "timestamp": "2023-11-07T05:31:56Z",
          "details": {},
          "group_id": "<string>",
          "is_signal": true,
          "is_internal": true,
          "originating_signal_id": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Meibel-API-Key
string
header
required

Query Parameters

include_children
boolean
default:false
include_activities
boolean
default:false
include_events
boolean
default:false
offset
integer
default:0

Number of items to skip

Required range: x >= 0
limit
integer
default:10

Maximum number of items to return

Required range: 1 <= x <= 100
sort_by
string | null

Field to sort by

sort_order
string | null

Sort order (asc or desc)

Response

200
application/json

Successful Response

GetBlueprintInstancesResponse