Khoros Networks API
The Networks API from Khoros — 16 operation(s) for networks.
Operations 21
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/networks/{networktype}/ids/{networkid}
Get an author by social network ID · Get author by source network ID
#
Ask an LLM
“How do I look up a Khoros Care author from their Facebook or Instagram user ID?”
“Can I include authors whose CRM data was deleted when looking one up by network ID?”
Tell an agent
Get the author with network ID {networkid} on {networktype}.
Look up {networktype} author {networkid}, including deleted CRM data {include_deleted_crm}.
PUT
/networks/{networktype}/ids/{networkid}
Update an author by social network ID · Update author by source network ID
#
Ask an LLM
“Can I update an author record using their network ID on a single-instance network?”
“How do I edit an author found by their default-network ID?”
Tell an agent
Update the author with ID {networkid} on the default {networktype} instance.
Save changes to {networktype} author {networkid}.
GET
/networks/{networktype}/instances/{networkinstance}/ids/{networkid}
Get an author by network ID on an instance · Get author by source network ID per instance
#
Ask an LLM
“How do I find an author by network ID when we have several instances of that network?”
“Can I look up an author on one specific network instance?”
Tell an agent
Get author {networkid} on {networktype} instance {networkinstance}.
Fetch the profile for ID {networkid} in instance {networkinstance} of {networktype}, with deleted CRM {include_deleted_crm}.
PUT
/networks/{networktype}/instances/{networkinstance}/ids/{networkid}
Update an author by network ID on an instance · Update author by network ID and instance
#
Ask an LLM
“Can I update an author on a specific instance of a network?”
“How do I change author details when the network has multiple instances?”
Tell an agent
Update author {networkid} on {networktype} instance {networkinstance}.
Edit the record for user {networkid} in {networktype} instance {networkinstance}.
GET
/networks/{networktype}/handles/{networkhandle}
Find authors by social handle · Get author(s) by network handle
#
Ask an LLM
“How do I find an author by their social media handle?”
“Can one handle return more than one author?”
Tell an agent
Find authors with handle {networkhandle} on {networktype}.
Who is @{networkhandle} on {networktype}? Pull their author record.
GET
/networks/{networktype}/instances/{networkinstance}/handles/{networkhandle}
Find authors by handle on a network instance · Get author(s) by network handle and instance
#
Ask an LLM
“Can I search for an author handle within one specific network instance?”
“Which authors use a given handle on a particular instance of a network?”
Tell an agent
Find authors with handle {networkhandle} on {networktype} instance {networkinstance}.
Look up @{networkhandle} only within instance {networkinstance} of {networktype}.
GET
/networks/{networktype}/ids/{networkid}/conversations
List an author's conversation IDs by network ID · Get conversation IDs by author, network ID, and day
#
Ask an LLM
“Which conversations did an author have on a given day, looked up by network ID?”
“Is the conversation lookup by network ID limited to a 24-hour period?”
Tell an agent
List conversation IDs for {networktype} user ID {networkid} between {startEpochMillis} and {endEpochMillis}.
Show today's conversations with {networktype} user {networkid}.
GET
/networks/{networktype}/instances/{networkinstance}/ids/{networkid}/conversations
List an author's conversation IDs per instance · Get conversation IDs by author network ID, instance, and day
#
Ask an LLM
“How do I get one day of an author's conversation IDs on a specific network instance by user ID?”
“Can I pull an author's daily conversations for one instance of a network?”
Tell an agent
List conversation IDs for user ID {networkid} on {networktype} instance {networkinstance} starting {startEpochMillis}.
Show the conversations user {networkid} had that day on instance {networkinstance} of {networktype}.
GET
/networks/{networktype}/handles/{networkhandle}/conversations
List an author's conversation IDs by handle · Get conversation IDs by author network handle and network
#
Ask an LLM
“Which conversations did a social handle have with us over a day?”
“Can I get conversation IDs for an author using only their handle?”
Tell an agent
List conversation IDs for handle {networkhandle} on {networktype} from {startEpochMillis}.
Show the day's conversations with @{networkhandle} on {networktype}.
GET
/networks/{networktype}/instances/{networkinstance}/handles/{networkhandle}/conversations
List conversation IDs by handle on an instance · Get conversation IDs by author network handle and instance
#
Ask an LLM
“How do I find a handle's conversations on one particular network instance?”
“Can I pull a day of conversations for a handle on a specific instance?”
Tell an agent
List conversation IDs for handle {networkhandle} on {networktype} instance {networkinstance}.
Get @{networkhandle}'s conversations in instance {networkinstance} of {networktype} ending {endEpochMillis}.
POST
/networks/{networktype}/instances/{networkinstance}/ids/{networkid}/split
Remove Person attributes from a network ID · Remove Person attributes by network ID and instance
#
Ask an LLM
“How do I split a network identity off the Person it was merged into?”
“Can I remove Person attributes tied to one network ID on an instance?”
Tell an agent destructive · confirm first
Split network ID {networkid} on {networktype} instance {networkinstance} from its Person.
Strip the Person attributes from user {networkid} in {networktype} instance {networkinstance}.
PUT
/networks/networktype/ids/networkid/conversations/reactivate
Reactivate an author's conversations · Reactivate author conversations
#
Ask an LLM
“How do I reopen an author's conversations on the default network?”
“Can I leave a comment when reactivating an author's conversations?”
Tell an agent
Reactivate conversations for author {networkid} on {networktype}.
Reactivate {networktype} author {networkid}'s conversations with comment {comment}.
PUT
/networks/{networktype}/instances/{networkinstance}/ids/{networkId}/conversations/reactivate
Reactivate an author's conversations on an instance · Reactivate instance author conversations
#
Ask an LLM
“Can I reactivate an author's conversations on one specific network instance?”
“How do I reopen conversations for an author on a multi-instance network?”
Tell an agent
Reactivate conversations for author {networkid} on {networktype} instance {networkinstance}.
Reopen user {networkid}'s threads in instance {networkinstance} of {networktype} for page {pageId}.
GET
/networks/{networkType}/registrations
Get a bot's registration details · Get bot registration details
#
Ask an LLM
“How do I check how my bot is registered with Khoros Care?”
“What callback URL and auth type is my bot registration using?”
Tell an agent
Show the {networktype} bot registration for external ID {externalId} and app {appId}.
Look up the registration details of bot app {appId} on {networktype}, external ID {externalId}.
POST
/networks/{networkType}/registrations
Register a new bot with Khoros Care · Register bot with Khoros Care
#
Ask an LLM
“How do I register a brand-new bot so it can take conversations?”
“What does a bot need to supply when it first registers?”
Tell an agent
Register a new bot {appId} on {networktype} for external ID {externalId} at {callbackUrl}.
Create a first-time {networktype} bot registration using basic auth user {username}.
PUT
/networks/{networkType}/registrations
Register or update a bot registration · Register bot with Khoros Care or update registration
#
Ask an LLM
“Can I update my bot's callback URL or credentials on an existing registration?”
“Is there one call that registers a bot or updates it if it already exists?”
Tell an agent
Register or update bot app {appId} on {networktype} with callback {callbackUrl}.
Change the auth type for bot {externalId} on {networktype} to {authenticationType}.
Ask an LLM
“How do I unregister a bot from Khoros Care?”
“Can I remove a single bot registration by app ID?”
Tell an agent destructive · confirm first
Delete the {networktype} bot registration for app {appId} and external ID {externalId}.
Unregister bot {appId} from {networktype} under external ID {externalId}.
GET
/networks/{networkType}/allRegistrations
List bot registrations for an external ID · Get registrations by external ID
#
Ask an LLM
“Which bots are registered against one external ID?”
“Can I list every registration with just the external ID?”
Tell an agent
List all {networktype} bot registrations for external ID {externalId}.
Show every bot app registered to {externalId} on {networktype}.
PUT
/networks/{networkType}/authors/{authorId}/handoff
Hand a bot conversation to a Care agent · Hand conversation to Care agent
#
Ask an LLM
“How does my bot hand a conversation over to a human agent?”
“Can a bot escalate a customer to a live Care agent?”
Tell an agent
Hand author {authorId}'s {networktype} conversation from bot {externalId} to an agent.
Escalate customer {authorId} on {networktype} to a human, bot {externalId}.
PUT
/networks/{networkType}/authors/{authorId}/resolve
Resolve a conversation on behalf of a bot · Mark conversation resolved for bot
#
Ask an LLM
“Can my bot close out a conversation as resolved for a given author?”
“How does a registered bot mark an author's conversation done?”
Tell an agent
Resolve author {authorId}'s {networktype} conversation for bot {externalId}.
Have bot {externalId} mark the chat with {authorId} on {networktype} as finished.
GET
/networks/{networktype}/instances/{networkinstance}/ids/{authorID}
Get an author's conversation IDs for a date · Get conversation IDs by author and date
#
Ask an LLM
“Which conversation IDs belong to an author during a specific 24-hour window?”
“Is the start time required when listing an author's conversations by date?”
Tell an agent
Get conversation IDs by author ID {authorId} on {networktype} instance {networkinstance} for the 24 hours from {startEpochMillis}.
List author {authorId}'s conversations on instance {networkinstance} of {networktype} for the day starting {startEpochMillis}.
Documentation
📖
Documentation
https://developer.khoros.com/khoroscaredevdocs/docs/khoros-care-integration-overview
📖
Documentation
https://developer.khoros.com/khorosmarketingdevdocs/docs/developing-and-integrating-with-khoros-marketing
📖
Documentation
https://developer.khoros.com/khoros-flow/docs/overview-of-khoros-flow-apis