Skip to content

Create a Publish Channel

Channels allow you to provide your Agent to external users through a web interface. This guide will teach you how to create and configure channels.

Creation Steps

Step 1: Access Channel Management

  1. Enter your workspace
  2. Click the "Channels" tab
  3. Click the "New Channel" button

Step 2: Fill in Channel Information

  • Name: The display name of the channel (e.g., "Customer Support Assistant")
  • Slug*: The identifier in the URL, can only use lowercase letters, numbers, and hyphens
    • Click "Auto-fill from name" to automatically generate based on the name
    • The system will check in real-time if the slug is already in use
    • ⚠️ Note: Modifying the slug will change the URL, and previously shared links will become invalid
  • Type*: Select "Web Application"

Step 3: Confirm Creation

Click "Create Channel" to complete the channel creation.

Configure Channel

After creation, you can further configure the channel:

Basic Information

In the "Basic Information" section of the "Overview" tab, you can:

  • Name: Click the "Edit" button to modify at any time
  • Slug: Can be modified, but changing it will alter the URL and invalidate previously shared links
    • The system will check in real-time if the new slug is already in use
    • We recommend choosing carefully during creation to avoid frequent modifications

Web Channel Settings

In the "Config" tab, you can configure:

  • Title: Displayed at the top of the chat interface
  • Description: Can include text, links, or email
  • Promotion Button: Display additional action buttons in the interface

OAuth Binding (Optional)

In the "OAuth" tab, you can bind OAuth providers to require users to log in before using.

Publish Channel

After configuration is complete, you need to publish for it to take effect:

  1. Click the "Publish" button
  2. In the "Confirm Publish" dialog:
    • Review the confirmation message: "Are you sure you want to publish 'Channel Name'? This will make it available to other users."
    • Enter the version number (the system will automatically suggest the next version number, e.g., automatically suggesting 1.0.1 from v1.0.0)
    • Review the configuration JSON preview to confirm the configuration content
  3. Click "Yes, Publish" to confirm

Publish Status

After publishing, in the "Publish Status" section of the "Overview" tab, you can see:

  • URL: The link users can access (e.g., http://your-slug.web.codeer.ai)
  • Version: The currently published version number (the last published version)
  • Publish Time: The time of the last publish

Share with Users

After publishing, you can:

  1. Copy the channel URL
  2. Share the URL with people who need to use it
  3. Users can open the URL and start conversing

Manage Created Channels

In the channel list, you can:

  • Edit - Modify channel name, slug, and settings
  • View Details - Check publish status and statistics
  • Republish - Need to republish after updating settings

FAQ

Can a workspace have multiple channels?

Yes. The same workspace can create multiple channels, each with independent URLs and settings.

Do I need to republish after modifying settings?

Yes. After modifying channel settings, you need to click the "Publish" button, then click "Yes, Publish" in the dialog for the new settings to take effect.

Can the slug be modified?

Yes. The slug can be modified, but after modification, the channel URL will change and previously shared links will become invalid. The system will check if the new slug is already in use during modification. We recommend choosing the slug carefully when creating the channel to avoid frequent modifications.

Can I pause a channel?

Currently, channels continue to operate after publishing. If you need to stop it, consider "unpublishing" or "deleting" the channel. After unpublishing, you can publish again; but deleting a channel cannot be undone, so please decide carefully.