agents

This module is generated by gleam run -m slackline_codegen/generate. Do not edit it by hand.

Agent sessions and code channels: create, configure and render views in agent channels.

Types

AgentCommand

A slash command an agent registers in a code channel.

pub type AgentCommand {
  AgentCommand(
    name: String,
    description: option.Option(String),
    argument_hint: option.Option(String),
  )
}

Constructors

```
AgentCommand(
  name: String,
  description: option.Option(String),
  argument_hint: option.Option(String),
)
```
Arguments

name

Command name without the leading slash. 1 to 31 characters, unique in the set.

description

What the command does, shown in the composer typeahead.

argument_hint

Hint for the command’s arguments, such as [title].

AgentResource

</>

The external resource an agent session is centered on.

pub type AgentResource {
  AgentResource(
    url: option.Option(String),
    resource_type: option.Option(String),
    title: option.Option(String),
    provider: option.Option(String),
  )
}

Constructors

```
AgentResource(
  url: option.Option(String),
  resource_type: option.Option(String),
  title: option.Option(String),
  provider: option.Option(String),
)
```
Arguments

url

URL of the external resource. Maximum 2048 characters.

resource_type

Type of the external resource. Maximum 64 characters.

title

Display title of the external resource. Maximum 255 characters.

provider

Provider of the external resource. Maximum 64 characters.

AgentSessionView

</>

A view attached to a code channel.

pub type AgentSessionView {
  AgentSessionView(
    view_id: String,
    type_: option.Option(String),
    view_key: option.Option(String),
    file_id: option.Option(String),
    name: option.Option(String),
    label: option.Option(String),
    content_version: option.Option(Int),
    date_added: option.Option(Int),
  )
}

Constructors

```
AgentSessionView(
  view_id: String,
  type_: option.Option(String),
  view_key: option.Option(String),
  file_id: option.Option(String),
  name: option.Option(String),
  label: option.Option(String),
  content_version: option.Option(Int),
  date_added: option.Option(Int),
)
```
Arguments

view_id

Encoded channel tab ID.

type_

View type: html, diff, block_kit or canvas.

view_key

Agent-assigned stable key. Absent for diff views.

file_id

Encoded ID of the backing file.

name

Display label for the view tab.

label

Display label for the view tab (the name used in the response example).

content_version

Server-assigned content version.

date_added

Unix timestamp of when the view was created.

AgentStatus

</>

The status of an agent conversation or session.

pub type AgentStatus {
  Active
  Processing
  Suspended
  Closed
}

Constructors

```
Active
```
active
```
Processing
```
processing
```
Suspended
```
suspended
```
Closed
```
closed

CanvasComment

</>

A comment thread on a canvas.

pub type CanvasComment {
  CanvasComment(
    id: String,
    ts: option.Option(String),
    user_id: option.Option(String),
    text: option.Option(String),
    quoted_text: option.Option(String),
    is_resolved: option.Option(Bool),
    replies: option.Option(List(CanvasCommentReply)),
    has_more_replies: option.Option(Bool),
  )
}

Constructors

```
CanvasComment(
  id: String,
  ts: option.Option(String),
  user_id: option.Option(String),
  text: option.Option(String),
  quoted_text: option.Option(String),
  is_resolved: option.Option(Bool),
  replies: option.Option(List(CanvasCommentReply)),
  has_more_replies: option.Option(Bool),
)
```
Arguments

id

ID of the comment thread.

ts

Timestamp of the top-level comment.

user_id

User who wrote the comment.

text

Text of the comment.

quoted_text

The highlighted canvas text the comment is anchored to.

is_resolved

Whether the thread is resolved.

replies

Threaded replies, oldest first (at most the 100 most recent).

has_more_replies

Whether older replies were dropped.

CanvasCommentReply

</>

A reply in a canvas comment thread.

pub type CanvasCommentReply {
  CanvasCommentReply(
    ts: option.Option(String),
    user_id: option.Option(String),
    text: option.Option(String),
  )
}

Constructors

CanvasCommentReply(
  ts: option.Option(String),
  user_id: option.Option(String),
  text: option.Option(String),
)

Arguments

ts: Timestamp of the reply.
user_id: User who wrote the reply.
text: Text of the reply.

CodeChannelProperties

</>

Code channel properties to set with agents.conversations.setProperties. Only provided fields are updated.

pub type CodeChannelProperties {
  CodeChannelProperties(
    context_bar_items: option.Option(List(ContextBarItem)),
    summary_message: option.Option(SummaryMessage),
  )
}

Constructors

```
CodeChannelProperties(
  context_bar_items: option.Option(List(ContextBarItem)),
  summary_message: option.Option(SummaryMessage),
)
```
Arguments

context_bar_items

Items displayed in the channel context bar (max 5). The array replaces the current set.

summary_message

Records which message in the channel represents the current summary.

ContextBarItem

</>

An item in a code channel’s context bar.

pub type ContextBarItem {
  ContextBarItem(
    key: String,
    label: String,
    icon: option.Option(String),
    url: option.Option(String),
    item_type: option.Option(String),
  )
}

Constructors

```
ContextBarItem(
  key: String,
  label: String,
  icon: option.Option(String),
  url: option.Option(String),
  item_type: option.Option(String),
)
```
Arguments

key

Unique identifier for the item within the channel. Maximum 64 characters.

label

Display text. Maximum 128 characters.

icon

Icon beside the label: branch, folder, hierarchy, life-ring, link, globe, terminal, code, search or lock.

url

Makes the item a link to this URL. Maximum 2048 characters.

item_type

info (default, informational) or action (clicking delivers a code_channel_action event).

ConversationsArchive

</>

Identifies agents.conversations.archive in the slackline.Call that conversations_archive returns.

pub type ConversationsArchive

ConversationsCreate

</>

Identifies agents.conversations.create in the slackline.Call that conversations_create returns.

pub type ConversationsCreate

ConversationsCreateResponse

</>

A successful response from agents.conversations.create.

pub type ConversationsCreateResponse {
  ConversationsCreateResponse(channel_id: String)
}

Constructors

```
ConversationsCreateResponse(channel_id: String)
```
Arguments

channel_id

ID of the created (or existing, for a repeated session_id) code channel.

ConversationsGetCanvas

</>

Identifies agents.conversations.getCanvas in the slackline.Call that conversations_get_canvas returns.

pub type ConversationsGetCanvas

ConversationsGetCanvasResponse

</>

A successful response from agents.conversations.getCanvas.

pub type ConversationsGetCanvasResponse {
  ConversationsGetCanvasResponse(
    canvas_id: String,
    title: option.Option(String),
    content: option.Option(String),
    comments: option.Option(List(CanvasComment)),
    has_more_comments: option.Option(Bool),
  )
}

Constructors

ConversationsGetCanvasResponse(
  canvas_id: String,
  title: option.Option(String),
  content: option.Option(String),
  comments: option.Option(List(CanvasComment)),
  has_more_comments: option.Option(Bool),
)

Arguments

title: Title of the canvas.
content: Canvas content in the requested format (markdown).
comments: Comment threads, oldest first (at most the 100 most recent).
has_more_comments: Whether older comment threads were dropped.

ConversationsListViews

</>

Identifies agents.conversations.listViews in the slackline.Call that conversations_list_views returns.

pub type ConversationsListViews

ConversationsListViewsResponse

</>

A successful response from agents.conversations.listViews.

pub type ConversationsListViewsResponse {
  ConversationsListViewsResponse(
    views: option.Option(List(AgentSessionView)),
  )
}

Constructors

ConversationsListViewsResponse(
  views: option.Option(List(AgentSessionView)),
)

Arguments

views: All views in the channel (up to 5).

ConversationsRemoveView

</>

Identifies agents.conversations.removeView in the slackline.Call that conversations_remove_view returns.

pub type ConversationsRemoveView

ConversationsRemoveViewResponse

</>

A successful response from agents.conversations.removeView.

pub type ConversationsRemoveViewResponse {
  ConversationsRemoveViewResponse(
    channel_id: String,
    view_id: option.Option(String),
  )
}

Constructors

ConversationsRemoveViewResponse(
  channel_id: String,
  view_id: option.Option(String),
)

Arguments

view_id: ID of the removed view.

ConversationsSetCanvasContent

</>

Identifies agents.conversations.setCanvasContent in the slackline.Call that conversations_set_canvas_content returns.

pub type ConversationsSetCanvasContent

ConversationsSetCanvasContentResponse

</>

A successful response from agents.conversations.setCanvasContent.

pub type ConversationsSetCanvasContentResponse {
  ConversationsSetCanvasContentResponse(
    canvas_id: String,
    sections_changed_count: option.Option(Int),
  )
}

Constructors

ConversationsSetCanvasContentResponse(
  canvas_id: String,
  sections_changed_count: option.Option(Int),
)

Arguments

sections_changed_count: Number of canvas sections that changed.

ConversationsSetCommands

</>

Identifies agents.conversations.setCommands in the slackline.Call that conversations_set_commands returns.

pub type ConversationsSetCommands

ConversationsSetCommandsResponse

</>

A successful response from agents.conversations.setCommands.

pub type ConversationsSetCommandsResponse {
  ConversationsSetCommandsResponse(
    channel_id: String,
    command_count: option.Option(Int),
  )
}

Constructors

ConversationsSetCommandsResponse(
  channel_id: String,
  command_count: option.Option(Int),
)

Arguments

command_count: Number of commands registered.

ConversationsSetProperties

</>

Identifies agents.conversations.setProperties in the slackline.Call that conversations_set_properties returns.

pub type ConversationsSetProperties

ConversationsSetPropertiesResponse

</>

A successful response from agents.conversations.setProperties.

pub type ConversationsSetPropertiesResponse {
  ConversationsSetPropertiesResponse(
    channel_id: String,
    warning: option.Option(String),
  )
}

Constructors

ConversationsSetPropertiesResponse(
  channel_id: String,
  warning: option.Option(String),
)

Arguments

warning: Warning such as too_many_context_bar_items or action_with_url_overridden_to_info.

ConversationsSetView

</>

Identifies agents.conversations.setView in the slackline.Call that conversations_set_view returns.

pub type ConversationsSetView

ConversationsSetViewResponse

</>

A successful response from agents.conversations.setView.

pub type ConversationsSetViewResponse {
  ConversationsSetViewResponse(
    channel_id: String,
    view_id: String,
    file_id: option.Option(String),
    canvas_id: option.Option(String),
    content_version: option.Option(Int),
    type_: option.Option(String),
  )
}

Constructors

```
ConversationsSetViewResponse(
  channel_id: String,
  view_id: String,
  file_id: option.Option(String),
  canvas_id: option.Option(String),
  content_version: option.Option(Int),
  type_: option.Option(String),
)
```
Arguments

view_id

Encoded channel tab ID of the view. Use it as tab_id to link to the view.

file_id

Encoded ID of the backing file.

canvas_id

Encoded ID of the canvas, for canvas views.

content_version

Server-assigned content version, bumped on each update.

type_

View type: html, diff, block_kit or canvas.

SessionsRename

</>

Identifies agents.sessions.rename in the slackline.Call that sessions_rename returns.

pub type SessionsRename

SessionsSetStatus

</>

Identifies agents.sessions.setStatus in the slackline.Call that sessions_set_status returns.

pub type SessionsSetStatus

SessionsSetStatusResponse

</>

A successful response from agents.sessions.setStatus.

pub type SessionsSetStatusResponse {
  SessionsSetStatusResponse(
    status: option.Option(String),
    agent_status: option.Option(String),
    title: option.Option(String),
  )
}

Constructors

```
SessionsSetStatusResponse(
  status: option.Option(String),
  agent_status: option.Option(String),
  title: option.Option(String),
)
```
Arguments

status

Session-level status, derived from all agents in the session.

agent_status

The calling agent’s own status.

title

Title of the session.

SummaryMessage

</>

Which message in a code channel is the current session summary.

pub type SummaryMessage {
  SummaryMessage(
    message_ts: String,
    thread_ts: option.Option(String),
  )
}

Constructors

```
SummaryMessage(
  message_ts: String,
  thread_ts: option.Option(String),
)
```
Arguments

message_ts

Timestamp of the summary message in the code channel.

thread_ts

If the summary is a thread reply, the parent message timestamp.

ViewAccessLevel

</>

The access the channel gets to a view.

pub type ViewAccessLevel {
  WriteAccess
  CommentAccess
  ReadAccess
}

Constructors

```
WriteAccess
```
write
```
CommentAccess
```
comment
```
ReadAccess
```
read

ViewCsp

</>

Content-Security-Policy domain declarations for an html view.

pub type ViewCsp {
  ViewCsp(resource_domains: option.Option(List(String)))
}

Constructors

```
ViewCsp(resource_domains: option.Option(List(String)))
```
Arguments

resource_domains

Additional https:// origins the view loads resources from.

Values

agent_status_decoder

</>

pub fn agent_status_decoder() -> decode.Decoder(AgentStatus)

Decodes AgentStatus from a json string.

agent_status_from_string

</>

pub fn agent_status_from_string(
  string: String,
) -> Result(AgentStatus, Nil)

Parses AgentStatus from its json string.

canvas_content_format_decoder

</>

pub fn canvas_content_format_decoder() -> decode.Decoder(
  CanvasContentFormat,
)

Decodes CanvasContentFormat from a json string.

canvas_content_format_from_string

</>

pub fn canvas_content_format_from_string(
  string: String,
) -> Result(CanvasContentFormat, Nil)

Parses CanvasContentFormat from its json string.

canvas_content_format_to_json

</>

pub fn canvas_content_format_to_json(
  it: CanvasContentFormat,
) -> json.Json

Encodes CanvasContentFormat as a json string.

canvas_content_format_to_string

</>

pub fn canvas_content_format_to_string(
  it: CanvasContentFormat,
) -> String

The json string of CanvasContentFormat.

code_channel_properties_decoder

</>

pub fn code_channel_properties_decoder() -> decode.Decoder(
  CodeChannelProperties,
)

Decodes CodeChannelProperties from json.

code_channel_properties_to_json

</>

pub fn code_channel_properties_to_json(
  it: CodeChannelProperties,
) -> json.Json

Encodes CodeChannelProperties as json.

conversations_archive

</>

pub fn conversations_archive(
  channel_id channel_id: String,
) -> slackline.Call(ConversationsArchive, Nil)

agents.conversations.archive: Archives a code channel, optionally recording a summary message on the channel.

agents.ConversationsArchive identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/agents/conversations_archive.

Bot token scopes: code_channels:manage.

Documented errors: already_archived, channel_not_found, no_origin_link, not_agent_channel, not_authorized, origin_channel_not_found, origin_message_not_found, restricted_action, summary_message_not_found.

conversations_create

</>

pub fn conversations_create() -> slackline.Call(
  ConversationsCreate,
  ConversationsCreateResponse,
)

agents.conversations.create: Creates a dedicated code channel for an agent session.

agents.ConversationsCreate identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/agents/conversations_create.

Bot token scopes: code_channels:manage.

Documented errors: channel_creation_failed, channel_not_viewable, feature_disabled, invalid_agent, invalid_origin_link, invite_failed, name_or_origin_required, no_shared_workspace, open_failed, origin_channel_externally_shared, origin_channel_is_file_channel, restricted_action, user_not_enabled.

conversations_create_response_decoder

</>

pub fn conversations_create_response_decoder() -> decode.Decoder(
  ConversationsCreateResponse,
)

Decodes the response from agents.conversations.create.

conversations_get_canvas

</>

pub fn conversations_get_canvas(
  channel channel: String,
  canvas_id canvas_id: String,
) -> slackline.Call(
  ConversationsGetCanvas,
  ConversationsGetCanvasResponse,
)

agents.conversations.getCanvas: Fetches a canvas attached to an agent session channel in a single round-trip.

agents.ConversationsGetCanvas identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/agents/conversations_get_canvas.

Bot token scopes: code_channels:manage.

Rate limit tier: t3.

Documented errors: canvas_content_fetch_failed, canvas_not_found, channel_not_found, comments_fetch_failed, not_agent_channel, not_authorized.

conversations_get_canvas_response_decoder

</>

pub fn conversations_get_canvas_response_decoder() -> decode.Decoder(
  ConversationsGetCanvasResponse,
)

Decodes the response from agents.conversations.getCanvas.

conversations_list_views

</>

pub fn conversations_list_views(
  channel_id channel_id: String,
) -> slackline.Call(
  ConversationsListViews,
  ConversationsListViewsResponse,
)

agents.conversations.listViews: Lists the views currently attached to a code channel.

agents.ConversationsListViews identifies this method in slackline.Call.

Bot token scopes: code_channels:manage.

Documented errors: channel_not_found, not_agent_channel, not_authorized.

conversations_list_views_response_decoder

</>

pub fn conversations_list_views_response_decoder() -> decode.Decoder(
  ConversationsListViewsResponse,
)

Decodes the response from agents.conversations.listViews.

conversations_remove_view

</>

pub fn conversations_remove_view(
  channel_id channel_id: String,
) -> slackline.Call(
  ConversationsRemoveView,
  ConversationsRemoveViewResponse,
)

agents.conversations.removeView: Removes a view from a code channel.

agents.ConversationsRemoveView identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/agents/conversations_remove_view.

Bot token scopes: code_channels:manage.

Documented errors: channel_not_found, not_agent_channel, not_authorized, not_view_owner, view_not_found, view_remove_failed.

conversations_remove_view_response_decoder

</>

pub fn conversations_remove_view_response_decoder() -> decode.Decoder(
  ConversationsRemoveViewResponse,
)

Decodes the response from agents.conversations.removeView.

conversations_set_canvas_content

</>

pub fn conversations_set_canvas_content(
  channel channel: String,
  canvas_id canvas_id: String,
  content content: String,
) -> slackline.Call(
  ConversationsSetCanvasContent,
  ConversationsSetCanvasContentResponse,
)

agents.conversations.setCanvasContent: Replaces the full markdown content of a canvas attached to a code channel, preserving the comment threads on the sections your agent didn’t change.

agents.ConversationsSetCanvasContent identifies this method in slackline.Call.

Bot token scopes: code_channels:manage.

Rate limit tier: t3.

Documented errors: canvas_content_fetch_failed, canvas_content_update_failed, canvas_not_found, channel_not_found, content_too_large, not_agent_channel, not_authorized, too_many_sections.

conversations_set_canvas_content_response_decoder

</>

pub fn conversations_set_canvas_content_response_decoder() -> decode.Decoder(
  ConversationsSetCanvasContentResponse,
)

Decodes the response from agents.conversations.setCanvasContent.

conversations_set_commands

</>

pub fn conversations_set_commands(
  channel_id channel_id: String,
  commands commands: List(AgentCommand),
) -> slackline.Call(
  ConversationsSetCommands,
  ConversationsSetCommandsResponse,
)

agents.conversations.setCommands: Registers the set of slash commands your agent offers in a code channel.

agents.ConversationsSetCommands identifies this method in slackline.Call.

Bot token scopes: code_channels:manage.

Documented errors: agent_required, channel_not_found, colliding_with_builtin, duplicate_command, invalid_commands, no_actions_url, not_agent_channel, not_authorized, properties_update_failed, too_many_agents, too_many_commands.

conversations_set_commands_response_decoder

</>

pub fn conversations_set_commands_response_decoder() -> decode.Decoder(
  ConversationsSetCommandsResponse,
)

Decodes the response from agents.conversations.setCommands.

conversations_set_properties

</>

pub fn conversations_set_properties(
  channel_id channel_id: String,
) -> slackline.Call(
  ConversationsSetProperties,
  ConversationsSetPropertiesResponse,
)

agents.conversations.setProperties: Sets properties on a code channel: context bar items and external resource details.

agents.ConversationsSetProperties identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/agents/conversations_set_properties.

Bot token scopes: code_channels:manage.

Documented errors: channel_not_found, invalid_status, invalid_title, no_properties_provided, not_agent_channel, not_authorized.

conversations_set_properties_response_decoder

</>

pub fn conversations_set_properties_response_decoder() -> decode.Decoder(
  ConversationsSetPropertiesResponse,
)

Decodes the response from agents.conversations.setProperties.

conversations_set_view

</>

pub fn conversations_set_view(
  channel_id channel_id: String,
) -> slackline.Call(
  ConversationsSetView,
  ConversationsSetViewResponse,
)

agents.conversations.setView: Creates or updates a view in a code channel. Views can render HTML, diffs, Block Kit, or canvases as tabs alongside the conversation.

agents.ConversationsSetView identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/agents/conversations_set_view.

Bot token scopes: code_channels:manage.

Documented errors: canvas_not_found, channel_not_found, content_too_large, invalid_blocks, invalid_csp_domain, invalid_view_type, missing_required_arg, not_agent_channel, not_authorized, not_view_owner, too_many_views, view_creation_failed.

conversations_set_view_response_decoder

</>

pub fn conversations_set_view_response_decoder() -> decode.Decoder(
  ConversationsSetViewResponse,
)

Decodes the response from agents.conversations.setView.

sessions_rename

</>

pub fn sessions_rename(
  title title: String,
) -> slackline.Call(SessionsRename, SessionsRenameResponse)

agents.sessions.rename: Rename an agent session.

agents.SessionsRename identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/agents/sessions_rename.

Bot token scopes: chat:write.

Rate limit tier: t3.

Documented errors: channel_not_found, feature_disabled, invalid_name, is_archived, name_taken, not_authorized, session_not_found, thread_ts_not_allowed, thread_ts_required.

sessions_rename_response_decoder

</>

pub fn sessions_rename_response_decoder() -> decode.Decoder(
  SessionsRenameResponse,
)

Decodes the response from agents.sessions.rename.

sessions_set_status

</>

pub fn sessions_set_status(
  status status: AgentStatus,
) -> slackline.Call(SessionsSetStatus, SessionsSetStatusResponse)

agents.sessions.setStatus: Set an agent session’s lifecycle status, creating the session if needed.

agents.SessionsSetStatus identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/agents/sessions_set_status.

Bot token scopes: chat:write.

Rate limit tier: t3.

Documented errors: channel_not_found, feature_disabled, invalid_status, not_authorized, thread_ts_not_allowed, thread_ts_required, user_not_found.

sessions_set_status_response_decoder

</>

pub fn sessions_set_status_response_decoder() -> decode.Decoder(
  SessionsSetStatusResponse,
)

Decodes the response from agents.sessions.setStatus.

summary_message_decoder

</>

pub fn summary_message_decoder() -> decode.Decoder(SummaryMessage)

Decodes SummaryMessage from json.

summary_message_to_json

</>

pub fn summary_message_to_json(it: SummaryMessage) -> json.Json

Encodes SummaryMessage as json.

view_access_level_decoder

</>

pub fn view_access_level_decoder() -> decode.Decoder(
  ViewAccessLevel,
)

Decodes ViewAccessLevel from a json string.

view_access_level_from_string

</>

pub fn view_access_level_from_string(
  string: String,
) -> Result(ViewAccessLevel, Nil)

Parses ViewAccessLevel from its json string.

view_access_level_to_json

</>

pub fn view_access_level_to_json(
  it: ViewAccessLevel,
) -> json.Json

Encodes ViewAccessLevel as a json string.

view_access_level_to_string

</>

pub fn view_access_level_to_string(it: ViewAccessLevel) -> String

The json string of ViewAccessLevel.

view_csp_decoder

</>

pub fn view_csp_decoder() -> decode.Decoder(ViewCsp)

Decodes ViewCsp from json.

view_csp_to_json

</>

pub fn view_csp_to_json(it: ViewCsp) -> json.Json

Encodes ViewCsp as json.