For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Scout DocsAccess Scout
API & SDK
API & SDK
  • Endpoints
      • GETList all copilots
      • POSTCreate a new copilot
      • GETGet a copilot
      • PUTUpdate a copilot
      • DELDelete a copilot
LogoLogo
Scout DocsAccess Scout
EndpointsCopilots

Get a copilot

Beta
GET
https://api.scoutos.com/v2/copilots/:copilot_id
GET
/v2/copilots/:copilot_id
$curl https://api.scoutos.com/v2/copilots/copilot_id \
>     -H "Authorization: Bearer <token>"
1{
2  "data": {
3    "copilot_id": "copilot-1234abcd",
4    "copilot_config": {
5      "workflow_id": "workflow-5678efgh",
6      "img_url": "https://cdn.sanity.io/images/0cfe0chk/production/632552466286c4255bff73da9eb7b76b32411771-24x24.svg",
7      "display_name": "Scout AI Assistant",
8      "mode": "light",
9      "code_theme": "dark",
10      "colors": {
11        "primary": "#0052cc",
12        "secondary": "#edf2f7",
13        "background": "#ffffff",
14        "text": "#172b4d"
15      },
16      "fab": {
17        "size": 56,
18        "icon": "chat",
19        "color": "#0052cc"
20      },
21      "loading_text": "Thinking...",
22      "message_placeholder": "Ask me anything about your project...",
23      "initial_activity": [
24        {
25          "type": "welcome_message",
26          "content": "Hello! How can I assist you today?"
27        }
28      ],
29      "powered_by": "ScoutOS AI"
30    }
31  }
32}
Fetch copilot configuration by ID.
Was this page helpful?
Previous

Update a copilot

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

copilot_idstringRequired

Response

Successful Response
dataobject

Errors

422
Unprocessable Entity Error