How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Relevance AI

Relevance AI Chat API

The chat API from Relevance AI — 161 operation(s) for chat.

Documentation Provider Profile APIs.io OpenAPI GitHub

Relevance AI Chat API is one of 32 APIs that Relevance AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Chat. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 171 operations across 161 paths, and defines 283 schemas. It is described by OpenAPI 3.2.0, at version latest.

Requests are made against a single base URL, /latest.

171 operations 161 paths 283 schemas 3 DELETE59 GET5 PATCH103 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
latest
Base URL
https://api-{region}.stack.tryrelevance.com/latest
Authentication
API Key
Contact
dev@tryrelevance.com
Resource Areas
1

Authentication & Security 1

Relevance AI Chat API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (AuthorizationHeader). By default, every request must be authenticated.

  • AuthorizationHeader — Authorization credentials. Header authorization should be in the form of: project:apikey

Paths & Operations 171

Across 161 paths, the API surfaces 171 operations — 3 DELETE, 59 GET, 5 PATCH, 103 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Chat 171
GET
/phone-numbers
ListProjectPhoneNumbers
ListProjectPhoneNumbers 1 param → 200
POST
/agents/clone
CloneAgent
CloneAgent body → 200
POST
/agents/clone_marketplace_template
CloneAgentMarketplaceTemplate
CloneAgentMarketplaceTemplate body → 200
POST
/agents/upsert
UpsertAgent
UpsertAgent body → 200
POST
/agents/upsert_preset
UpsertPresetAgent
UpsertPresetAgent body → 200
POST
/agents/list
ListAgents
ListAgents body → 200
POST
/agents/list-my-agents
ListMyAgents
ListMyAgents body → 200
GET
/agents/{agent_id}/get
GetAgent
GetAgent 2 params → 200
POST
/agents/tools/list
ListAgentsToolsView
ListAgentsToolsView body → 200
POST
/agents/{agent_id}/tools/list
GetAgentsTools
GetAgentsTools 1 param body → 200
POST
/agents/{agent_id}/dependency-versions/metadata/list
ListAgentDependencyVersionMetadata
ListAgentDependencyVersionMetadata 1 param body → 200
POST
/agents/trigger
TriggerAgent
TriggerAgent body → 200
POST
/agents/bulk_trigger
BulkTriggerAgents
BulkTriggerAgents body → 200
POST
/agents/get_embed_key
GetEmbedKeyForAgent
GetEmbedKeyForAgent body → 200
POST
/agents/{agent_id}/delete
DeleteAgent
DeleteAgent 1 param body → 200
POST
/agents/{agent_id}/suggest_replies
SuggestReplies
SuggestReplies 1 param body → 200
GET
/agents/prompt_models/list
ListAgentPromptModels
ListAgentPromptModels → 200
GET
/agents/models/list
ListModels
ListModels 1 param → 200
GET
/agents/models/stt/list
ListSTTModels
ListSTTModels → 200
GET
/agents/models/tts/list
ListTTSModels
ListTTSModels → 200
POST
/agents/{agent_id}/scheduled_triggers_group/upsert
UpsertAgentScheduledTriggersGroup
UpsertAgentScheduledTriggersGroup 1 param body → 200
POST
/agents/{agent_id}/scheduled_triggers_item/create
CreateAgentScheduledTriggersItem
CreateAgentScheduledTriggersItem 1 param body → 200
POST
/trigger/recurring/callback
TriggerRecurring
TriggerRecurring body → 200
POST
/agents/{agent_id}/scheduled_triggers_item/cancel
CancelAgentScheduledTriggerItem
CancelAgentScheduledTriggerItem 1 param body → 200
POST
/agents/{agent_id}/generate_requirements
GenerateAgentRequirements
GenerateAgentRequirements 1 param body → 200
POST
/agents/aggregate_tagged_conversations
AggregateTaggedAgentConversations
AggregateTaggedAgentConversations body → 200
POST
/agents/list_custom_metadata
ListAgentsCustomMetadata
ListAgentsCustomMetadata body → 200
POST
/agents/generate_params_schema
GenerateAgentParamsSchema
GenerateAgentParamsSchema body → 200
GET
/agents/conversations/list
ListConversations
ListConversations 12 params → 200
GET
/agents/tasks/match-groups/{hash}/conversations
ListMatchGroupConversations
ListMatchGroupConversations 3 params → 200
GET
/agents/tasks/match-group-conversations
ListConversationsForMatchGroup
ListConversationsForMatchGroup 3 params → 200
GET
/agents/tasks/groups
ListTaskGroups
ListTaskGroups 5 params → 200
GET
/agents/tasks/groups/tasks
ListTasksForGroup
ListTasksForGroup 7 params → 200
GET
/agents/conversations/export
ExportConversations
ExportConversations 11 params → 200
GET
/agents/conversations/latest_update_datetime
LatestConversationUpdateDatetime
LatestConversationUpdateDatetime 1 param → 200
GET
/agents/conversations/studios/list
ListConversationStudiosHistory
ListConversationStudiosHistory 4 params → 200
POST
/agents/{agent_id}/cancel
CancelAgent
CancelAgent 1 param body → 200
POST
/agents/{agent_id}/submit-message-feedback
SubmitMessageFeedback
SubmitMessageFeedback 1 param body → 200
POST
/agents/analytics
GetAgentAnalytics
GetAgentAnalytics body → 200
POST
/agents/{agent_id}/batch-schedule-agent-tasks
BatchScheduleAgentTasks
BatchScheduleAgentTasks 1 param body → 200
POST
/agents/{agent_id}/batch-schedule-agent-tasks/create
CreateBatchScheduleAgentTasks
CreateBatchScheduleAgentTasks 1 param body → 200
POST
/agents/{agent_id}/batch-schedule-agent-tasks/cancel
CancelBatchScheduleAgentTasksGroup
CancelBatchScheduleAgentTasksGroup 1 param body → 200
POST
/agents/{agent_id}/batch-schedule-agent-tasks/pause
PauseBatchScheduleAgentTasksGroup
PauseBatchScheduleAgentTasksGroup 1 param body → 200
POST
/agents/{agent_id}/batch-schedule-agent-tasks/resume
ResumeBatchScheduleAgentTasksGroup
ResumeBatchScheduleAgentTasksGroup 1 param body → 200
POST
/agents/{agent_id}/tasks/{knowledge_set}/view
ListAgentTaskView
ListAgentTaskView 2 params body → 200
GET
/agents/{agent_id}/tasks/{knowledge_set}/trigger_message
GetAgentTaskViewTriggerMessage
GetAgentTaskViewTriggerMessage 2 params → 200
POST
/agents/recallai/desktop-sdk-upload
CreateRecallAiDesktopSdkUpload
CreateRecallAiDesktopSdkUpload body → 200
POST
/agents/view/list
ListAgentsView
ListAgentsView body → 200
GET
/agents/count
CountAgents
CountAgents → 200
POST
/agents/conversations/bulk/approve
BulkApproveConversations
BulkApproveConversations body → 200
POST
/agents/conversations/bulk/reject
BulkRejectConversations
BulkRejectConversations body → 200
POST
/agents/conversations/bulk/respond
BulkRespondConversations
BulkRespondConversations body → 200
POST
/agents/conversations/bulk/rerun
BulkRerunConversations
BulkRerunConversations body → 200
GET
/agents/versions/{version_id}/get
GetAgentVersion
GetAgentVersion 1 param → 200
POST
/agents/versions/list
ListAgentVersions
ListAgentVersions body → 200
POST
/agents/versions/upsert
UpsertAgentVersion
UpsertAgentVersion body → 200
POST
/agents/versions/restore
RestoreAgentVersion
RestoreAgentVersion body → 200
POST
/agents/versions/draft
SaveAgentAsDraft
SaveAgentAsDraft body → 200
POST
/agents/versions/publish
PublishAgent
PublishAgent body → 200
POST
/agents/{agent_id}/generate-card-artwork
GenerateAgentCardArtwork
GenerateAgentCardArtwork 1 param body → 200
GET
/agents/{agent_id}/pre-publish-checks
ListPrePublishChecks
ListPrePublishChecks 4 params → 200
POST
/folders/upsert
UpsertFolder
UpsertFolder body → 200
DELETE
/folders/{folder_id}/delete
DeleteFolder
DeleteFolder 1 param body → 200
POST
/agents/meeting/connection-details
GetMeetingAgentConnectionDetails
GetMeetingAgentConnectionDetails body → 200
POST
/mcp/list
ListRemoteMcpServerTools
ListRemoteMcpServerTools body → 200
POST
/agents/tasks/{knowledge_set}/messages/{document_id}/generate
GenerateAgentMessage
GenerateAgentMessage 2 params body → 200
PATCH
/agents/tasks/{knowledge_set}/messages/{document_id}/generate
ApplyGeneratedAgentMessage
ApplyGeneratedAgentMessage 2 params body → 200
GET
/agents/{agent_id}/tasks/{knowledge_set}/metadata
GetAgentConversationMetadata
GetAgentConversationMetadata 3 params → 200
POST
/mas/{mas_id}/scratchpad/options
ListMasScratchpadOptions
ListMasScratchpadOptions 1 param body → 200
GET
/workforce/items/{document_id}
GetWorkforce
GetWorkforce 4 params → 200
POST
/workforce/items/{document_id}
SaveWorkforce
SaveWorkforce 1 param body → 200
DELETE
/workforce/items/{document_id}
DeleteWorkforce
DeleteWorkforce 1 param body → 200
GET
/workforce/items/public/{document_id}
GetPublicWorkforce
GetPublicWorkforce 2 params → 200
POST
/workforce/duplicate
DuplicateWorkforce
DuplicateWorkforce body → 200
POST
/workforce/list
ListWorkforces
ListWorkforces 4 params body → 200
POST
/workforce/trigger
TriggerWorkforce
TriggerWorkforce body → 200
POST
/workforce/rerun
RerunWorkforceFromEvent
RerunWorkforceFromEvent body → 200
POST
/workforce/tasks/list
ListWorkforceTasks
ListWorkforceTasks body → 200
POST
/workforce/items/{workforce_id}/tasks/{task_id}/messages
ListWorkforceTaskMessages
ListWorkforceTaskMessages 2 params body → 200
PATCH
/workforce/items/{workforce_id}/tasks/{task_id}/state
UpdateWorkforceTaskState
UpdateWorkforceTaskState 2 params body → 200
PATCH
/workforce/items/{workforce_id}/tasks/{task_id}/title
UpdateWorkforceTaskTitle
UpdateWorkforceTaskTitle 2 params body → 200
POST
/workforce/tasks/delete
DeleteWorkforceTasks
DeleteWorkforceTasks body → 200
POST
/workforce/versions/list
ListWorkforceVersions
ListWorkforceVersions body → 200
POST
/workforce/versions/upsert
UpsertWorkforceVersion
UpsertWorkforceVersion body → 200
POST
/workforce/versions/restore
RestoreWorkforceVersion
RestoreWorkforceVersion body → 200
POST
/workforce/clone
CloneWorkforce
CloneWorkforce body → 200
POST
/workforce/set_entities_public
SetEntitiesInWorkforcePublic
SetEntitiesInWorkforcePublic body → 200
POST
/workforce/{workforce_id}/scratchpad/options
ListWorkforceScratchpadOptions
ListWorkforceScratchpadOptions 1 param body → 200
GET
/workforce/tasks/{task_id}/metadata
GetWorkforceConversationMetadata
GetWorkforceConversationMetadata 2 params → 200
GET
/workforce/{workforce_id}/streaming-token/{workforce_task_id}
GetWorkforceStreamingToken
GetWorkforceStreamingToken 2 params → 200
POST
/workforce/node/test
TestWorkforceNode
TestWorkforceNode body → 200
POST
/workforce/get_embed_key
GetEmbedKeyForWorkforce
GetEmbedKeyForWorkforce body → 200
GET
/workforce/count
CountWorkforces
CountWorkforces → 200
POST
/sync/template
UpsertSyncTemplate
UpsertSyncTemplate body → 200
GET
/triggers/{trigger_group_id}/summary
GetTriggerGroupSummary
GetTriggerGroupSummary 1 param → 200
POST
/agents/{agent_id}/triggers/summaries
ListAgentTriggerGroupsSummaries
ListAgentTriggerGroupsSummaries 1 param body → 200
POST
/triggers/summaries
ListTriggerGroupsSummaries
ListTriggerGroupsSummaries body → 200
POST
/agents/{agent_id}/active_triggers/overview
ListAgentActiveTriggerGroupsOverview
ListAgentActiveTriggerGroupsOverview 1 param body → 200
POST
/triggers/active/overview
GetActiveTriggerGroupsOverview
GetActiveTriggerGroupsOverview body → 200
POST
/trigger/items/view
ListTriggerItemsView
ListTriggerItemsView body → 200
POST
/triggers/update_status
UpdateTriggerGroupStatus
UpdateTriggerGroupStatus body → 200
POST
/triggers/bulk_cancel
BulkCancelUpcomingSyncItems
BulkCancelUpcomingSyncItems body → 200
POST
/sync-items/collections/{collection_id}/bulk/update_status
BulkUpdateSyncItemsStatus
BulkUpdateSyncItemsStatus 1 param body → 200
POST
/batch-schedule-tasks/create
CreateBatchScheduleTasks
CreateBatchScheduleTasks body → 200
POST
/trigger/pull/test
PullTestTriggerData
PullTestTriggerData body → 200
GET
/chats/agents
ListAgentsForChat
ListAgentsForChat 4 params → 200
GET
/chats/settings
GetUsersChatSettings
GetUsersChatSettings → 200
POST
/chats/settings
UpdateUsersChatSettings
UpdateUsersChatSettings body → 200
GET
/chats/project-settings
GetProjectChatSettings
GetProjectChatSettings → 200
POST
/chats/project-settings
UpdateProjectChatSettings
UpdateProjectChatSettings body → 200
GET
/chats/settings/configurable-tool-permissions
ListConfigurableToolPermissions
ListConfigurableToolPermissions → 200
GET
/chats/settings/available-options
GetChatSettingsAvailableOptions
GetChatSettingsAvailableOptions 5 params → 200
POST
/chats/missing-inputs
GetWorkforceChatMissingInputs
GetWorkforceChatMissingInputs body → 200
POST
/chats/prerequisites
GetWorkforceChatPrerequisites
GetWorkforceChatPrerequisites body → 200
POST
/chats/trigger
TriggerWorkforceChat
TriggerWorkforceChat body → 200
GET
/chats/{workforce_task_id}/get
GetWorkforceChat
GetWorkforceChat 2 params → 200
GET
/chats
ListWorkforceChats
ListWorkforceChats 5 params → 200
POST
/chats/update
UpdateWorkforceChat
UpdateWorkforceChat body → 200
POST
/chats/delete
DeleteWorkforceChat
DeleteWorkforceChat body → 200
GET
/chats/{task_id}/credit-usage
GetWorkforceChatCredits
GetWorkforceChatCredits 1 param → 200
GET
/preset_agents
ListPresetAgents
ListPresetAgents 4 params → 200
GET
/beta/chat/super-agent/tasks
BetaGetSuperAgentChatTasks
BetaGetSuperAgentChatTasks 2 params → 200
GET
/beta/chat/super-agent/files
BetaGetSuperAgentChatFiles
BetaGetSuperAgentChatFiles 2 params → 200
POST
/saved_prompts
CreateSavedPrompt
CreateSavedPrompt body → 200
GET
/saved_prompts
ListSavedPrompts
ListSavedPrompts 2 params → 200
POST
/saved_prompts/{saved_prompt_id}/update
UpdateSavedPrompt
UpdateSavedPrompt 1 param body → 200
POST
/saved_prompts/{saved_prompt_id}/delete
DeleteSavedPrompt
DeleteSavedPrompt 1 param body → 200
POST
/slide_show
CreateSlideshow
CreateSlideshow body → 200
GET
/slide_show
ListUsersSlideshows
ListUsersSlideshows 2 params → 200
GET
/chats/{task_id}/slide_show
GetChatSlideShow
GetChatSlideShow 2 params → 200
GET
/slide_show/{slideshow_id}
GetSlideshow
GetSlideshow 1 param → 200
PATCH
/slide_show/{slideshow_id}/visibility
UpdateSlideShowVisibility
UpdateSlideShowVisibility 1 param body → 200
PATCH
/slide_show_template/{slideshow_template_id}
UpdateSlideshowTemplate
UpdateSlideshowTemplate 1 param body → 200
DELETE
/slide_show_template/{slideshow_template_id}
DeleteSlideshowTemplate
DeleteSlideshowTemplate 1 param body → 200
POST
/slide_show/{slideshow_id}/export
ExportSlideShow
ExportSlideShow 1 param body → 200
POST
/slide_show/{slideshow_id}/reorder
ReorderSlides
ReorderSlides 1 param body → 200
POST
/slide_show_template
CreateSlideshowTemplate
CreateSlideshowTemplate body → 200
GET
/slide_show_template
ListSlideshowTemplates
ListSlideshowTemplates → 200
POST
/slide_show/{slideshow_id}/screenshot
TakeSlideScreenshot
TakeSlideScreenshot 1 param body → 200
GET
/slide_show_template/{slideshow_template_id}/content
GetSlideshowTemplateContent
GetSlideshowTemplateContent 1 param → 200
GET
/slide_show/{slideshow_id}/versions
ListSlideshowVersions
ListSlideshowVersions 1 param → 200
GET
/slide_show/{slideshow_id}/versions/{version_id}
GetSlideshowVersion
GetSlideshowVersion 2 params → 200
POST
/slide_show/{slideshow_id}/versions/{version_id}/restore
RestoreSlideshowVersion
RestoreSlideshowVersion 2 params body → 200
GET
/oembed
GetOEmbed
GetOEmbed 4 params → 200
GET
/slide/{slideshow_id}/chats
GetSlideChats
GetSlideChats 3 params → 200
POST
/csp_report
LogCspViolation
LogCspViolation body → 200
GET
/conversations/{conversation_id}/files/list
ListConversationFiles
ListConversationFiles 1 param → 200
POST
/conversations/{conversation_id}/files/create
CreateConversationFile
CreateConversationFile 1 param body → 200
GET
/conversations/{conversation_id}/files/{file_id}/get_upload_url
GetConversationFileTemporaryUploadUrl
GetConversationFileTemporaryUploadUrl 2 params → 200
GET
/tasks/{workforce_task_id}/files/{file_id}/get_download_url
GetWorkforceTaskFileTemporaryDownloadUrl
GetWorkforceTaskFileTemporaryDownloadUrl 2 params → 200
GET
/tasks/{workforce_task_id}/files/{file_id}/contents
GetWorkforceTaskFileContents
GetWorkforceTaskFileContents 2 params → 200
PUT
/tasks/{workforce_task_id}/files/{file_id}/contents
UpdateWorkforceTaskFileContents
UpdateWorkforceTaskFileContents 2 params body → 200
POST
/files
InitiateFileUpload
InitiateFileUpload body → 200
POST
/files/{file_id}/confirm
ConfirmFileUpload
ConfirmFileUpload 1 param body → 200
GET
/voice/token
GetVoiceToken
GetVoiceToken → 200
GET
/fs/volumes
FsDiscoverVolumes
FsDiscoverVolumes 1 param → 200
GET
/fs/list
FsListDirectory
FsListDirectory 3 params → 200
GET
/fs/download-url
FsGetDownloadUrl
FsGetDownloadUrl 3 params → 200
GET
/fs/metadata
FsGetMetadata
FsGetMetadata 2 params → 200
POST
/fs/upload-url
FsGetUploadUrl
FsGetUploadUrl body → 200
POST
/fs/mkdir
FsMkdir
FsMkdir body → 200
POST
/fs/move
FsMove
FsMove body → 200
GET
/fs/versions
FsListVersions
FsListVersions 4 params → 200
POST
/fs/restore-version
FsRestoreVersion
FsRestoreVersion body → 200
POST
/fs/delete
FsDelete
FsDelete body → 200
GET
/fs/streaming-token
FsGetStreamingToken
FsGetStreamingToken 1 param → 200
POST
/skills/create
CreateSkill
CreateSkill body → 200
POST
/skills/update
UpdateSkill
UpdateSkill body → 200
POST
/skills/delete
DeleteSkill
DeleteSkill body → 200
GET
/skills/read
ReadSkill
ReadSkill 3 params → 200
GET
/skills/list
ListSkills
ListSkills 1 param → 200

Schemas 283

The contract defines 283 schemas that model the data the API accepts and returns. The most detailed are UpsertAgentInput (81 properties), SaveAgentAsDraftInput (80 properties), UpdateWorkforceTaskTitleOutput (21 properties), UpdateWorkforceTaskStateOutput (21 properties). Each schema is shown below with its type and property counts.

ListWorkforceTasksOutput
object
2 properties 1 required
ListSavedPromptsOutput
object
2 properties 1 required
BulkApproveConversationsInput
object
3 properties 2 required
CreateSlideshowOutput
object
1 property 1 required
FsGetUploadUrlInput
object
4 properties 2 required
BatchScheduleAgentTasksInput
object
5 properties 2 required
ListSlideshowVersionsOutput
object
1 property 1 required
TestWorkforceNodeOutput
object
1 property 1 required
GenerateAgentRequirementsOutput
object
1 property 1 required
FsGetDownloadUrlOutput
object
2 properties 2 required
TriggerWorkforceChatOutput
object
4 properties 3 required
ListRemoteMcpServerToolsInput
object
5 properties
FsGetUploadUrlOutput
object
2 properties 2 required
DeleteFolderOutput
object
DeleteWorkforceInput
FsRestoreVersionOutput
object
1 property 1 required
UpdateTriggerGroupStatusInput
object
2 properties
CancelBatchScheduleAgentTasksGroupOutput
object
TakeSlideScreenshotInput
object
1 property 1 required
ListAgentsForChatOutput
object
1 property 1 required
ListTriggerGroupsSummariesOutput
object
2 properties 2 required
GenerateAgentCardArtworkOutput
object
5 properties 5 required
DeleteSkillInput
object
2 properties 2 required
UpdateUsersChatSettingsInput
object
1 property 1 required
TriggerWorkforceInput
object
9 properties 2 required
GetAgentTaskViewTriggerMessageOutput
object
1 property 1 required
GetAgentVersionOutput
object
1 property
SuggestRepliesOutput
object
1 property 1 required
ListPrePublishChecksOutput
object
2 properties 2 required
FsDeleteInput
object
2 properties 2 required
GetVoiceTokenOutput
object
1 property 1 required
FsDiscoverVolumesOutput
object
1 property 1 required
GetChatSettingsAvailableOptionsOutput
object
3 properties
TriggerWorkforceChatInput
object
7 properties 1 required
FsListDirectoryOutput
object
1 property 1 required
FsMoveInput
object
4 properties 3 required
CreateBatchScheduleTasksInput
object
7 properties 4 required
ListTaskGroupsOutput
object
2 properties 2 required
ListTriggerItemsViewInput
object
5 properties 3 required
CountAgentsOutput
object
1 property 1 required
ListAgentDependencyVersionMetadataInput
object
1 property 1 required
TriggerWorkforceOutput
object
2 properties 2 required
GenerateAgentRequirementsInput
object
DeleteAgentOutput
object
InitiateFileUploadInput
object
4 properties 4 required
ListMatchGroupConversationsOutput
object
1 property 1 required
UpsertAgentOutput
object
1 property 1 required
GetEmbedKeyForWorkforceOutput
object
2 properties 2 required
DeleteSavedPromptInput
object
ReadSkillOutput
object
4 properties 4 required
FsMkdirOutput
object
1 property 1 required
ListConversationStudiosHistoryOutput
object
3 properties 1 required
UpdateSlideShowVisibilityInput
object
1 property 1 required
GetPublicWorkforceOutput
object
2 properties 1 required
GetWorkforceChatOutput
object
4 properties 3 required
UpdateWorkforceTaskTitleInput
object
1 property 1 required
FsListVersionsOutput
object
2 properties 1 required
DuplicateWorkforceOutput
object
1 property 1 required
UpsertPresetAgentOutput
object
1 property 1 required
GetWorkforceTaskFileContentsOutput
object
4 properties 4 required
ListWorkforcesOutput
object
2 properties 1 required
CreateBatchScheduleAgentTasksOutput
object
2 properties 2 required
ListAgentTaskViewInput
object
7 properties
UpdateWorkforceTaskStateOutput
object
21 properties 5 required
RestoreSlideshowVersionInput
BulkTriggerAgentsOutput
object
2 properties 2 required
TriggerAgentInput
object
15 properties
BulkCancelUpcomingSyncItemsInput
object
1 property 1 required
ListConversationFilesOutput
object
1 property 1 required
FsGetMetadataOutput
object
1 property 1 required
ReorderSlidesOutput
object
1 property 1 required
UpdateWorkforceChatInput
object
3 properties 1 required
UpsertAgentVersionInput
object
12 properties 1 required
AggregateTaggedAgentConversationsInput
object
8 properties
GetWorkforceChatMissingInputsInput
object
3 properties 1 required
CloneWorkforceInput
object
1 property 1 required
DeleteWorkforceOutput
SaveAgentAsDraftOutput
object
3 properties 1 required
GetWorkforceOutput
object
5 properties 1 required
DeleteSlideshowTemplateInput
BetaGetSuperAgentChatTasksOutput
object
1 property 1 required
BulkTriggerAgentsInput
object
5 properties 1 required
CreateAgentScheduledTriggersItemOutput
object
1 property 1 required
CreateSkillInput
object
5 properties 4 required
UpdateSlideshowTemplateInput
object
1 property
FsRestoreVersionInput
object
3 properties 3 required
UpsertSyncTemplateInput
object
5 properties 2 required
UpdateProjectChatSettingsOutput
object
1 property 1 required
DeleteWorkforceTasksOutput
object
GetOEmbedOutput
object
8 properties 8 required
ListAgentActiveTriggerGroupsOverviewOutput
object
3 properties 3 required
GetSlideshowVersionOutput
object
7 properties 5 required
LogCspViolationInput
object
12 properties 2 required
CreateSlideshowTemplateOutput
object
FsMoveOutput
object
1 property 1 required
GetWorkforceChatPrerequisitesOutput
object
2 properties
BulkRerunConversationsInput
object
4 properties 1 required
ListAgentVersionsInput
object
4 properties 1 required
SubmitMessageFeedbackOutput
object
CloneAgentMarketplaceTemplateInput
object
1 property 1 required
PullTestTriggerDataOutput
object
3 properties
GetUsersChatSettingsOutput
object
1 property 1 required
PullTestTriggerDataInput
object
1 property 1 required
CreateRecallAiDesktopSdkUploadInput
object
1 property
PauseBatchScheduleAgentTasksGroupInput
object
1 property 1 required
GetAgentOutput
object
1 property 1 required
ListWorkforceChatsOutput
object
4 properties 3 required
SaveWorkforceOutput
object
1 property
TriggerAgentOutput
object
5 properties 4 required
UpsertWorkforceVersionOutput
object
1 property 1 required
GetWorkforceChatPrerequisitesInput
object
4 properties
BulkRerunConversationsOutput
object
2 properties 2 required
UpdateWorkforceTaskFileContentsInput
object
1 property 1 required
GetEmbedKeyForAgentOutput
object
2 properties 2 required
FsGetStreamingTokenOutput
object
1 property 1 required
UpsertAgentVersionOutput
object
1 property 1 required
TakeSlideScreenshotOutput
object
1 property 1 required
CountWorkforcesOutput
object
1 property 1 required
CloneAgentOutput
object
2 properties 2 required
DeleteSlideshowTemplateOutput
object
UpdateSkillOutput
object
SaveAgentAsDraftInput
object
80 properties
CreateSkillOutput
object
1 property 1 required
ApplyGeneratedAgentMessageOutput
object
GenerateAgentParamsSchemaInput
object
2 properties 1 required
RestoreWorkforceVersionInput
object
1 property 1 required
ResumeBatchScheduleAgentTasksGroupInput
object
1 property 1 required
UpsertSyncTemplateOutput
object
1 property 1 required
PauseBatchScheduleAgentTasksGroupOutput
object
ListMasScratchpadOptionsOutput
object
3 properties 2 required
GetAgentsToolsInput
object
3 properties
GetWorkforceStreamingTokenOutput
object
1 property 1 required
CreateConversationFileOutput
object
2 properties 1 required
GetWorkforceChatCreditsOutput
object
2 properties 1 required
AggregateTaggedAgentConversationsOutput
object
2 properties 1 required
ListAgentTriggerGroupsSummariesOutput
object
2 properties 2 required
GetSlideChatsOutput
object
1 property 1 required
ListAgentPromptModelsOutput
object
1 property 1 required
CancelAgentOutput
object
SaveWorkforceInput
object
3 properties 3 required
ListConversationsOutput
object
3 properties 1 required
DeleteSkillOutput
object
UpsertAgentScheduledTriggersGroupOutput
object
1 property 1 required
UpdateWorkforceChatOutput
object
2 properties 2 required
DeleteWorkforceTasksInput
object
1 property 1 required
SetEntitiesInWorkforcePublicInput
object
1 property 1 required
CloneAgentInput
object
2 properties 1 required
ListAgentVersionsOutput
object
1 property 1 required
ExportConversationsOutput
object
2 properties 2 required
GetAgentAnalyticsOutput
object
4 properties 4 required
ListModelsOutput
object
1 property 1 required
ListUsersSlideshowsOutput
object
1 property 1 required
CreateSavedPromptInput
object
3 properties 2 required
GetConversationFileTemporaryUploadUrlOutput
object
1 property 1 required
ListWorkforceTaskMessagesInput
object
5 properties
ExportSlideShowOutput
object
1 property 1 required
ListAgentActiveTriggerGroupsOverviewInput
object
ListWorkforceScratchpadOptionsOutput
object
2 properties
CreateRecallAiDesktopSdkUploadOutput
object
2 properties 2 required
ListMyAgentsOutput
object
1 property 1 required
ListAgentsViewOutput
object
2 properties 1 required
ApplyGeneratedAgentMessageInput
object
4 properties 4 required
RestoreAgentVersionOutput
object
ListMyAgentsInput
object
4 properties
CreateSavedPromptOutput
object
8 properties 8 required
CancelAgentScheduledTriggerItemInput
object
1 property 1 required
DeleteSavedPromptOutput
object
CreateSlideshowTemplateInput
object
2 properties 1 required
BatchScheduleAgentTasksOutput
object
5 properties 5 required
CreateAgentScheduledTriggersItemInput
object
3 properties 3 required
ListWorkforcesInput
object
2 properties
ListWorkforceVersionsInput
object
4 properties 1 required
GetWorkforceTaskFileTemporaryDownloadUrlOutput
object
1 property 1 required
CreateSlideshowInput
object
2 properties
UpsertWorkforceVersionInput
object
12 properties 1 required
GenerateAgentCardArtworkInput
object
2 properties
ListProjectPhoneNumbersOutput
object
1 property 1 required
UpdateSavedPromptOutput
object
8 properties 8 required
GetSlideshowTemplateContentOutput
object
4 properties 3 required
ListSTTModelsOutput
object
1 property 1 required
ListTTSModelsOutput
object
1 property 1 required
CancelAgentInput
UpdateWorkforceTaskTitleOutput
object
21 properties 5 required
CloneWorkforceOutput
object
1 property 1 required
BulkUpdateSyncItemsStatusInput
object
2 properties 2 required
GenerateAgentMessageInput
object
2 properties
GetWorkforceConversationMetadataOutput
object
2 properties 1 required
DuplicateWorkforceInput
object
1 property 1 required
GetMeetingAgentConnectionDetailsInput
object
3 properties 3 required
ConfirmFileUploadInput
ListAgentTriggerGroupsSummariesInput
object
5 properties 1 required
GetAgentAnalyticsInput
object
1 property
SubmitMessageFeedbackInput
object
8 properties 4 required
TriggerRecurringOutput
object
ListAgentsToolsViewOutput
object
2 properties 2 required
UpsertFolderInput
object
5 properties 2 required
SetEntitiesInWorkforcePublicOutput
ListMasScratchpadOptionsInput
object
2 properties
DeleteAgentInput
GetChatSlideShowOutput
object
4 properties 4 required
ListAgentTaskViewOutput
object
4 properties 1 required
DeleteFolderInput
ListAgentsCustomMetadataInput
object
1 property
ListWorkforceTasksInput
object
5 properties 1 required
UpdateSavedPromptInput
object
3 properties
InitiateFileUploadOutput
object
3 properties 3 required
GetEmbedKeyForAgentInput
object
2 properties 2 required
ListTasksForGroupOutput
object
4 properties 2 required
ListAgentsOutput
object
1 property 1 required
CancelAgentScheduledTriggerItemOutput
object
ListWorkforceVersionsOutput
object
1 property 1 required
CreateConversationFileInput
object
3 properties 2 required
UpdateUsersChatSettingsOutput
object
1 property 1 required
GenerateAgentMessageOutput
object
4 properties 4 required
RestoreSlideshowVersionOutput
object
2 properties 2 required
CreateBatchScheduleTasksOutput
object
2 properties 2 required
ResumeBatchScheduleAgentTasksGroupOutput
object
ListWorkforceTaskMessagesOutput
object
6 properties 2 required
ListAgentsInput
object
7 properties
BetaGetSuperAgentChatFilesOutput
object
2 properties 2 required
ReorderSlidesInput
object
1 property 1 required
RestoreAgentVersionInput
object
1 property 1 required
ExportSlideShowInput
object
2 properties 1 required
BulkUpdateSyncItemsStatusOutput
object
2 properties 2 required
FsMkdirInput
object
2 properties 2 required
GetSlideshowOutput
object
5 properties 4 required
GetAgentsToolsOutput
object
1 property 1 required
UpsertAgentInput
object
81 properties
GetMeetingAgentConnectionDetailsOutput
object
2 properties 2 required
ConfirmFileUploadOutput
object
1 property 1 required
BulkApproveConversationsOutput
object
2 properties 2 required
BulkCancelUpcomingSyncItemsOutput
TriggerRecurringInput
object
5 properties 3 required
DeleteWorkforceChatInput
object
1 property 1 required
UpdateSlideshowTemplateOutput
object
CreateBatchScheduleAgentTasksInput
object
6 properties 3 required
BulkRespondConversationsInput
object
3 properties 3 required
ListSkillsOutput
object
1 property 1 required
LatestConversationUpdateDatetimeOutput
object
1 property 1 required
RerunWorkforceFromEventOutput
object
2 properties 2 required
UpdateProjectChatSettingsInput
object
1 property 1 required
BulkRespondConversationsOutput
object
2 properties 2 required
ListAgentsToolsViewInput
object
1 property 1 required
GetWorkforceChatMissingInputsOutput
object
1 property 1 required
ListConversationsForMatchGroupOutput
object
1 property 1 required
UpdateSlideShowVisibilityOutput
object
UpdateWorkforceTaskFileContentsOutput
object
1 property 1 required
RestoreWorkforceVersionOutput
object
RerunWorkforceFromEventInput
object
6 properties 3 required
GenerateAgentParamsSchemaOutput
object
1 property 1 required
UpdateSkillInput
object
5 properties 4 required
CancelBatchScheduleAgentTasksGroupInput
object
1 property 1 required
BulkRejectConversationsInput
object
3 properties 2 required
UpdateWorkforceTaskStateInput
object
1 property 1 required
ListTriggerItemsViewOutput
object
3 properties 3 required
ListRemoteMcpServerToolsOutput
array
TestWorkforceNodeInput
object
6 properties 2 required
CloneAgentMarketplaceTemplateOutput
object
2 properties 2 required
FsDeleteOutput
object
1 property 1 required
LogCspViolationOutput
object
GetActiveTriggerGroupsOverviewOutput
object
3 properties 3 required
PublishAgentInput
object
1 property 1 required
ListAgentDependencyVersionMetadataOutput
object
1 property 1 required
ListAgentsViewInput
object
1 property
BulkRejectConversationsOutput
object
2 properties 2 required
DeleteWorkforceChatOutput
object
ListTriggerGroupsSummariesInput
object
6 properties 2 required
ListSlideshowTemplatesOutput
object
1 property 1 required
ListConfigurableToolPermissionsOutput
object
1 property 1 required
ListWorkforceScratchpadOptionsInput
object
1 property
UpdateTriggerGroupStatusOutput
GetAgentConversationMetadataOutput
object
2 properties 1 required
UpsertFolderOutput
object
1 property 1 required
GetTriggerGroupSummaryOutput
object
11 properties 8 required
GetEmbedKeyForWorkforceInput
object
2 properties 2 required
PublishAgentOutput
object
1 property 1 required
SuggestRepliesInput
object
2 properties 1 required
ListAgentsCustomMetadataOutput
object
1 property 1 required
UpsertPresetAgentInput
object
4 properties 1 required
GetActiveTriggerGroupsOverviewInput
object
1 property 1 required
UpsertAgentScheduledTriggersGroupInput
object
2 properties
GetProjectChatSettingsOutput
object
1 property 1 required
ListPresetAgentsOutput
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relevance-ai-chat-api-openapi.yml Raw ↑

Other APIs Relevance AI publishes across the network.

Relevance AI MCP Server
AE Profile APIs.io
Relevance AI Agent Debug Configs API
AE Profile APIs.io
Relevance AI Agent Runtime Events API
AE Profile APIs.io
Relevance AI Agents API
AE Profile APIs.io
Relevance AI Alarms API
AE Profile APIs.io
Relevance AI Analytics API
AE Profile APIs.io
Relevance AI Apify API
AE Profile APIs.io
Relevance AI Auth API
AE Profile APIs.io
Relevance AI Billing API
AE Profile APIs.io
Relevance AI Branding Kit API
AE Profile APIs.io
Relevance AI Branding Kits API
AE Profile APIs.io
Relevance AI Evals API
AE Profile APIs.io
#Chat
← Back to R APIs
API Details
ID
relevance-ai:relevance-ai-chat-api
Base URL
https://api-{region}.stack.tryrelevance.com/latest
Docs
https://api-f1db6c.stack.tryrelevance.com/latest/documentation
Provider
Relevance AI
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=relevance-ai-chat-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/relevance-ai-chat-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Relevance AI Chat API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.