POST
/
rest
/
jobs
curl --request POST \
  --url https://copilotz.com/rest/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "role": "Copilotz Developer",
  "goal": "Assist users with technical inquiries.",
  "description": "Handles all technical support tasks and user queries.",
  "actions": [
    1,
    2
  ],
  "defaultWorkflow": 1
}'
{
  "role": "Copilotz Developer",
  "goal": "Assist users with technical inquiries.",
  "description": "Handles all technical support tasks and user queries.",
  "actions": [
    1,
    2
  ],
  "defaultWorkflow": 1
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Request payload for creating or updating a job.

​
role
string
required

Role name associated with the job.

Example:

"Copilotz Developer"

​
goal
string
required

Objective or goal of the job.

Example:

"Assist users with technical inquiries."

​
description
string
required

Detailed description of the job.

Example:

"Handles all technical support tasks and user queries."

​
actions
integer[]

List of action IDs that any Copilotz with this job can perform.

Example:
[1, 2]
​
defaultWorkflow
integer

ID of the default workflow for this job.

Example:

1

Response

200 - application/json
Successful response

Response containing job details.

​
role
string
required

Role name associated with the job.

Example:

"Copilotz Developer"

​
goal
string
required

Objective or goal of the job.

Example:

"Assist users with technical inquiries."

​
description
string
required

Detailed description of the job.

Example:

"Handles all technical support tasks and user queries."

​
actions
integer[]

List of action IDs that any Copilotz with this job can perform.

Example:
[1, 2]
​
defaultWorkflow
integer

ID of the default workflow for this job.

Example:

1