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

# Create a workspace

> Creates a new workspace, available to your whole team.



## OpenAPI

````yaml /api/api_docs.yaml post /workspaces
openapi: 3.1.0
info:
  title: PeakMetrics API
  description: >
    The PeakMetrics API provides programmatic access to narrative intelligence
    data.


    Access millions of mentions across news, social media, and online platforms,
    enriched with custom AI-powered

    smart categories and over 50 metadata properties. The API enables you to

    identify, analyze, and act on emerging narratives in real-time.
  version: 2.0.0
servers:
  - url: https://api.peakmetrics.com
    description: Main (production) server
security:
  - BearerAuth: []
tags:
  - name: Authorization
  - name: Workspaces
  - name: Folders
  - name: Channels
  - name: Custom Channels
  - name: Custom Enrichments
    description: >
      Custom enrichments let you push external context about mentions into
      PeakMetrics,

      attached to individual mentions and used alongside all other mention
      metadata across

      the platform. Once written, enrichment values feed into narrative
      analysis, workspace

      summaries, and notifications, and are available through the customer API
      and the MCP

      server.


      Your team manages its own custom enrichments through the API: create one
      with

      `POST /customEnrichments`, list them with `GET /customEnrichments`, rename
      one or

      replace its option list with `PUT /customEnrichments/{enrichmentId}`,
      retire one with

      `DELETE /customEnrichments/{enrichmentId}`, and push values for individual
      mentions

      with `PUT /mentions/customEnrichments`.
paths:
  /workspaces:
    post:
      tags:
        - Workspaces
      summary: Create a workspace
      description: Creates a new workspace, available to your whole team.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - title
                - query
                - channels
              properties:
                title:
                  type: string
                  description: The display name of the workspace.
                  example: Election coverage
                query:
                  type: string
                  description: The boolean keyword query used to match mentions.
                  example: ("election integrity" OR "voter fraud") AND 2026
                channels:
                  type: array
                  minItems: 1
                  items:
                    type: string
                    enum:
                      - news
                      - reddit
                      - telegram
                      - twitter
                      - youtube
                  description: One or more channels to monitor.
                  example:
                    - news
                    - twitter
                folder:
                  type: object
                  description: The folder to assign the workspace to.
                  properties:
                    id:
                      type: integer
                      description: The unique folder id.
                  example:
                    id: 12
      responses:
        '201':
          description: The newly created workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
      security:
        - BearerAuth: []
components:
  schemas:
    Workspace:
      type: object
      properties:
        id:
          type: integer
          minimum: 1
          description: The unique identifier for the workspace.
        title:
          type: string
          description: The user entered title of the workspace.
        owner:
          type: string
          description: The unique identifier of the user who owns the workspace.
        query:
          type: string
          description: The query used to match mentions to the workspace.
        channels:
          type: array
          items:
            type: string
            enum:
              - news
              - reddit
              - telegram
              - twitter
              - youtube
          description: >-
            The unique identifiers of the channels that are part of the
            workspace.
        created:
          type: string
          format: date-time
          description: The date and time the workspace was created.
        modified:
          type: string
          format: date-time
          description: The date and time the workspace was last updated.
        folder:
          type: object
          nullable: true
          properties:
            id:
              type: integer
              description: The unique folder id.
            title:
              type: string
              description: The folder title.
          description: The folder, if any, this workspace belongs to.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````