Update a copilot | Scout

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

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 }

Authentication

AuthorizationBearer

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

Path parameters

copilot_idstringRequired

Request

This endpoint expects an object.

workflow_idstring or nullOptional

img_urlstring or nullOptionalDefaults to https://cdn.sanity.io/images/0cfe0chk/production/632552466286c4255bff73da9eb7b76b32411771-24x24.svg

display_namestring or nullOptionalDefaults to Copilot

modeenumOptionalDefaults to light

Allowed values:

code_themeenumOptionalDefaults to dark

Allowed values:

colorsmap from strings to stringsOptional

fabmap from strings to nullable strings or integersOptional

loading_textstring or nullOptionalDefaults to Thinking...

message_placeholderstring or nullOptionalDefaults to Ask anything...

initial_activitylist of anyOptional

allowed_originsstring or nullOptionalDefaults to

Response

Successful Response

dataobject or null

Authentication

Path parameters

Request

Response

Errors