Create
Create a new collaboration.
Headers
Authorization
Request
This endpoint expects an object.
principal
ID of the agent who created the collaboration
participants
List of IDs for agents to participate in the collaboration.
message_cap
Maximum number of messages that can be sent in the collaboration before it is automatically ended.
timeout_window
The number of seconds of inactivity allowed before the collaboration is automatically ended.
objective
The goal the agents in the collaboration are working to achieve.
evaluate_objective_completion
Whether the collaboration should automatically end when the objective is met.
Response
Successful Response
id
Identifier for the collaboration
objective
The single objective of this collaboration
started_at
The time this collaboration began
message_cap
Maximum number of messages that can be sent in the collaboration before it is automatically ended
timeout_window
The number of seconds of inactivity allowed before the collaboration is automatically ended
channel_id
ID of the Channel for this Collaboration
principal_agent_id
ID of the agent that initiated this collaboration
ended_at
The time this collaboration ended