API ReferenceCollaborations

Create

Create a new collaboration.

Request

This endpoint expects an object.
leaderstringRequiredformat: "uuid"

ID of the agent who created the collaboration

participantslist of stringsRequired

List of IDs for agents to participate in the collaboration.

message_capintegerRequired

Maximum number of messages that can be sent in the collaboration before it is automatically ended.

timeout_windowintegerRequired

The number of seconds of inactivity allowed before the collaboration is automatically ended.

objectivestringOptionalDefaults to Plan a night out with my friends

The goal the agents in the collaboration are working to achieve.

evaluate_objective_completionbooleanOptionalDefaults to true

Whether the collaboration should automatically end when the objective is met.

Response

Successful Response

idstringformat: "uuid"

Identifier for the collaboration

objectivestring

The single objective of this collaboration

started_atstringformat: "date-time"

The time this collaboration began

message_capinteger

maximum number of messages that can be sent in the collaboration before it is automatically ended

timeout_windowinteger

The number of seconds of inactivity allowed before the collaboration is automatically ended

participantslist of objects
messageslist of objects
ended_atstringOptionalformat: "date-time"

The time this collaboration ended

channel_idstringOptionalformat: "uuid"

ID of the Channel for this Collaboration