Skip to main content
GET
/
rest
/
copilotz
List and Search
curl --request GET \
  --url https://copilotz.com/rest/copilotz \
  --header 'Authorization: Bearer <token>'
[
  {
    "name": "Your Copilotz Name",
    "description": "Your Copilotz Description",
    "backstory": "This is a simple backstory for your Copilotz. It's useful for defining its identity.",
    "actions": [
      1,
      2,
      3
    ],
    "configs": [
      1,
      2
    ],
    "job": 1
  }
]

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 Copilotz agent.

Example:

"Your Copilotz Name"

​
description
string
required

Detailed description of the Copilotz agent.

Example:

"Your Copilotz Description"

​
backstory
string
required

Backstory defining the Copilotz agent's identity.

Example:

"This is a simple backstory for your Copilotz. It's useful for defining its identity."

​
actions
integer[]

List of action IDs that the Copilotz agent is permitted to perform.

Example:
[1, 2, 3]
​
configs
integer[]

List of configuration object IDs related to this Copilotz agent.

Example:
[1, 2]
​
job
integer

ID of the job associated with this Copilotz agent.

Example:

1