Add Step

POST

Create a new workflow step

Path parameters

workflow_idstringRequired

Request

This endpoint expects an object.

orderintegerRequired

agentIdstringRequired

Response

This endpoint returns an object.

successboolean

dataobjectOptional

Represents a WorkflowStep record

POST

1 curl -X POST https://api.beta.superagent.sh/api/v1/workflows/workflow_id/steps \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "order": 1,
6   "agentId": "agentId"
7 }'

200Successful

1 {
2   "success": true,
3   "data": {
4     "id": "id",
5     "order": 1,
6     "workflowId": "workflowId",
7     "workflow": {
8       "id": "id",
9       "name": "name",
10       "description": "description",
11       "createdAt": "2024-01-15T09:30:00Z",
12       "updatedAt": "2024-01-15T09:30:00Z",
13       "apiUserId": "apiUserId",
14       "apiUser": {
15         "id": "id",
16         "createdAt": "2024-01-15T09:30:00Z",
17         "updatedAt": "2024-01-15T09:30:00Z"
18       },
19       "workflowConfigs": [
20         {
21           "id": "id",
22           "createdAt": "2024-01-15T09:30:00Z",
23           "updatedAt": "2024-01-15T09:30:00Z",
24           "workflowId": "workflowId"
25         }
26       ]
27     },
28     "createdAt": "2024-01-15T09:30:00Z",
29     "updatedAt": "2024-01-15T09:30:00Z",
30     "input": "input",
31     "output": "output",
32     "agentId": "agentId",
33     "agent": {
34       "id": "id",
35       "type": "SUPERAGENT",
36       "name": "name",
37       "avatar": "avatar",
38       "initialMessage": "initialMessage",
39       "description": "description",
40       "isActive": true,
41       "createdAt": "2024-01-15T09:30:00Z",
42       "updatedAt": "2024-01-15T09:30:00Z",
43       "llms": [
44         {
45           "agentId": "agentId",
46           "llmId": "llmId",
47           "createdAt": "2024-01-15T09:30:00Z",
48           "updatedAt": "2024-01-15T09:30:00Z"
49         }
50       ],
51       "llmModel": "GPT_3_5_TURBO",
52       "prompt": "prompt",
53       "apiUserId": "apiUserId",
54       "apiUser": {
55         "id": "id",
56         "createdAt": "2024-01-15T09:30:00Z",
57         "updatedAt": "2024-01-15T09:30:00Z"
58       },
59       "datasources": [
60         {
61           "agentId": "agentId",
62           "datasourceId": "datasourceId",
63           "createdAt": "2024-01-15T09:30:00Z",
64           "updatedAt": "2024-01-15T09:30:00Z"
65         }
66       ],
67       "tools": [
68         {
69           "agentId": "agentId",
70           "toolId": "toolId",
71           "createdAt": "2024-01-15T09:30:00Z",
72           "updatedAt": "2024-01-15T09:30:00Z"
73         }
74       ],
75       "metadata": {
76         "key": "value"
77       },
78       "outputSchema": "outputSchema"
79     }
80   }
81 }

Built with

1	curl -X POST https://api.beta.superagent.sh/api/v1/workflows/workflow_id/steps \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"order": 1,
6	"agentId": "agentId"
7	}'

1	{
2	"success": true,
3	"data": {
4	"id": "id",
5	"order": 1,
6	"workflowId": "workflowId",
7	"workflow": {
8	"id": "id",
9	"name": "name",
10	"description": "description",
11	"createdAt": "2024-01-15T09:30:00Z",
12	"updatedAt": "2024-01-15T09:30:00Z",
13	"apiUserId": "apiUserId",
14	"apiUser": {
15	"id": "id",
16	"createdAt": "2024-01-15T09:30:00Z",
17	"updatedAt": "2024-01-15T09:30:00Z"
18	},
19	"workflowConfigs": [
20	{
21	"id": "id",
22	"createdAt": "2024-01-15T09:30:00Z",
23	"updatedAt": "2024-01-15T09:30:00Z",
24	"workflowId": "workflowId"
25	}
26	]
27	},
28	"createdAt": "2024-01-15T09:30:00Z",
29	"updatedAt": "2024-01-15T09:30:00Z",
30	"input": "input",
31	"output": "output",
32	"agentId": "agentId",
33	"agent": {
34	"id": "id",
35	"type": "SUPERAGENT",
36	"name": "name",
37	"avatar": "avatar",
38	"initialMessage": "initialMessage",
39	"description": "description",
40	"isActive": true,
41	"createdAt": "2024-01-15T09:30:00Z",
42	"updatedAt": "2024-01-15T09:30:00Z",
43	"llms": [
44	{
45	"agentId": "agentId",
46	"llmId": "llmId",
47	"createdAt": "2024-01-15T09:30:00Z",
48	"updatedAt": "2024-01-15T09:30:00Z"
49	}
50	],
51	"llmModel": "GPT_3_5_TURBO",
52	"prompt": "prompt",
53	"apiUserId": "apiUserId",
54	"apiUser": {
55	"id": "id",
56	"createdAt": "2024-01-15T09:30:00Z",
57	"updatedAt": "2024-01-15T09:30:00Z"
58	},
59	"datasources": [
60	{
61	"agentId": "agentId",
62	"datasourceId": "datasourceId",
63	"createdAt": "2024-01-15T09:30:00Z",
64	"updatedAt": "2024-01-15T09:30:00Z"
65	}
66	],
67	"tools": [
68	{
69	"agentId": "agentId",
70	"toolId": "toolId",
71	"createdAt": "2024-01-15T09:30:00Z",
72	"updatedAt": "2024-01-15T09:30:00Z"
73	}
74	],
75	"metadata": {
76	"key": "value"
77	},
78	"outputSchema": "outputSchema"
79	}
80	}
81	}