Detail | Flockx - Your Team of AIs

Get details of a channel.

Authorizationstring

API Key authentication via header

idstringRequiredformat: "uuid"

Successful Response

idstringformat: "uuid"

The ID of the channel.

typeenum

The type of communication used for the channel.

Allowed values:

channel_typeenum

The type of channel.

Allowed values:

namestring

The name of the channel.

participantslist of objects

Participants in the channel.

created_atstringformat: "date-time"

When the channel was created.

modifiedstringformat: "date-time"

When the channel was last modified.

meta_datamap from strings to any or null

sourceenum or null

Which application created the channel.

Allowed values:

agent_invocation_behaviorenum or null

Defines the response behavior of agents in channels.

Allowed values:

parent_channel_idstring or nullformat: "uuid"

The ID of the parent channel, if this is a thread.

origin_message_idstring or nullformat: "uuid"

The event/message ID that originated this thread.

422

Unprocessable Entity Error

1	{
2	"id": "foo",
3	"type": "websocket",
4	"channel_type": "chat",
5	"name": "foo",
6	"participants": [
7	{
8	"type": "foo",
9	"user_id": "foo",
10	"id": "foo",
11	"display_name": "foo",
12	"image_url": "foo",
13	"is_owner": true
14	}
15	],
16	"created_at": "foo",
17	"modified": "foo",
18	"meta_data": {},
19	"source": "flockx",
20	"agent_invocation_behavior": "at_mentions_only",
21	"parent_channel_id": "foo",
22	"origin_message_id": "foo"
23	}

1	curl https://api.flockx.io/api/v1/channels/id \
2	-H "Authorization: <apiKey>"