For AI agents: visit https://developer.liveswitch.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Home
Guides
API Reference
LiveSwitch Exchange
Log In
API Reference
Search
LiveSwitch Exchange
Log In
Home
Guides
API Reference
Gets the current user
JUMP TO
Getting Started
Authentication
LiveSwitch Public API
Accounts
Retrieves a list of accounts
get
Gets an account by user ID
get
AttributeGroups
Gets a list of attribute groups
get
Creates an attribute group
post
/v1/attribute-groups/app/{appId}
get
Gets an attribute group by id
get
Updates an attribute group
put
Deletes an attribute group
del
Gets an attribute group by name
get
Attributes
Gets a list of attributes
get
Creates an attribute
post
Gets a single attribute by id
get
Updates an attribute
put
Deletes an attribute by id
del
Contacts
Creates a new contact
post
Gets a list of contacts
get
Gets a contact by id
get
Gets a contact by phone
get
Updates a contact by ID
put
Deletes a contact
del
Conversations
Creates a conversation.
post
Retrieves a list of conversations.
get
Gets a conversation by ID.
get
Creates presigned URLs for uploading images to a conversation
post
Creates presigned URLs for uploading documents to a conversation
post
Creates presigned URLs for uploading videos to a conversation
post
Updates a conversation.
put
Run a Spark on a conversation
post
Gets all Sparks by conversation ID
get
Documents
Gets a document by id.
get
Gets documents by conversation id.
get
Gets documents by project id.
get
Gets snapshots by conversation id.
get
Gets snapshots by project id.
get
Gets files by conversation id.
get
Gets files by project id.
get
EntityAttributes
Gets all the EntityAttributes for a given EntityType.
get
Create an EntityAttribute for a given Entity.
post
Allows you to get all the EntityAttributes for a specific EntityType AND Entity Instance.
get
Reads a specific EntityAttribute for a given Entity Type by ID
get
Updates a given EntityAttribute
put
Deletes an EntityAttribute
del
Forms
Gets a form by id.
get
Gets a form submission by id.
get
Guided Instructions
Gets guided instructions templates
get
Me
Gets the current user
get
Organizations
Gets your currently logged in organization settings.
get
Updates the SMS enabled setting for your currently logged in organization.
patch
Projects
Creates a project
post
Retrieves a list of projects
get
Gets a project by id
get
Updates a project
put
Creates presigned URLs for uploading images to a project
post
Creates presigned URLs for uploading documents to a project
post
Creates presigned URLs for uploading videos to a project
post
Creates a Spark on a project
post
Lists all Spark runs for a project
get
Recordings
Gets a recording by id.
get
Gets recordings by conversation id.
get
Gets recordings by project id.
get
Sparks (AI Reports)
Gets a Spark run by ID
get
Deletes a Spark run
del
Spark Templates (AI Prompts)
Gets all Spark templates for org
get
Tags
Creates a tag
post
Retrieves a list of tags
get
Updates a tag. Supports partial updates.
put
Webhooks
Creates a webhook.
post
Gets a webhook by id.
get
Gets a list of all webhooks for this organization
get
Gets a list of all webhooks for this organization and the specific app
get
Updates a webhoook
put
Deletes a webhook
del
Deletes all webhooks by app id
del
Powered by
