Get a copilot

Beta

GET

https://api-prod.scoutos.com/v2/copilots/:copilot_id

GET

/v2/copilots/:copilot_id

1 curl https://api-prod.scoutos.com/v2/copilots/copilot_id \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "data": {
3     "copilot_config": {
4       "workflow_id": "string",
5       "img_url": "string",
6       "display_name": "string",
7       "mode": "light",
8       "code_theme": "dark",
9       "colors": {},
10       "fab": {},
11       "loading_text": "string",
12       "message_placeholder": "string",
13       "initial_activity": [
14         null
15       ],
16       "allowed_origins": "string"
17     },
18     "last_updated_at": "2024-01-15T09:30:00Z",
19     "created_at": "2024-01-15T09:30:00Z",
20     "created_by": {
21       "type": "user",
22       "details": {
23         "api_key": {}
24       }
25     },
26     "last_updated_by": {
27       "type": "user",
28       "details": {
29         "api_key": {}
30       }
31     },
32     "revision_id": "string",
33     "copilot_id": "string",
34     "is_draft": false
35   }
36 }

Fetch app configuration by ID.

Authentication

AuthorizationBearer

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

Path parameters

copilot_idstringRequired

Response

Successful Response

dataobject

Authentication

Path parameters

Response

Errors