Retrieve Workflow Execution Detail

Beta

GET

https://api.vellum.ai/v1/workflow-executions/:execution_id/detail

GET

/v1/workflow-executions/:execution_id/detail

1 import { VellumClient } from "vellum-ai";
2 
3 const client = new VellumClient({ apiKey: "YOUR_API_KEY", apiVersion: "YOUR_API_VERSION" });
4 await client.workflowExecutions.retrieveWorkflowExecutionDetail("execution_id");

Try it

200Retrieved

1 {
2   "span_id": "string",
3   "parent_context": {
4     "parent": {},
5     "links": [
6       {
7         "trace_id": "string",
8         "type": "TRIGGERED_BY"
9       }
10     ],
11     "workflow_definition": {
12       "name": "string",
13       "module": [
14         "string"
15       ],
16       "id": "string"
17     },
18     "type": "WORKFLOW",
19     "span_id": "string"
20   },
21   "start": "2024-01-15T09:30:00Z",
22   "end": "2024-01-15T09:30:00Z",
23   "inputs": [
24     {
25       "id": "string",
26       "name": "string",
27       "type": "STRING",
28       "value": "string"
29     }
30   ],
31   "outputs": [
32     {
33       "id": "string",
34       "name": "string",
35       "type": "STRING",
36       "value": "string"
37     }
38   ],
39   "error": {
40     "message": "string",
41     "code": "WORKFLOW_INITIALIZATION",
42     "raw_data": {},
43     "stacktrace": "string"
44   },
45   "usage_results": [
46     {
47       "usage": [
48         {
49           "ml_model_name": "string",
50           "ml_model_usage": {
51             "output_token_count": 1,
52             "input_token_count": 1,
53             "input_char_count": 1,
54             "output_char_count": 1,
55             "compute_nanos": 1,
56             "cache_creation_input_tokens": 1,
57             "cache_read_input_tokens": 1
58           }
59         }
60       ],
61       "cost": [
62         {
63           "value": 1.1,
64           "unit": "USD"
65         }
66       ],
67       "error": {
68         "code": "UNKNOWN",
69         "message": "string"
70       }
71     }
72   ],
73   "spans": [
74     {
75       "name": "workflow.execution",
76       "events": [
77         {
78           "parent": {
79             "parent": {},
80             "links": [
81               {
82                 "trace_id": "string",
83                 "type": "TRIGGERED_BY"
84               }
85             ],
86             "workflow_definition": {
87               "name": "string",
88               "module": [
89                 "string"
90               ],
91               "id": "string"
92             },
93             "type": "WORKFLOW",
94             "span_id": "string"
95           },
96           "links": [
97             {
98               "trace_id": "string",
99               "type": "TRIGGERED_BY",
100               "span_context": {
101                 "parent": {},
102                 "links": [
103                   null
104                 ],
105                 "workflow_definition": {
106                   "name": "string",
107                   "module": [
108                     "string"
109                   ],
110                   "id": "string"
111                 },
112                 "type": "WORKFLOW",
113                 "span_id": "string"
114               }
115             }
116           ],
117           "name": "workflow.execution.initiated",
118           "body": {
119             "workflow_definition": {
120               "name": "string",
121               "module": [
122                 "string"
123               ],
124               "id": "string"
125             },
126             "inputs": {}
127           },
128           "id": "string",
129           "timestamp": "2024-01-15T09:30:00Z",
130           "api_version": "2024-10-25",
131           "trace_id": "string",
132           "span_id": "string"
133         }
134       ],
135       "attributes": {
136         "label": "string",
137         "workflow_id": "string"
138       },
139       "usage_result": {
140         "usage": [
141           {
142             "ml_model_name": "string",
143             "ml_model_usage": {
144               "output_token_count": 1,
145               "input_token_count": 1,
146               "input_char_count": 1,
147               "output_char_count": 1,
148               "compute_nanos": 1,
149               "cache_creation_input_tokens": 1,
150               "cache_read_input_tokens": 1
151             }
152           }
153         ],
154         "cost": [
155           {
156             "value": 1.1,
157             "unit": "USD"
158           }
159         ]
160       },
161       "span_id": "string",
162       "start_ts": "2024-01-15T09:30:00Z",
163       "end_ts": "2024-01-15T09:30:00Z",
164       "parent_span_id": "string"
165     }
166   ],
167   "state": {}
168 }

Path parameters

execution_idstringRequiredformat: "uuid"

Query parameters

prev_span_idstringOptionalformat: "uuid"

Optional keyset cursor span_id to continue from (exclusive)

span_limitintegerOptional

Maximum number of spans to return (for lazy loading)

Response

span_idstringformat: "uuid"

parent_contextobject or null

startstringformat: "date-time"

endstring or nullformat: "date-time"

inputslist of objects

outputslist of objects

errorobject or null

usage_resultslist of objects or null

spanslist of objects

statemap from strings to any or null

Path parameters

Headers

Query parameters

Response