Detail | Flockx - Your Team of AIs

{
  "id": "foo",
  "created_at": "foo",
  "channel_id": "foo",
  "participant": {
    "type": "foo",
    "user_id": "foo"
  },
  "content": [
    {
      "type": "foo",
      "text": "foo"
    }
  ],
  "content_role": "user_message",
  "complete": true,
  "metadata": {},
  "invocation_config": {
    "planner_mode": true,
    "athena_mode": true,
    "model_name": "foo",
    "mentions": [
      {
        "type": "agent",
        "id": "foo",
        "identifier": "foo",
        "identifier_type": "handle",
        "offset": 42,
        "length": 42
      }
    ],
    "withheld_mentions": [
      {
        "type": "agent",
        "id": "foo",
        "identifier": "foo",
        "identifier_type": "handle",
        "offset": 42,
        "length": 42
      }
    ],
    "private_mention_requests": [
      {
        "twin_id": "foo",
        "outcome": "private_friend_request",
        "friendship_id": "foo",
        "channel_id": "foo",
        "owner_display_name": "foo"
      }
    ],
    "voice_mode": true,
    "voice_id": "foo",
    "enable_avatar": true,
    "character_id": "foo",
    "force_collaboration": true,
    "collaboration_participant_ids": [
      "foo"
    ],
    "activity_id": "foo",
    "feed_activity_id": "foo",
    "use_reasoning_history": true,
    "thinking": true,
    "thinking_budget": 42,
    "reasoning_effort": "low",
    "enable_web_search": true,
    "enable_study_mode": true,
    "enable_scheduled_prompt_tools": true,
    "avoid_repetition": true,
    "enable_threads": true,
    "slash_skills": [
      "foo"
    ],
    "slash_only": true,
    "supports_tool_call_upsert": true
  },
  "nested_interactions": [
    {
      "id": "foo",
      "created_at": "foo",
      "channel_id": "foo",
      "participant": {
        "type": "foo",
        "user_id": "foo"
      },
      "content": [
        {
          "type": "foo",
          "text": "foo"
        }
      ],
      "content_role": "user_message",
      "complete": true,
      "metadata": {},
      "invocation_config": {
        "planner_mode": true,
        "athena_mode": true,
        "model_name": "foo",
        "mentions": [
          {
            "type": "agent",
            "id": "foo",
            "identifier": "foo",
            "identifier_type": "handle",
            "offset": 42,
            "length": 42
          }
        ],
        "withheld_mentions": [
          {
            "type": "agent",
            "id": "foo",
            "identifier": "foo",
            "identifier_type": "handle",
            "offset": 42,
            "length": 42
          }
        ],
        "private_mention_requests": [
          {
            "twin_id": "foo",
            "outcome": "private_friend_request",
            "friendship_id": "foo",
            "channel_id": "foo",
            "owner_display_name": "foo"
          }
        ],
        "voice_mode": true,
        "voice_id": "foo",
        "enable_avatar": true,
        "character_id": "foo",
        "force_collaboration": true,
        "collaboration_participant_ids": [
          "foo"
        ],
        "activity_id": "foo",
        "feed_activity_id": "foo",
        "use_reasoning_history": true,
        "thinking": true,
        "thinking_budget": 42,
        "reasoning_effort": "low",
        "enable_web_search": true,
        "enable_study_mode": true,
        "enable_scheduled_prompt_tools": true,
        "avoid_repetition": true,
        "enable_threads": true,
        "slash_skills": [
          "foo"
        ],
        "slash_only": true,
        "supports_tool_call_upsert": true
      },
      "nested_interactions": [
        null
      ],
      "interaction_id": "foo",
      "sequence": 42,
      "span_id": "foo",
      "parent_span_id": "foo",
      "organization_id": "foo",
      "organization_application": "foo",
      "reactions": [
        {
          "interaction_id": "foo",
          "emoji": "foo",
          "count": 42,
          "reacted_by_me": true,
          "target_role": "user",
          "reacted_by_agent": false,
          "reactor_names": [
            "foo"
          ],
          "target_sender_id": "foo"
        }
      ],
      "mention_invite_prompt_dismissed": false,
      "agent_read_receipts": [
        {
          "id": "foo",
          "message_event_id": "foo",
          "interaction_id": "foo",
          "agent_id": "foo",
          "read_at": "foo"
        }
      ]
    }
  ],
  "interaction_id": "foo",
  "sequence": 42,
  "span_id": "foo",
  "parent_span_id": "foo",
  "organization_id": "foo",
  "organization_application": "foo",
  "reactions": [
    {
      "interaction_id": "foo",
      "emoji": "foo",
      "count": 42,
      "reacted_by_me": true,
      "target_role": "user",
      "reacted_by_agent": false,
      "reactor_names": [
        "foo"
      ],
      "target_sender_id": "foo"
    }
  ],
  "mention_invite_prompt_dismissed": false,
  "agent_read_receipts": [
    {
      "id": "foo",
      "message_event_id": "foo",
      "interaction_id": "foo",
      "agent_id": "foo",
      "read_at": "foo"
    }
  ]
}

Authentication

Authorizationstring

API Key authentication via header

Path parameters

interaction_idstringRequired

Response

Successful Response

idstringformat: "uuid"

The ID of the interaction.

created_atstringformat: "date-time"

The date and time the interaction was created.

channel_idstringformat: "uuid"

The ID of the channel.

participantobject

The participant that sent this interaction.

contentlist of objects

The content of the interaction.

content_roleenum

Whether the content is from a user message, intermediate agent reasoning, or final agent response.

completeboolean

Whether the interaction is complete. Incomplete interactions are only included when include_incomplete query parameter is True.

metadatamap from strings to any or nullOptional

Metadata for the interaction. Assistant agent_response messages may include display_artifacts (canonical artifact cards for this turn) and display_artifact_deletes (deleted artifact id and name pairs).

invocation_configobject or nullOptional

Typed user-driven invocation configuration for the turn (model, planner mode, voice, mentions, etc.). Null when no invocation config was set.

nested_interactionslist of objects or nullOptional

Nested interactions for this interaction. This will only be present when include_nested_interactions is True.

interaction_idstring or nullOptionalformat: "uuid"

Groups all events from a single user turn. Use this to group related messages.

sequenceinteger or nullOptional

Per-channel monotonically increasing sequence number for stable ordering. Null for messages persisted before sequencing was introduced.

span_idstring or nullOptionalformat: "uuid"

Unique identifier for this specific event in the interaction tree.

parent_span_idstring or nullOptionalformat: "uuid"

The span_id of the parent event, for hierarchical grouping.

organization_idstring or nullOptionalformat: "uuid"

The ID of the organization that owns the channel this interaction belongs to. Used for business intelligence filtering in Kibana.

organization_applicationstring or nullOptional

The application that created the organization (e.g., ‘flockx’, ‘asi_one’, ‘fetch_business’). Used for filtering interactions by product in Kibana.

reactionslist of objects or nullOptional

Emoji reaction summaries for this interaction.

mention_invite_prompt_dismissedbooleanOptionalDefaults to false

Whether the requesting user dismissed the mention-invite prompt under this message. Always false for other users’ messages and for unauthenticated reads.

agent_read_receiptslist of objects or nullOptional

Agent read receipts attached to the originating user message.

Errors

422

Unprocessable Entity Error