Khoros Conversations API
The Conversations API from Khoros — 29 operation(s) for conversations.
Operations 39
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
/{lswUuid}/conversations
List a Care author's conversation IDs for a day · Get conversation IDs by Care author and day
#
Ask an LLM
“Which conversations did a specific Care author have during one 24-hour window?”
“How do I get the conversation IDs tied to one customer author in Khoros Care?”
Tell an agent
Get the conversation IDs for Care author {author} between {start} and {end}.
List today's conversation IDs for Care author {author}.
GET
/conversations/initiative/{initiative-id}/accountset
List account sets and accounts for an initiative · Retrieve All Account Sets & Accounts Available
#
Ask an LLM
“Which account sets and social accounts can I post to inside a marketing initiative?”
“What accounts are grouped under each account set for my initiative?”
Tell an agent
Show every account set and its accounts in initiative {initiative}.
List the publishing accounts available to me in initiative {initiative}.
Ask an LLM
“How do I add a reusable text snippet to the Khoros Marketing Content Center?”
“Can a text asset be limited to certain social networks and an availability window?”
Tell an agent
Create a text asset named {name} in folder {folder} with the text {text}.
Add a text asset to folder {folder} that is available from {start} until {end}.
POST
/conversations/asset?multipart
Upload an image or video asset to the Content Center · Create Image or Video
#
Ask an LLM
“Can I upload an image or video file as a Content Center asset?”
“What do I need to upload a video asset for publishing and moderation?”
Tell an agent
Upload an image asset named {name} into Content Center folder {folder}.
Upload a video file as a Content Center asset in folder {folder} and mark it for publishing.
GET
/conversations/asset/{assetId}
Get a Content Center asset by ID · Retrieve a Content Center Asset by ID
#
Ask an LLM
“How can I see the details and content labels of one Content Center asset?”
“What does a single asset record show, including its labels?”
Tell an agent
Get Content Center asset {asset} with its content labels.
Show me the details of asset {asset}.
PUT
/conversations/asset/{assetId}
Update an existing Content Center asset · Update Existing Content Center Asset
#
Ask an LLM
“Can I rename or move an existing Content Center asset to another folder?”
“Is it possible to strip the image or video off an asset I already created?”
Tell an agent
Rename Content Center asset {asset} to {name}.
Move asset {asset} into folder {folder}.
POST
/conversations/folder
Create a Content Center asset folder · Create a New Content Asset Folder
#
Ask an LLM
“How do I make a new custom folder to organize marketing assets?”
“Can I give a new asset folder a description?”
Tell an agent
Create an asset folder called {name}.
Make a new Content Center folder {name} described as {description}.
Ask an LLM
“What asset folders exist in our Khoros Marketing Content Center?”
“Can I filter the Content Center folder list by name?”
Tell an agent
List all Content Center folders.
Find Content Center folders whose name matches {name}.
GET
/conversations/folder/{folderId}
Get a Content Center folder by ID · Retrieve a Content Asset Folder by ID
#
Ask an LLM
“How do I look up one asset folder's name and description by its ID?”
“What details come back for a single Content Center folder?”
Tell an agent
Get asset folder {folder}.
Show the name and description of Content Center folder {folder}.
PUT
/conversations/folder/{folderId}
Rename or describe a Content Center folder · Update Existing Content Center Asset Folder
#
Ask an LLM
“Can I rename an existing Content Center folder?”
“How do I change the description on an asset folder I already have?”
Tell an agent
Rename asset folder {folder} to {name}.
Update the description of Content Center folder {folder} to {description}.
DELETE
/conversations/folder/{folderId}
Delete a Content Center folder · Delete a Content Asset Folder by ID
#
Ask an LLM
“Can I delete an asset folder from the Content Center?”
“How do I get rid of a Content Center folder we no longer use?”
Tell an agent destructive · confirm first
Delete asset folder {folder}.
Remove Content Center folder {folder} permanently.
GET
/conversations/folder/{folderId}/assets
List the assets inside a folder · Retrieve a List of Assets in a Folder
#
Ask an LLM
“Which assets are stored in a particular Content Center folder?”
“Can I sort the assets in a folder ascending or descending?”
Tell an agent
List the assets in folder {folder}.
Show assets in folder {folder} ordered by {order} {direction}.
Ask an LLM
“What custom channels are set up on our marketing calendar?”
“Do we have any CustomChannels defined for non-social publishing?”
Tell an agent
List all CustomChannels.
Show every custom channel on the marketing calendar.
POST
/conversations/calendar/customChannel
Create a custom calendar channel · Create a CustomChannel
#
Ask an LLM
“How do I add a custom channel, like a newsletter, to the Khoros marketing calendar?”
“Can a new CustomChannel have a contact name and an image?”
Tell an agent
Create a CustomChannel named {name} of type {type}.
Add a custom channel {name} with contact {contact}.
GET
/conversations/calendar/customChannel/{customChannelId}
Get a custom calendar channel by ID · Get a CustomChannel based on ID
#
Ask an LLM
“How do I fetch one CustomChannel I created earlier?”
“What are the name, type and contact of a specific custom channel?”
Tell an agent
Get CustomChannel {channel}.
Show the details of custom channel {channel}.
PUT
/conversations/calendar/customChannel/{customChannelId}
Update a custom calendar channel · Update a CustomChannel
#
Ask an LLM
“Can I rename a custom channel or change its contact person?”
“How do I swap the image on an existing CustomChannel?”
Tell an agent
Rename CustomChannel {channel} to {name}.
Change the contact on custom channel {channel} to {contact}.
POST
/conversations/initiative/{initiativeId}/calendar/customChannelItem/{customChannelItemId}
Add an item to a custom channel calendar · Create a CustomChannelItem
#
Ask an LLM
“How do I put a new piece of content on a custom channel in the marketing calendar?”
“Can a new CustomChannelItem carry an image and a scheduled publish date?”
Tell an agent
Create CustomChannelItem {item} in initiative {initiative} titled {title}.
Add a new custom channel item {item} to initiative {initiative} scheduled for {date}.
PUT
/conversations/initiative/{initiativeId}/calendar/customChannelItem/{customChannelItemId}
Update a custom channel calendar item · Update a CustomChannelItem
#
Ask an LLM
“Can I reschedule an existing custom channel item to a new publish date?”
“How do I edit the title or text of a CustomChannelItem already on the calendar?”
Tell an agent
Reschedule CustomChannelItem {item} in initiative {initiative} to {date}.
Change the title of calendar item {item} in initiative {initiative} to {title}.
GET
/conversations/initiative/{initiativeId}/calendar/customChannelItem/{customChannelItemId}
Get a custom channel calendar item · Get a CustomChannelItem by ID
#
Ask an LLM
“How do I look up one scheduled item on a custom channel?”
“What title, text and publish date does a CustomChannelItem hold?”
Tell an agent
Get CustomChannelItem {item} in initiative {initiative}.
Show calendar item {item} from initiative {initiative}.
Ask an LLM
“Which social messages are published or scheduled on our marketing calendar?”
“Can I filter calendar messages by initiative, plan and date range?”
Tell an agent
List calendar messages published between {start} and {end}.
Show scheduled and posted messages for plans {plans}.
GET
/conversations/initiative
List marketing initiatives · Retrieve a List of Available Initiatives
#
Ask an LLM
“What initiatives does our company have in Khoros Marketing?”
“Can I search initiatives by name?”
Tell an agent
List all initiatives for my company.
Find initiatives named like {name}.
GET
/conversations/initiative/{initiativeId}
Get one marketing initiative · Retrieve a Single Initiative
#
Ask an LLM
“How do I see the details of a single initiative?”
“What information is stored on one marketing initiative?”
Tell an agent
Get initiative {initiative}.
Show me the details of marketing initiative {initiative}.
GET
/conversations/initiative/{initiativeId}/contentLabel
List content labels in an initiative · Retrieve Paged Labels
#
Ask an LLM
“Which content labels can I tag messages with in an initiative?”
“Can I list only the top labels, or search labels by text?”
Tell an agent
List content labels in initiative {initiative}.
Search labels in initiative {initiative} matching {text}.
POST
/conversations/initiative/{initiativeId}/message
Publish an image-set message to social · Publish a New Message (imageset)
#
Ask an LLM
“How do I publish a post with a set of images through Khoros Marketing?”
“Can I schedule an image-set message for later instead of posting now?”
Tell an agent
Publish an image-set message titled {title} to {network} in initiative {initiative}.
Schedule an image-set post in initiative {initiative} for {date}.
PUT
/conversations/initiative/{initiativeId}/message/{messageId}
Edit an existing social message · Update a Message
#
Ask an LLM
“Can I change the title or labels of a message after creating it?”
“How do I move a standard message to a different scheduled time?”
Tell an agent
Change the title of message {message} in initiative {initiative} to {title}.
Reschedule message {message} in initiative {initiative} for {date}.
GET
/conversations/initiative/{initiativeId}/message/{messageId}
Get a published or scheduled message · Retrieve an Existing Message
#
Ask an LLM
“How do I check the status and content of a message I published?”
“What publication results are stored on an existing marketing message?”
Tell an agent
Get message {message} in initiative {initiative}.
Show the status of marketing message {message} from initiative {initiative}.
DELETE
/conversations/initiative/{initiativeId}/message/{messageId}
Delete a marketing message · Delete an Existing Message
#
Ask an LLM
“Can I delete a message I scheduled by mistake?”
“How do I remove a marketing message from an initiative?”
Tell an agent destructive · confirm first
Delete message {message} from initiative {initiative}.
Remove scheduled message {message} in initiative {initiative}.
POST
/conversations/initiative/{initiativeId}/message?multipart
Publish a message with an uploaded file · Publish a New Message (multipart)
#
Ask an LLM
“How do I publish a social post and upload its media in the same multipart request?”
“Can a multipart message be saved as a draft instead of published?”
Tell an agent
Publish a multipart message with an attached file to {network} in initiative {initiative}.
Create a multipart draft message titled {title} in initiative {initiative}.
PUT
/conversations/initiative/{initiativeId}/message/{messageId}?multipart
Update a multipart message and its media · Update a Multipart Message
#
Ask an LLM
“Can I replace the uploaded file on a multipart message I already created?”
“How do I edit a multi-part message rather than a plain one?”
Tell an agent
Update multipart message {message} in initiative {initiative} with a new file.
Retitle multi-part message {message} in initiative {initiative} to {title}.
GET
/conversations/initiative/{initiativeId}/multiChannelMessage/{messageId}
Get a multi-channel message · Retrieve an Existing Multi-channel Message
#
Ask an LLM
“How do I look up a message that was published across several channels at once?”
“What does a multi-channel message record contain?”
Tell an agent
Get multi-channel message {message} in initiative {initiative}.
Show the cross-channel message {message} from initiative {initiative}.
GET
/conversations/privilege
List my permissions in the current company · Retrieve Permissions for Current User
#
Ask an LLM
“What am I allowed to do in the currently selected Khoros Marketing company?”
“Which privileges does my user have?”
Tell an agent
List my permissions in the current company.
Show the privileges granted to the current user.
GET
/conversations/initiative/{initiativeId}/plan
List plans in an initiative · Retrieve a List of Plans
#
Ask an LLM
“Which campaign plans exist under one initiative?”
“Can I search an initiative's plans by name?”
Tell an agent
List the plans in initiative {initiative}.
Find plans in initiative {initiative} named like {name}.
Ask an LLM
“What user roles are defined for our company?”
“Which role IDs can I assign when creating a user?”
Tell an agent
List the roles in my company.
Show page {page} of company roles.
GET
/conversations/users/initiative/{initiativeId}/publishers
List publishers for an initiative · List Conversations Publishers
#
Ask an LLM
“Who can publish messages in a given initiative?”
“Which users are publishers on one initiative?”
Tell an agent
List the publishers for initiative {initiative}.
Show who is allowed to publish in initiative {initiative}.
Ask an LLM
“How do I remove someone's user account from our Khoros Marketing company?”
“Can I delete a user who has left the team?”
Tell an agent destructive · confirm first
Delete user {user} from the company.
Remove company user {user}.
Ask an LLM
“How do I add a new teammate as a user with a role and workspace?”
“Can a new user be sent an invitation email with a custom message?”
Tell an agent
Create user {email} named {first} {last} with role {role} in workspace {workspace}.
Add {email} as a user and send them an invite with the message {message}.
Ask an LLM
“Who are the users in our Khoros Marketing company?”
“Can I search users by first name, last name or email?”
Tell an agent
List all users in the company.
Find users matching {search}.
POST
/conversations/initiative/{initiativeId}/video/captions
Upload captions for a video · Create a Video Captions
#
Ask an LLM
“How do I attach SRT captions to a video post?”
“What file naming does a video captions upload require?”
Tell an agent
Upload the SRT captions file {file} for a video in initiative {initiativeId}.
Create a video captions object from {file} under initiative {initiativeId}.
Ask an LLM
“What workspaces does our company have?”
“Which workspace IDs can I put a new user in?”
Tell an agent
List the workspaces in my company.
Show page {page} of company workspaces.
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