API Documentation
Hooks
Step
Create
POST
/
rest
/
steps
Copy
curl --request POST \
--url https://copilotz.com/rest/steps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Gather User Information",
"description": "This step collects user information necessary for processing.",
"instructions": "Collect the user'\''s location and preferences.",
"submitWhen": "User has provided the location from where it wants to check the weather.",
"job": 2,
"next": 2
}'
Copy
{
"name": "Gather User Information",
"description": "This step collects user information necessary for processing.",
"instructions": "Collect the user's location and preferences.",
"submitWhen": "User has provided the location from where it wants to check the weather.",
"job": 2,
"next": 2
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Request payload for creating or updating a step in a workflow.
Response
200 - application/json
Successful response
Response containing step details in a workflow.
Copy
curl --request POST \
--url https://copilotz.com/rest/steps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Gather User Information",
"description": "This step collects user information necessary for processing.",
"instructions": "Collect the user'\''s location and preferences.",
"submitWhen": "User has provided the location from where it wants to check the weather.",
"job": 2,
"next": 2
}'
Copy
{
"name": "Gather User Information",
"description": "This step collects user information necessary for processing.",
"instructions": "Collect the user's location and preferences.",
"submitWhen": "User has provided the location from where it wants to check the weather.",
"job": 2,
"next": 2
}
Assistant
Responses are generated using AI and may contain mistakes.