> ## 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.

# Deliver an artifact to a channel

> Pushes one of a conversation's delivered artifacts into a Slack channel the
HQ bot belongs to. Used from the Studio when a file the agent produced in a
web conversation needs to reach Slack (the automatic reply-to-source mirror
only fires for Slack-born turns). The file is uploaded to Slack natively and
posted as the conversation's agent with a "Shared from Studio by <user>"
note. Scoped to the caller's workspace and a conversation they can see;
returns 400 when there is no live Slack install or HQ is not in the channel.



## OpenAPI

````yaml POST /v1/api/artifacts/{id}/deliver
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/artifacts/{id}/deliver:
    post:
      tags:
        - conversations
      summary: Deliver an artifact to a channel
      description: >-
        Pushes one of a conversation's delivered artifacts into a Slack channel
        the

        HQ bot belongs to. Used from the Studio when a file the agent produced
        in a

        web conversation needs to reach Slack (the automatic reply-to-source
        mirror

        only fires for Slack-born turns). The file is uploaded to Slack natively
        and

        posted as the conversation's agent with a "Shared from Studio by <user>"

        note. Scoped to the caller's workspace and a conversation they can see;

        returns 400 when there is no live Slack install or HQ is not in the
        channel.
      operationId: deliver_artifact
      parameters:
        - name: id
          in: path
          description: Artifact id to deliver
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliverArtifactReq'
        required: true
      responses:
        '200':
          description: Delivered to the channel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliverArtifactResp'
        '400':
          description: >-
            No live Slack install, HQ not in the channel, or artifact not
            deliverable
        '404':
          description: Artifact not found or not visible to the caller
      security:
        - bearer_pat:
            - conversations:read
        - oauth2:
            - conversations:read
components:
  schemas:
    DeliverArtifactReq:
      type: object
      required:
        - target
      properties:
        target:
          $ref: '#/components/schemas/DeliverTarget'
    DeliverArtifactResp:
      type: object
      required:
        - provider
        - channel_id
        - permalink
      properties:
        channel_id:
          type: string
          description: The channel the file landed in.
        permalink:
          type: string
          description: >-
            Slack permalink to the uploaded file (unfurls into the file
            preview).
        provider:
          type: string
          description: Delivery provider that handled it (`slack`).
        ts:
          type:
            - string
            - 'null'
          description: |-
            `ts` of the `chat.postMessage` that delivered the file, when Slack
            returned one.
    DeliverTarget:
      oneOf:
        - type: object
          description: >-
            Post the artifact into a Slack channel the HQ bot is a member of.
            The

            `channel_id` is a Slack `C…`/`G…` id from `GET
            /v1/api/slack/channels`.
          required:
            - channel_id
            - kind
          properties:
            channel_id:
              type: string
            kind:
              type: string
              enum:
                - slack_channel
      description: >-
        Where to deliver an artifact. A tagged union so the same endpoint can
        grow a

        `teams_channel` arm later without a breaking change (the channel picker
        + the

        `DeliveredRef`-shaped response already generalize).
  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

````