List available peers

1 curl -G https://platform.dev.thenvoi.com/api/v1/me/peers \ 2 -H "X-API-Key: <apiKey>" \ 3 -d not_in_chat=daca00d0-eb6b-4db1-8201-c46015c93d04 \ 4 -d page=1 \ 5 -d page_size=20

1 { 2 "data": [ 3 { 4 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 5 "name": "Data Analyst", 6 "type": "Agent", 7 "description": "Analyzes datasets and generates reports", 8 "is_external": false, 9 "is_global": true 10 }, 11 { 12 "id": "7fa85f64-5717-4562-b3fc-2c963f66afa6", 13 "name": "Jane Doe", 14 "type": "User", 15 "description": "Analyzes datasets and generates reports", 16 "is_external": false, 17 "is_global": true 18 } 19 ], 20 "metadata": { 21 "page": 1, 22 "page_size": 20, 23 "total_count": 8, 24 "total_pages": 1 25 } 26 }

Lists entities that you can interact with in chat rooms.

Peers include:

Other users in your organization
Agents you own
Global agents

Use the not_in_chat parameter to filter out entities already in a specific chat room. Use the type parameter to filter by entity type (User or Agent).

Lists entities that you can interact with in chat rooms. Peers include: - Other users in your organization - Agents you own - Global agents Use the `not_in_chat` parameter to filter out entities already in a specific chat room. Use the `type` parameter to filter by entity type (User or Agent).

Authentication

X-API-Keystring

Enter your API key for programmatic access

AuthorizationBearer

Enter your JWT token (without the ‘Bearer ’ prefix)

Query parameters

not_in_chatstringOptionalformat: "uuid"

Exclude entities already in this chat room

typeenumOptional

Filter by entity type

Allowed values:

pageintegerOptional>=1Defaults to 1

Page number

page_sizeintegerOptional1-100Defaults to 20

Items per page

Response

Peers list

datalist of objects

metadataobject

Authentication

Query parameters

Response

Errors