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

# Create a conversation

> Creates a new web conversation bound to a chosen agent and returns its identifiers
so the client can navigate to the new thread and begin sending messages. Scoped to
the caller's workspace; the agent_id must belong to the caller's workspace
(otherwise 404). The caller is added as the conversation owner. Returns 402 if the
workspace is out of credits, since the first turn would be refused.



## OpenAPI

````yaml POST /v1/api/conversations
openapi: 3.1.0
info:
  title: HQ API
  description: >-
    Public HTTP API for HQ. Authenticate with a Personal Access Token
    (`Authorization: Bearer hq_pat_...`) for server-side integrations, or an
    OAuth 2.1 authorization-code + PKCE flow for browser apps acting on a user's
    behalf. Both grant from the same resource:action scope vocabulary; an
    endpoint's required scope is listed under its `security`.
  license:
    name: Apache-2.0
    identifier: Apache-2.0
  version: 1.0.0
servers:
  - url: https://api.hq.zone
    description: HQ API (production)
security: []
tags:
  - name: me
    description: The signed-in user's own account
  - name: conversations
    description: Conversations and their messages
  - name: documents
    description: The content-addressed documents library
  - name: schedules
    description: Scheduled prompts and recurring tasks
  - name: agents
    description: Agents, their skills and integrations
  - name: memory
    description: What the assistant remembers (L5 governance)
  - name: tokens
    description: Personal Access Token management
  - name: billing
    description: Usage and billing
  - name: notifications
    description: In-app notification center
  - name: admin
    description: Workspace administration
  - name: integrations
    description: Workspace integrations (Slack, MCP, skills)
  - name: onboarding
    description: New-workspace onboarding wizard
  - name: auth
    description: Sign-in, sessions, and OAuth
paths:
  /v1/api/conversations:
    post:
      tags:
        - conversations
      summary: Create a conversation
      description: >-
        Creates a new web conversation bound to a chosen agent and returns its
        identifiers

        so the client can navigate to the new thread and begin sending messages.
        Scoped to

        the caller's workspace; the agent_id must belong to the caller's
        workspace

        (otherwise 404). The caller is added as the conversation owner. Returns
        402 if the

        workspace is out of credits, since the first turn would be refused.
      operationId: create_conversation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConvReq'
        required: true
      responses:
        '200':
          description: New web conversation created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConvResp'
        '402':
          description: Workspace out of credits
        '404':
          description: Agent not in tenant
      security:
        - bearer_pat:
            - conversations:write
        - oauth2:
            - conversations:write
components:
  schemas:
    CreateConvReq:
      type: object
      required:
        - agent_id
      properties:
        agent_id:
          type: string
          format: uuid
          description: |-
            The agent the user picked in the modal. Tenant-scoped: we
            refuse to create against an agent_id that doesn't live in
            the caller's workspace.
    CreateConvResp:
      type: object
      required:
        - id
        - channel_kind
        - channel_thread
        - adapter_conv_id
        - agent_id
      properties:
        adapter_conv_id:
          type: string
        agent_id:
          type: string
          format: uuid
        channel_kind:
          type: string
        channel_thread:
          type: string
        id:
          type: string
          format: uuid
  securitySchemes:
    bearer_pat:
      type: http
      scheme: bearer
      bearerFormat: hq_pat
      description: 'Personal Access Token. Send as `Authorization: Bearer hq_pat_...`.'
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hq.zone/v1/oauth/authorize
          tokenUrl: https://api.hq.zone/v1/oauth/token
          refreshUrl: https://api.hq.zone/v1/oauth/token
          scopes:
            admin: Administer the workspace (users, settings, integrations)
            agents:read: View the agents in your workspace
            agents:write: Create and configure agents
            billing:read: View usage and billing information
            conversations:read: Read your conversations and their messages
            conversations:write: Start conversations and send messages on your behalf
            documents:read: Read your documents library
            documents:write: Upload and manage documents in your library
            memory:read: Read what the assistant remembers about you
            memory:write: Correct or delete what the assistant remembers
            schedules:read: View your scheduled tasks
            schedules:write: Create and manage scheduled tasks
            tables:read: Read your tables and their rows
            tables:write: Create tables and add, edit, or delete rows

````