Get a copilot

Beta

GET

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

GET

/v2/copilots/:copilot_id

1 from scoutos import Scout
2 
3 client = Scout(
4     api_key="YOUR_API_KEY",
5 )
6 client.copilots.get(
7     copilot_id="copilot_id",
8 )

Try it

200Retrieved

1 {
2   "data": {
3     "copilot_config": {
4       "workflow_id": "workflow_id",
5       "img_url": "img_url",
6       "display_name": "display_name",
7       "mode": "light",
8       "code_theme": "dark",
9       "colors": {},
10       "fab": {},
11       "loading_text": "loading_text",
12       "message_placeholder": "message_placeholder",
13       "initial_activity": [
14         null
15       ],
16       "allowed_origins": "allowed_origins"
17     },
18     "last_updated_at": "last_updated_at",
19     "created_at": "created_at",
20     "created_by": {
21       "type": "user",
22       "details": {
23         "user_id": "user_id",
24         "org_id": "org_id",
25         "scout_organization_id": "scout_organization_id",
26         "email": {}
27       }
28     },
29     "last_updated_by": {
30       "type": "user",
31       "details": {
32         "user_id": "user_id",
33         "org_id": "org_id",
34         "scout_organization_id": "scout_organization_id",
35         "email": {}
36       }
37     },
38     "revision_id": "revision_id",
39     "copilot_id": "copilot_id",
40     "is_draft": false
41   }
42 }

Fetch app configuration by ID.

Path parameters

copilot_idstringRequired

Response

Successful Response

dataobject

Get a copilot

Path parameters

Headers

Response

Errors