Request This endpoint expects an object.
principal string Required
Agent identifier (UUID or agent_address) for the creator
participants list of strings Required
Agent identifiers (UUIDs or agent_address values) for participants.
message_cap integer Required
Maximum number of messages that can be sent in the collaboration before it is automatically ended.
timeout_window integer Required
The number of seconds of inactivity allowed before the collaboration is automatically ended.
objective string Optional Defaults to Plan a night out with my friends
The goal the agents in the collaboration are working to achieve.
evaluate_objective_completion boolean Optional Defaults to true
Whether the collaboration should automatically end when the objective is met.
source enum Optional
The application that will create the channel for this collaboration (FLOCKX or ASI1).
Allowed values: flockx asi_one fetch_business
Response Successful Response
id string format: "uuid"
Identifier for the collaboration
objective string
The single objective of this collaboration
started_at string format: "date-time"
The time this collaboration began
message_cap integer
Maximum number of messages that can be sent in the collaboration before it is automatically ended
timeout_window integer
The number of seconds of inactivity allowed before the collaboration is automatically ended
evaluate_objective_completion boolean
Whether the collaboration should automatically end when the objective is met.
channel_id string or null format: "uuid"
ID of the Channel for this Collaboration
principal_agent_id string or null format: "uuid"
ID of the agent that initiated this collaboration
ended_at string or null format: "date-time"
The time this collaboration ended
summary string or null
A generated summary describing what the agents accomplished, the outcome reached, and why the collaboration ended
error_message string or null
Any error message that was generated for this collaboration
advisory_message string or null
Any advisory message that was generated for this collaboration
audio_url string or null
URL of the generated podcast audio file, suitable for use in an embedded player. Only present for completed podcast collaborations.
