List Workflow Deployment Executions

Beta

GET

https://api.vellum.ai/v1/workflow-deployments/:id/execution-events

GET

/v1/workflow-deployments/:id/execution-events

1 from vellum import Vellum
2 
3 client = Vellum(
4     api_version="YOUR_API_VERSION",
5     api_key="YOUR_API_KEY",
6 )
7 client.workflow_deployments.list_workflow_deployment_event_executions(
8     id="id",
9 )

Try it

200Retrieved

1 {
2   "count": 1,
3   "results": [
4     {
5       "span_id": "string",
6       "parent_context": {
7         "type": "WORKFLOW_RELEASE_TAG",
8         "span_id": "string",
9         "deployment_id": "string",
10         "deployment_name": "string",
11         "deployment_history_item_id": "string",
12         "release_tag_id": "string",
13         "release_tag_name": "string",
14         "workflow_version_id": "string",
15         "parent": {},
16         "links": [
17           {
18             "trace_id": "string",
19             "type": "TRIGGERED_BY"
20           }
21         ],
22         "external_id": "string",
23         "metadata": {}
24       },
25       "start": "2024-01-15T09:30:00Z",
26       "end": "2024-01-15T09:30:00Z",
27       "inputs": [
28         {
29           "id": "string",
30           "name": "string",
31           "type": "STRING",
32           "value": "string"
33         }
34       ],
35       "outputs": [
36         {
37           "id": "string",
38           "name": "string",
39           "type": "STRING",
40           "value": "string"
41         }
42       ],
43       "error": {
44         "message": "string",
45         "code": "WORKFLOW_INITIALIZATION",
46         "raw_data": {},
47         "stacktrace": "string"
48       },
49       "latest_actual": {
50         "output": {
51           "id": "string",
52           "name": "string",
53           "type": "STRING",
54           "value": "string"
55         },
56         "timestamp": "2024-01-15T09:30:00Z",
57         "metadata": {},
58         "quality": 1.1
59       },
60       "metric_results": [
61         {
62           "outputs": [
63             {
64               "id": "string",
65               "name": "string",
66               "type": "STRING",
67               "value": "string"
68             }
69           ],
70           "label": "string",
71           "metric_id": "string"
72         }
73       ],
74       "usage_results": [
75         {
76           "usage": [
77             {
78               "ml_model_name": "string",
79               "ml_model_usage": {
80                 "output_token_count": 1,
81                 "input_token_count": 1,
82                 "input_char_count": 1,
83                 "output_char_count": 1,
84                 "compute_nanos": 1,
85                 "cache_creation_input_tokens": 1,
86                 "cache_read_input_tokens": 1
87               }
88             }
89           ],
90           "cost": [
91             {
92               "value": 1.1,
93               "unit": "USD"
94             }
95           ],
96           "error": {
97             "code": "UNKNOWN",
98             "message": "string"
99           }
100         }
101       ]
102     }
103   ]
104 }

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

idstringRequiredformat: "uuid"

Query parameters

filtersstringOptional

limitintegerOptional

Number of executions to return per page.

offsetintegerOptional

The initial index from which to return the executions.

orderingstringOptional

Response

countinteger

resultslist of objects

Authentication

Path parameters

Headers

Query parameters

Response