> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scoutos.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Available Scout Skills: scout and scout-workflow Pack

> Explore the two official Scout Skills: the scout skill for platform API access and scout-workflow for running and managing workflow automations.

Scout ships two official, production-ready Skills in the [`scoutos/scout-skills`](https://github.com/scoutos/scout-skills) repository. The `scout` Skill covers Scout's core data and platform APIs, while `scout-workflow` covers workflow execution and management. Install both with a single command and your agents immediately gain access to the full Scout platform.

## Install the Official Skill Pack

Install both Skills from GitHub using the Scout Skills CLI:

```bash theme={null}
npx skills add scoutos/scout-skills
```

Then set your API key so the Skills can authenticate with the Scout API:

```bash theme={null}
export SCOUT_API_KEY="your-api-key-here"
```

Get your API key from [Scout Studio](https://app.scoutos.com) → **Settings** → **API Keys**. Both Skills read `SCOUT_API_KEY` automatically as a Bearer token — no additional configuration required.

***

## The `scout` Skill

Use the `scout` Skill when your task involves data operations in Scout: reading and writing databases, managing documents, uploading files, or monitoring usage.

### Capabilities

| Feature       | Description                                                                           |
| ------------- | ------------------------------------------------------------------------------------- |
| **Databases** | Create, list, update, and delete top-level data containers                            |
| **Tables**    | Manage structured data with custom schemas (text, number, select, datetime, and more) |
| **Documents** | Full CRUD on table records with bulk insert support                                   |
| **Agents**    | List agents and invoke them programmatically                                          |
| **Drive**     | Upload and download files to Scout storage                                            |
| **Syncs**     | Sync data from external sources including websites, Notion, Google Drive, and more    |
| **Usage**     | Query API usage metrics and quotas for your organization                              |

### Sync Sources

The `scout` Skill can configure data syncs from a wide range of external sources:

| Source          | Archetype ID                | Best for                                               |
| --------------- | --------------------------- | ------------------------------------------------------ |
| Website Crawler | `com.scoutos.website`       | General documentation sites and public content         |
| Sitemap         | `com.scoutos.sitemap`       | Sites with a comprehensive `sitemap.xml`               |
| Crawl           | `com.scoutos.crawl`         | Multi-page crawls across linked pages                  |
| Page Crawl      | `com.scoutos.page_crawl`    | Single-page content extraction                         |
| Notion          | `com.notion.notion`         | Internal wikis, pages, and databases                   |
| Google Drive    | `com.google.drive`          | Google Docs and Drive folders                          |
| Microsoft 365   | `com.microsoft.365`         | SharePoint and OneDrive                                |
| Laserfiche      | `com.laserfiche.repository` | Laserfiche document repositories                       |
| Guided Crawl    | `com.scoutos.guided_crawl`  | Sites requiring login or complex JavaScript navigation |

### Example Prompts

When an agent has the `scout` Skill enabled, you can ask it:

* "List all my databases and their tables."
* "Search the knowledge base for documents about API design."
* "Create a new table called Tasks with columns for title, status, and due date."
* "Upload this PDF to Drive and make it searchable."
* "Set up a sync from our Notion docs to the knowledge base database."
* "Show me API usage for this month."

### API Examples

<CodeGroup>
  ```bash List Databases theme={null}
  curl -H "Authorization: Bearer $SCOUT_API_KEY" \
    "https://api.scoutos.com/v2/collections"
  ```

  ```bash Create Documents (Bulk) theme={null}
  curl -X POST \
    -H "Authorization: Bearer $SCOUT_API_KEY" \
    -H "Content-Type: application/json" \
    -d '[
      {"title": "Task 1", "completed": false},
      {"title": "Task 2", "completed": true}
    ]' \
    "https://api.scoutos.com/v2/collections/{col_id}/tables/{tbl_id}/documents"
  ```

  ```bash Configure a Website Sync theme={null}
  curl -X POST \
    -H "Authorization: Bearer $SCOUT_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "sync_config": {
        "source_settings": {
          "source_archetype_id": "com.scoutos.website",
          "start_urls": ["https://docs.example.com"],
          "max_depth": 3,
          "max_page_count": 100
        },
        "destination": {
          "destination_type": "collections.v2",
          "collection_id": "col_abc123",
          "table_id": "tbl_xyz789"
        }
      }
    }' \
    "https://api.scoutos.com/v2/syncs"
  ```

  ```bash Upload a File to Drive theme={null}
  curl -X POST \
    -H "Authorization: Bearer $SCOUT_API_KEY" \
    -F "files=@report.pdf" \
    "https://api.scoutos.com/drive/upload"
  ```
</CodeGroup>

***

## The `scout-workflow` Skill

Use the `scout-workflow` Skill when your task involves creating, running, or deploying Scout workflows. This Skill handles everything from triggering a single run to streaming long-running workflow output in real time.

### Capabilities

| Feature                   | Description                                                                  |
| ------------------------- | ---------------------------------------------------------------------------- |
| **Workflow execution**    | Trigger runs via `POST /v2/workflows/{workflow_id}/execute`                  |
| **Streaming runs**        | Consume real-time streaming output for long-running jobs                     |
| **Revisions**             | Create runs against specific workflow revisions and inspect revision history |
| **SDK support**           | Python and TypeScript patterns for programmatic workflow execution           |
| **CLI workflows as code** | Local run and deployment via `scout workflows` commands                      |

### Execution Environments

The `scout-workflow` Skill supports four execution environments:

| Environment   | Use case                         |
| ------------- | -------------------------------- |
| `production`  | Live production runs (default)   |
| `staging`     | Pre-production testing           |
| `development` | Active development and iteration |
| `console`     | Interactive console testing      |

### Example Prompts

When an agent has the `scout-workflow` Skill enabled, you can ask it:

* "Run workflow `wf_abc123` with these inputs."
* "Execute the lead-enrichment workflow in staging with this contact payload."
* "Stream workflow output so I can monitor progress in real time."
* "List all revisions for workflow `wf_abc123` and tell me what changed."
* "Deploy this workflow definition using the Scout CLI."

### API Example

<CodeGroup>
  ```bash Execute a Workflow theme={null}
  curl -X POST "https://api.scoutos.com/v2/workflows/wf_abc123/execute?environment=production" \
    -H "Authorization: Bearer $SCOUT_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "inputs": {
        "user_message": "Generate a weekly summary"
      },
      "streaming": false
    }'
  ```

  ```bash Execute with Streaming theme={null}
  curl -X POST "https://api.scoutos.com/v2/workflows/wf_abc123/execute?environment=production" \
    -H "Authorization: Bearer $SCOUT_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "inputs": {
        "user_message": "Analyze this dataset and produce a full report"
      },
      "streaming": true
    }'
  ```
</CodeGroup>

***

## Using Both Skills Together

An agent can have both Skills active at the same time. It automatically routes to the right Skill based on the task. For example:

| Prompt                                                            | Skill used                    |
| ----------------------------------------------------------------- | ----------------------------- |
| "List all documents in the `customers` database."                 | `scout`                       |
| "Run the `onboarding-workflow` for this new user."                | `scout-workflow`              |
| "Upload this file to Drive, then trigger the ingestion workflow." | `scout` then `scout-workflow` |
| "Search the knowledge base and summarize the top results."        | `scout`                       |
| "Stream the `report-generator` workflow output."                  | `scout-workflow`              |

***

## Additional Resources

<CardGroup cols={2}>
  <Card title="Scout Skills on GitHub" icon="github" href="https://github.com/scoutos/scout-skills">
    Browse the full source for both official Skills, including complete SKILL.md files and tool definitions.
  </Card>

  <Card title="API Reference" icon="book" href="https://ref.scoutos.com/api-sdk">
    Full reference for all Scout API endpoints used by the official Skills.
  </Card>

  <Card title="Creating Custom Skills" icon="plus" href="/skills/creating-skills">
    Build a Skill for any API or service your agents need.
  </Card>

  <Card title="Skills Overview" icon="stars" href="/skills/overview">
    Learn how Skills work and why they make agents more reliable.
  </Card>
</CardGroup>