Detail | Flockx API Documentation

1 import requests 2 3 url = "https://api.flockx.io/api/v1/interactions/interaction_id" 4 5 headers = {"Authorization": "<apiKey>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 { 2 "id": "foo", 3 "created_at": "foo", 4 "channel_id": "foo", 5 "participant": { 6 "type": "foo", 7 "user_id": "foo" 8 }, 9 "content": [ 10 { 11 "type": "foo", 12 "text": "foo" 13 } 14 ], 15 "content_role": "user_message", 16 "metadata": {}, 17 "nested_interactions": [ 18 { 19 "id": "foo", 20 "created_at": "foo", 21 "channel_id": "foo", 22 "participant": { 23 "type": "foo", 24 "user_id": "foo" 25 }, 26 "content": [ 27 { 28 "type": "foo", 29 "text": "foo" 30 } 31 ], 32 "content_role": "user_message", 33 "metadata": {}, 34 "nested_interactions": [ 35 null 36 ], 37 "interaction_id": "foo", 38 "span_id": "foo", 39 "parent_span_id": "foo" 40 } 41 ], 42 "interaction_id": "foo", 43 "span_id": "foo", 44 "parent_span_id": "foo" 45 }

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.

metadatamap from strings to any or null

Metadata for the interaction.

nested_interactionslist of objects or null

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

interaction_idstring or nullformat: "uuid"

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

span_idstring or nullformat: "uuid"

Unique identifier for this specific event in the interaction tree.

parent_span_idstring or nullformat: "uuid"

The span_id of the parent event, for hierarchical grouping.

Authentication

Path parameters

Response

Errors