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

List all copilots

Beta
GET
https://api.scoutos.com/v2/copilots
GET
/v2/copilots
$curl https://api.scoutos.com/v2/copilots \
>     -H "Authorization: Bearer <token>"
1{
2  "data": [
3    {
4      "copilot_config": {
5        "workflow_id": "wf_9a8b7c6d5e4f3g2h1i0j",
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": "#edf2ff",
13          "accent": "#ff4081"
14        },
15        "fab": {
16          "icon": "chat",
17          "size": 56
18        },
19        "loading_text": "Thinking...",
20        "message_placeholder": "Ask me anything about your projects...",
21        "initial_activity": [
22          {
23            "type": "welcome_message",
24            "content": "Hello! How can I assist you today?"
25          }
26        ],
27        "allowed_origins": "https://app.scoutos.com",
28        "powered_by": "ScoutOS AI"
29      },
30      "last_updated_at": "2024-01-15T09:30:00Z",
31      "created_at": "2023-12-01T08:15:00Z",
32      "created_by": {
33        "type": "user",
34        "details": {
35          "user_id": "user_1234567890",
36          "org_id": "org_987654321",
37          "scout_organization_id": "scout_org_001",
38          "email": {
39            "address": "jane.doe@scoutos.com",
40            "verified": true
41          }
42        }
43      },
44      "last_updated_by": {
45        "type": "user",
46        "details": {
47          "user_id": "user_1234567890",
48          "org_id": "org_987654321",
49          "scout_organization_id": "scout_org_001",
50          "email": {
51            "address": "jane.doe@scoutos.com",
52            "verified": true
53          }
54        }
55      },
56      "revision_id": "rev_20240115_0930",
57      "copilot_id": "copilot_001",
58      "is_draft": false
59    }
60  ],
61  "has_more": true,
62  "next_cursor": "2024-01-15T09:30:00Z"
63}
List all copilots in the organization
Was this page helpful?
Previous

Create a new copilot

Next
Built with

Authentication

AuthorizationBearer

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

Query parameters

sortstring or nullOptional
Field to sort by
directionstring or nullOptional
Sort in ascending or descending order
start_atstring or nullOptional

created_at to start at

limitinteger or nullOptionalDefaults to 12
Limit of records to return
querystring or nullOptional
Search query

Response

Successful Response
datalist of objects
has_moreboolean
next_cursordatetime or null

Errors

422
Unprocessable Entity Error