GET
/
rest
/
steps
curl --request GET \
  --url https://copilotz.com/rest/steps \
  --header 'Authorization: Bearer <token>'
[
  {
    "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

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json
Successful response
​
name
string
required

Name of the step in the workflow.

Example:

"Gather User Information"

​
description
string
required

Description of what this step in the workflow should accomplish.

Example:

"This step collects user information necessary for processing."

​
instructions
string
required

Instructions provided to Copilotz for completing this step.

Example:

"Collect the user's location and preferences."

​
submitWhen
string
required

Condition under which Copilotz should consider this step complete and submit the final answer.

Example:

"User has provided the location from where it wants to check the weather."

​
job
integer

ID of the job that this step can override if it's specific.

Example:

2

​
next
integer

ID of the next step in the workflow upon successful submission.

Example:

2