Create | Flockx - Your Team of AIs

Create a new channel with initial participants.

Channel creation and initial participant assignment are coupled here as a channel requires participants to be meaningful. Further participant management should use POST /channels/{id}/participants.

Authentication

Authorizationstring

API Key authentication via header

Request

This endpoint expects an object.

typeenumRequired

The type of communication used for the channel.

namestringRequired<=255 characters

The name of the channel.

participantslist of objectsRequired

Participants in the channel. Must include at least one agent and one user.

channel_typeenum or nullOptional

The type of channel.

sourceenum or nullOptional

Which application created the channel.

meta_datamap from strings to any or nullOptional

ai_name_pendingbooleanOptionalDefaults to false

Whether to generate an AI channel name from the first user message.

Response

Successful Response

idstringformat: "uuid"

The ID of the channel.

typeenum

The type of communication used for the channel.

channel_typeenum

The type of channel.

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.

agent_invocation_behaviorenum or null

Defines the response behavior of agents in channels.

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.

Errors

422

Unprocessable Entity Error

$	curl -X POST https://api.flockx.io/api/v1/channels \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"type": "websocket",
>	"name": "foo",
>	"participants": [
>	{
>	"type": "foo",
>	"user_id": "foo"
>	}
>	]
>	}'

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	}