> ## Documentation Index > Fetch the complete documentation index at: https://docs.heliyos.ai/llms.txt > Use this file to discover all available pages before exploring further. # Add Scouts to a company > Starts the given workspace Scouts on one company. Watching a company already starts every active `watchlist` Scout on it; use this to add Scouts to a company that is missing some. Setup runs in the background: the response says it started, and the company Scouts appear in List a company's Scouts (`GET /v1/platform/companies/{id}/scouts`) once created. A Scout already set up on the company is not added twice. Custom Scouts cost credits on each run by `effort`. > [!NOTE] > > In the Heliyos MCP server: [`heliyos_companies_scouts_add`](https://docs.heliyos.ai/mcp/tools/scouts-and-signals#heliyos-companies-scouts-add). ## OpenAPI ````yaml /api-reference/openapi.json post /v1/platform/companies/{id}/scouts openapi: 3.0.3 info: title: Heliyos API version: 1.0.0 description: >- The REST API for Heliyos, the AI operating system for revenue. Every request is scoped to the workspace that owns the API key. Responses are JSON in a `{ meta, data }` envelope; errors use `{ message, error: { code, message, details } }`. contact: name: Heliyos support email: soham@heliyos.ai url: https://www.heliyos.ai servers: - url: https://api-prod.heliyos.ai description: Production security: - bearerAuth: [] tags: - name: Workspace description: >- The workspace your API key belongs to, and the log of credits it has used. Every other call in this API is scoped to this workspace. - name: Schemas description: >- Objects are your record types: companies, people, deal pipelines and any custom objects you add. Each object has fields, and a field's type decides what its records can hold. - name: Records description: >- Records are the rows of an object (base schema): companies, people, deals and custom objects. A record holds field values keyed by the object's field keys and links to other records. - name: Timeline description: >- The AI-written timeline of a company, person or deal: summary entries Heliyos writes on a schedule. For the exact change history see Activities, and for emails and meetings see Interactions. - name: Activities description: >- The change history of records and tasks: who created, changed or deleted what, and when. People, workers and the system each appear as the actor on the changes they make. - name: Interactions description: >- Email threads and meetings synced from connected mailboxes and calendars, linked to the people and companies they involve. - name: Notes description: >- Free-text notes, optionally linked to records, tasks and interactions. Notes show up on the timeline of every record they are linked to, and workers read them as customer memory. - name: Tasks description: >- Work items for people and workers, optionally linked to records. A task can be assigned to people, to workers, or both, and workers can be started on it directly. - name: Workers and runs description: >- Workers are the AI teammates of your workspace (the API calls them agents). Define what each one does and what starts it, ask Heliyos to do work, and follow every run, its steps and the reviews it waits on. - name: Reviews description: >- Reviews keep the team in control of consequential work. When a worker wants to send an email, change a deal, book a meeting, act in a connected app or needs a person's answer, the action waits as a review until someone approves or rejects it. - name: Scouts description: >- Scouts watch companies and the web for events such as funding rounds, product launches, leadership changes or press coverage, and record each finding as a signal. A workspace Scout defines what to look for; company Scouts are its copies running on individual companies. - name: Signals description: >- Signals are what Scouts find: one event, such as a funding round or a new executive, with a summary, its sources and the company it is about. New signals are unread until you mark them read. - name: Watchlist description: >- The watchlist is the set of companies your workers monitor. Each watched company uses one Watcher from your plan: the workers keep it enriched, pull in its emails and meetings, and run Scouts on it. - name: Knowledge base description: >- What your workers know about the business: the business context, four fixed texts (products, pain points, value proposition, qualification criteria) and any custom entries your team adds. Workers read it on their next run. Files your workers read live under Files, with kind `knowledge_base`. - name: Files description: >- Knowledge base files that workers read, and files attached to records, tasks and other resources. The API calls them attachments. Uploading takes three calls: get an upload URL, send the bytes to it, then create the file. - name: Labels description: >- Label groups that sort your email threads, for example Intent or Pricing questions. Heliyos files each classified thread under a group, and each group holds the more specific labels it brings together. The API calls them classification labels. - name: Team description: >- The people in your workspace and their roles: joined members and pending invitations. Inviting someone sends them an email. - name: Notification settings description: >- Which workspace events send notification emails, how often, and to whom. There is one settings document per workspace, shared by everyone in it. paths: /v1/platform/companies/{id}/scouts: post: tags: - Scouts summary: Add Scouts to a company description: >- Starts the given workspace Scouts on one company. Watching a company already starts every active `watchlist` Scout on it; use this to add Scouts to a company that is missing some. Setup runs in the background: the response says it started, and the company Scouts appear in List a company's Scouts (`GET /v1/platform/companies/{id}/scouts`) once created. A Scout already set up on the company is not added twice. Custom Scouts cost credits on each run by `effort`. operationId: createCompanyScouts parameters: - name: id in: path required: true schema: type: string pattern: ^[0-9a-fA-F]{24}$ description: The company record's id. example: 66f1a8c3e4b0a1b2c3d4e5f6 requestBody: required: true content: application/json: schema: type: object properties: defaultScoutIds: type: array items: $ref: '#/components/schemas/ObjectId' minItems: 1 maxItems: 50 description: > 1 to 50 workspace Scout ids. Each must be an active Scout with scope `watchlist`, built in or custom. companyData: type: object properties: {} additionalProperties: true description: > Optional company field values used to build each Scout's query (`company_name` or `name`, and `website` or `company_website`). When omitted or empty, the record's own values are used. Most callers omit it. required: - defaultScoutIds additionalProperties: false example: defaultScoutIds: - 6731c0a2b4e5f60718293a4b - 6731c0a2b4e5f60718293a4c responses: '200': description: Setup started in the background. content: application/json: schema: type: object required: - meta - data properties: meta: type: object required: - message properties: message: type: string description: A human-readable summary of the result. data: type: object properties: message: type: string description: A note that setup started. status: type: string description: '`processing`: setup continues in the background.' total_scouts: type: integer description: The number of Scout ids sent. example: meta: message: Scouts creation initiated successfully data: message: Scout creation triggered successfully status: processing total_scouts: 2 '400': description: >- VALIDATION_FAILED: `defaultScoutIds` is empty or too long, or a Scout is inactive or not scoped to the watchlist. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': description: Unauthenticated content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: >- NOT_FOUND: no record with this id in the workspace, or a `defaultScoutIds` entry is not a workspace Scout. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '429': description: Rate limited content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: schemas: ObjectId: type: string pattern: ^[0-9a-fA-F]{24}$ description: A 24-character hexadecimal id. example: 66f1a8c3e4b0a1b2c3d4e5f6 ErrorEnvelope: type: object required: - message - error properties: message: type: string description: Same as error.message. error: type: object required: - code - message properties: code: type: string enum: - VALIDATION_FAILED - UNAUTHENTICATED - FORBIDDEN_ACTION - NOT_FOUND - RATE_LIMITED - CONFLICT - INTERNAL message: type: string details: {} securitySchemes: bearerAuth: type: http scheme: bearer description: >- A workspace API key, sent as `Authorization: Bearer heliyos_...`. Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.