Connectors
AI, LLM & Vector Stores
Mistral
AI models: chat completions, embeddings, and function calling
Mistral API referenceAPI checked August 15, 2026
- Signs in with
- Connection fields
- Runs on
- Cloud or On-Prem Worker
- Operations
- 284
- Ready-made triggers
- 0
Connect Mistral
- In Neblex open Connect › Connections and click New Connection.
- Search for Mistral and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| API keyOptionalSecret | Standard Mistral workspace or inference API key. |
| Admin API keyOptionalSecret | Admin-scoped Bearer key for /v1/admin operations; ordinary workspace keys are rejected. |
| Dashboard API keyOptionalSecret | Dashboard public API key sent as x-api-key for the three /v1/users/me operations. |
Use it in a flow
- Open a flow, open the node library and search for Mistral.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
Operations
284 operations in 48 groups. Each one is a step you can add to a flow.
Agent1
Agents CompletionagentCompletion | POST | Agents Completion |
Audio Speech1
Speechspeech | POST | Speech |
Audio Transcription1
Create Transcriptiontranscribe | POST | Create Transcription |
Audio Voice6
Create a new voicecreateVoice | POST | Create a new voice with a base64-encoded audio sample |
Delete a custom voicedeleteVoice | DELETE | Delete a custom voice |
Get voice detailsgetVoice | GET | Get voice details (excluding sample) |
Get voice sample audiogetVoiceSample | GET | Get the audio sample for a voice |
List all voiceslistVoices | GET | List all voices (excluding sample data) |
Update voice metadataupdateVoice | PATCH | Update voice metadata (name, gender, languages, age, tags). |
Batch5
Cancel Batch JobcancelBatchJob | POST | Request the cancellation of a batch job. |
Create Batch JobcreateBatchJob | POST | Create a new batch job, it will be queued for processing. |
Delete Batch JobdeleteBatchJob | DELETE | Request the deletion of a batch job. |
Get Batch JobgetBatchJob | GET | Get a batch job details by its UUID. |
Get Batch JobslistBatchJobs | GET | Get a list of batch jobs for your organization and user. |
Beta Admin Api Key3
Create Api KeycreateApiKey | POST | Create a Workspace API key. |
Delete Api KeydeleteApiKey | DELETE | Delete an API key. |
Get Api KeyslistApiKeys | GET | List API keys for the Organization. |
Beta Admin Audit Log1
Get Audit LogsgetAuditLogs | GET | List audit log entries for the Organization. |
Beta Admin Billing4
Get Rate LimitsgetRateLimits | GET | Get Rate Limits |
Get Spend LimitsgetSpendLimits | GET | Get usage, rate, and job limits for the Organization. |
Get UsagegetOrgUsage | GET | Get usage and cost data for the Organization. |
Update Spend LimitsupdateSpendLimits | POST | Update the Organization usage limit. |
Beta Admin Scim2
Get Scim Sync Runusers_api_admin_scim_sync_get_scim_sync_run | GET | Retrieve an on-demand SCIM synchronization run for the Organization. |
Trigger Scim Syncusers_api_admin_scim_sync_trigger_scim_sync | POST | Trigger an on-demand SCIM synchronization for the Organization. |
Beta Admin User9
Create UserscreateOrgUsers | POST | Create Organization members. |
Delete InvitedeleteOrgInvite | DELETE | Delete Invite |
Delete UserdeleteOrgUser | DELETE | Remove a member from the Organization. |
Get InvitelistOrgInvites | GET | List pending Organization invitations. |
Get RolesgetOrgRoles | GET | List Organization and Workspace roles. |
Get UsergetOrgUser | GET | Get details for an Organization member. |
Get UserslistOrgUsers | GET | List Organization members and pending invitations. |
Invite UsersinviteOrgUser | POST | Invite users to the Organization. |
Update UserupdateOrgUser | PATCH | Update an Organization member's roles and product seats. |
Beta Admin User Group16
Assign Group To WorkspaceassignUserGroupToWorkspace | POST | Assign a user group to a workspace. |
Assign Users To GroupaddUserGroupMembers | POST | Assign users to a user group. |
Create User GroupcreateUserGroup | POST | Create a new user group. |
Delete User GroupdeleteUserGroup | DELETE | Delete a user group. |
Get Group Workspace AssignmentslistUserGroupWorkspaces | GET | List workspace assignments for a user group. |
Get Nested Groups Adminusers_api_admin_user_groups_get_nested_groups | GET | List the groups directly nested inside this group. |
Get User GroupgetUserGroup | GET | Get a specific user group. |
Get User Group MemberslistUserGroupMembers | GET | Get members of a user group. |
Get User GroupslistUserGroups | GET | Get all user groups across the organization. |
Provision Group To WorkspaceprovisionUserGroupToWorkspace | POST | Provision all users from a user group to a workspace with a specific role. |
Remove Group From WorkspaceremoveUserGroupFromWorkspace | DELETE | Remove a user group from a workspace. |
Remove Users From GroupremoveUserGroupMembers | DELETE | Remove users from a user group. |
Set Nested Groups Adminusers_api_admin_user_groups_set_nested_groups | PATCH | Replace the set of groups directly nested inside this group. |
Update Group Workspace AssignmentupdateUserGroupWorkspace | PATCH | Update the workspace role assignment for a user group. |
Update User GroupupdateUserGroup | PATCH | Update a user group. |
Update User Group Organization RoleupdateUserGroupOrgRole | PATCH | Update the organization role for a user group. |
Beta Admin Vibe Code Analytic2
Usage by organizationgetVibeUsageByOrganization | GET | Get Vibe Code usage for the Organization. |
Usage by workspacegetVibeUsageByWorkspace | GET | Get Vibe Code usage for a Workspace. |
Beta Admin Vibe Work Analytic3
Usage by agentgetVibeUsageByAgent | GET | Get Vibe Work usage by agent for a time range. |
Usage by usergetVibeUsageByUser | GET | Get Vibe Work usage by user for a time range. |
Usage over timegetVibeUsageByTime | GET | Get Vibe Work usage over time. |
Beta Admin Workspace7
Add Or Update Users WorkspacesupdateWorkspaceUsers | PATCH | Add or update Workspace members. |
Add Users WorkspacesaddWorkspaceUsers | POST | Add members to a Workspace. |
Create WorkspacecreateOrgWorkspace | POST | Create a Workspace. |
Delete WorkspacesdeleteOrgWorkspace | DELETE | Archive a Workspace. |
Get WorkspaceslistOrgWorkspaces | GET | List Workspaces in the Organization. |
Remove Users WorkspacesremoveWorkspaceUsers | DELETE | Remove members from a Workspace. |
Update WorkspacesupdateOrgWorkspace | PATCH | Update a Workspace. |
Beta Agent12
Create a agent that can be used within a conversation.createAgent | POST | Create a new agent giving it instructions, tools, description. |
Create or update an agent version alias.setAgentAlias | PUT | Create a new alias or update an existing alias to point to a specific version. |
Delete an agent entity.deleteAgent | DELETE | Delete an agent entity. |
Delete an agent version alias.deleteAgentAlias | DELETE | Delete an existing alias for an agent. |
List agent entities, cursor-paginated.agents_api_v1_agents_list_pages | GET | Retrieve a page of agent entities. |
List agent entities.listAgents | GET | Retrieve a list of agent entities sorted by creation time. |
List all aliases for an agent.listAgentAliases | GET | Retrieve all version aliases for a specific agent. |
List all versions of an agent.listAgentVersions | GET | Retrieve all versions for a specific agent with full agent context. |
Retrieve a specific version of an agent.getAgentVersion | GET | Get a specific agent version by version number. |
Retrieve an agent entity.getAgent | GET | Given an agent, retrieve an agent entity with its attributes. |
Update an agent entity.updateAgent | PATCH | Update an agent attributes and create a new version. |
Update an agent version.updateAgentVersion | PATCH | Switch the version of an agent. |
Beta Connector23
Activate a connector for the given consumer (organizationconnector_activate_for_consumer_v1 | POST | Enable a connector for the consumer. |
Call Connector ToolcallConnectorTool | POST | Call a tool on an MCP connector. |
Create a new connector.createConnector | POST | Create a new MCP connector. |
Create or update organization credentials for a connector.setConnectorOrgCredentials | POST | Create or update credentials at the organization level for a given connector. |
Create or update user credentials for a connector.setConnectorUserCredentials | POST | Create or update credentials at the user level for a given connector. |
Create or update workspace credentials for a connector.setConnectorWorkspaceCredentials | POST | Create or update credentials at the workspace level for a given connector. |
Deactivate a connector for the current consumer (atconnector_deactivate_for_consumer_v1 | POST | Disable a connector for the calling consumer only. |
Delete a connector.deleteConnector | DELETE | Delete a connector by its ID. |
Delete all user credentials for a connector.connector_delete_all_user_credentials_v1 | DELETE | Delete all credentials configured at the user level for a given connector. |
Delete organization credentials for a connector.deleteConnectorOrgCredentials | DELETE | Delete credentials at the organization level for a given connector. |
Delete user credentials for a connector.deleteConnectorUserCredentials | DELETE | Delete credentials at the user level for a given connector. |
Delete workspace credentials for a connector.deleteConnectorWorkspaceCredentials | DELETE | Delete credentials at the workspace level for a given connector. |
Get a connector.getConnector | GET | Get a connector by its ID or name. |
Get authentication methods for a connector.getConnectorAuthMethods | GET | Get the authentication schema for a connector. |
Get the auth URL for a connector.getConnectorAuthUrl | GET | Get the OAuth2 authorization URL for a connector to initiate user authentication. |
List all connectors.listConnectors | GET | List all your custom connectors with keyset pagination and filters. |
List organization credentials for a connector.listConnectorOrgCredentials | GET | List all credentials configured at the organization level for a given connector. |
List tools for a connector.listConnectorTools | GET | List all tools available for an MCP connector. |
List user credentials for a connector.listConnectorUserCredentials | GET | List all credentials configured at the user level for a given connector. |
List workspace credentials for a connector.listConnectorWorkspaceCredentials | GET | List all credentials configured at the workspace level for a given connector. |
Share a private connector to the current workspace.connector_share_v1 | PUT | Transfers ownership of a private user-owned connector to the current workspace, making it available to all workspace members. |
Unshare a connector from the current workspace.connector_unshare_v1 | DELETE | Reverts a workspace-shared connector back to a private, creator-owned connector. |
Update a connector.updateConnector | PATCH | Update a connector by its ID. |
Beta Conversation8
Append new entries to an existing conversation.appendConversation | POST | Run completion on the history of the conversation and the user entries. |
Create a conversation and append entries to it.startConversation | POST | Create a new conversation, using a base model or an agent and append entries. |
Delete a conversation.deleteConversation | DELETE | Delete a conversation given a conversation id. |
List all created conversations.listConversations | GET | Retrieve a list of conversation entities sorted by creation time. |
Restart a conversation starting from a given entry.restartConversation | POST | Given a conversation id and an id, recreate a conversation from this point and run completion. |
Retrieve a conversation information.getConversation | GET | Given a conversation id retrieve a conversation entity with its attributes. |
Retrieve all entries in a conversation.getConversationHistory | GET | Given a conversation id retrieve all the entries belonging to that conversation. |
Retrieve all messages in a conversation.getConversationMessages | GET | Given a conversation id retrieve all the messages belonging to that conversation. |
Beta Libraries Access3
Create or update an access level.shareLibrary | PUT | Given a library id, you can create or update the access level of an entity. |
Delete an access level.unshareLibrary | DELETE | Given a library id, you can delete the access level of an entity. |
List all of the access to this library.listLibraryShares | GET | Given a library, list all of the Entity that have access and to what level. |
Beta Libraries Document11
Delete a document.deleteLibraryDocument | DELETE | Given a library and a document in that library, delete that document. |
List documents in a given library.listLibraryDocuments | GET | Given a library, lists the document that have been uploaded to that library. |
Reprocess a document.reprocessLibraryDocument | POST | Given a library and a document in that library, reprocess that document, it will be billed again. |
Retrieve the metadata of a specific document.getLibraryDocument | GET | Given a library and a document in this library, you can retrieve the metadata of that document. |
Retrieve the processing status of a specific document.getLibraryDocumentStatus | GET | Given a library and a document in that library, retrieve the processing status of that document. |
Retrieve the signed URL of a specific document.getLibraryDocumentSignedUrl | GET | Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link. |
Retrieve the signed URL of text extracted from a given document.getLibraryDocumentExtractedTextUrl | GET | Given a library and a document in that library, retrieve the signed URL of text extracted. |
Retrieve the text content of a specific document.getLibraryDocumentText | GET | Given a library and a document in that library, you can retrieve the text content of that document if it exists. |
Update the metadata of a specific document.libraries_documents_update_v1 | PUT | Given a library and a document in that library, update the name of that document. |
Update the metadata of a specific document.updateLibraryDocument | PATCH | Given a library and a document in that library, update the name and/or attributes of that document. |
Upload a new document.uploadLibraryDocument | POST | Given a library, upload a new document to that library. |
Beta Library6
Create a new Library.createLibrary | POST | Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. |
Delete a library and all of it's document.deleteLibrary | DELETE | Given a library id, deletes it together with all documents that have been uploaded to that library. |
Detailed information about a specific Library.getLibrary | GET | Given a library id, details information about that Library. |
List all libraries you have access to.listLibraries | GET | List all libraries that you have created or have been shared with you. |
Update a library.libraries_update_v1 | PUT | Given a library id, you can update the name and description. |
Update a library.updateLibrary | PATCH | Given a library id, you can update the name and description. |
Beta Observability Campaign6
Create and start a new campaigncreateCampaign | POST | Create and start a new campaign |
Delete a campaigndeleteCampaign | DELETE | Delete a campaign |
Get all campaignslistCampaigns | GET | Get all campaigns |
Get campaign by idgetCampaign | GET | Get campaign by id |
Get campaign status by campaign idgetCampaignStatus | GET | Get campaign status by campaign id |
Get event ids that were selected by the given campaigngetCampaignSelectedEvents | GET | Get event ids that were selected by the given campaign |
Beta Observability Chat Completion Event5
Alternative to /search that returns only the IDs and that cansearchChatCompletionEventIds | POST | Alternative to /search that returns only the IDs and that can return many IDs at once |
Get Chat Completion EventgetChatCompletionEvent | GET | Get Chat Completion Event |
Get Chat Completion EventssearchChatCompletionEvents | POST | Get Chat Completion Events |
Get Similar Chat Completion EventsgetSimilarChatCompletionEvents | GET | Get Similar Chat Completion Events |
Run Judge on an event based on the given optionsjudgeChatCompletionEvent | POST | Run Judge on an event based on the given options |
Beta Observability Chat Completion Events Field3
Get Chat Completion Field OptionsgetChatCompletionFieldOptions | GET | Get Chat Completion Field Options |
Get Chat Completion Field Options CountsgetChatCompletionFieldOptionCounts | POST | Get Chat Completion Field Options Counts |
Get Chat Completion FieldsgetChatCompletionFields | GET | Get Chat Completion Fields |
Beta Observability Dataset15
Add a record to the datasetcreateDatasetRecord | POST | Add a record to the dataset |
Create a new empty datasetcreateDataset | POST | Create a new empty dataset |
Delete a datasetdeleteDataset | DELETE | Delete a dataset |
Export to the Files API and retrieve presigned URL to downloadexportDatasetToJsonl | GET | Export to the Files API and retrieve presigned URL to download the resulting JSONL file |
Get dataset by idgetDataset | GET | Get dataset by id |
Get status of a dataset import taskgetDatasetImportTask | GET | Get status of a dataset import task |
List existing datasetslistDatasets | GET | List existing datasets |
List existing records in the datasetlistDatasetRecords | GET | List existing records in the dataset |
List import tasks for the given datasetlistDatasetImportTasks | GET | List import tasks for the given dataset |
Patch datasetupdateDataset | PATCH | Patch dataset |
Populate the dataset with records from a campaignimportDatasetFromCampaign | POST | Populate the dataset with records from a campaign |
Populate the dataset with records from an uploaded fileimportDatasetFromFile | POST | Populate the dataset with records from an uploaded file |
Populate the dataset with records from another datasetimportDatasetFromDataset | POST | Populate the dataset with records from another dataset |
Populate the dataset with records from playground conversationsimportDatasetFromPlayground | POST | Populate the dataset with records from playground conversations |
Populate the dataset with records from the explorerimportDatasetFromExplorer | POST | Populate the dataset with records from the explorer |
Beta Observability Datasets Record6
Delete a record from a datasetdeleteDatasetRecord | DELETE | Delete a record from a dataset |
Delete multiple records from datasetsbulkDeleteDatasetRecords | POST | Delete multiple records from datasets |
Get the content of a given dataset recordgetDatasetRecord | GET | Get the content of a given dataset record |
Run Judge on a dataset record based on the given optionsjudgeDatasetRecord | POST | Run Judge on a dataset record based on the given options |
Update a dataset record payloadupdateDatasetRecordPayload | PUT | Update a dataset record payload |
Update dataset record propertiesupdateDatasetRecordProperties | PUT | Update dataset record properties |
Beta Observability Judge6
Create a new judgecreateJudge | POST | Create a new judge |
Delete a judgedeleteJudge | DELETE | Delete a judge |
Get judge by idgetJudge | GET | Get judge by id |
Get judges with optional filtering and searchlistJudges | GET | Get judges with optional filtering and search |
Run a saved judge on a conversationrunJudge | POST | Run a saved judge on a conversation |
Update a judgeupdateJudge | PUT | Update a judge |
Beta Observability Log3
Get log field definitionsgetObservabilityLogFields | GET | Get log field definitions |
Get options for a log fieldgetObservabilityLogFieldOptions | GET | Get options for a log field |
Search logssearchObservabilityLogs | POST | Search logs |
Beta Observability Span8
Aggregate spansaggregate_spans_v1_observability_spans_aggregate_post | POST | Aggregate spans |
Get options for a span evaluation fieldgetSpanEvaluationFieldOptions | GET | Get options for a span evaluation field |
Get options for a span fieldgetSpanFieldOptions | GET | Get options for a span field |
Get span evaluation field definitionsgetSpanEvaluationFields | GET | Get span evaluation field definitions |
Get span field definitionsgetSpanFields | GET | Get span field definitions |
Search latest span evaluationssearchLatestSpanEvaluations | POST | Search latest span evaluations |
Search span evaluationssearchSpanEvaluations | POST | Search span evaluations |
Search spanssearchSpans | POST | Search spans |
Beta Observability Trace7
Aggregate tracesaggregate_traces_v1_observability_traces_aggregate_post | POST | Aggregate traces |
Get options for a trace fieldgetTraceFieldOptions | GET | Get options for a trace field |
Get span by idgetTraceSpan | GET | Get span by id |
Get trace by idgetTrace | GET | Get trace by id |
Get trace field definitionsgetTraceFields | GET | Get trace field definitions |
Get trace spansgetTraceSpans | GET | Get trace spans |
Search tracessearchTraces | POST | Search traces |
Beta Prompt9
Create PromptcreatePrompt | POST | CreatePrompt |
Create Prompt VersioncreatePromptVersion | POST | CreatePromptVersion |
Delete PromptdeletePrompt | DELETE | DeletePrompt |
Get PromptgetPrompt | GET | GetPrompt |
Get Prompt VersiongetPromptVersion | GET | GetPromptVersion |
List Prompt VersionslistPromptVersions | GET | ListPromptVersions |
List PromptslistPrompts | GET | ListPrompts |
Update PromptupdatePrompt | PATCH | UpdatePrompt |
Update Prompt Version MetadataupdatePromptVersion | PATCH | UpdatePromptVersionMetadata |
Beta Rag Ingestion Pipeline Configuration3
List ingestion pipeline configurationslistRagPipelineConfigs | GET | For the current workspace, lists all of the registered ingestion pipeline configurations. |
Register ConfigregisterRagPipelineConfig | PUT | Register an ingestion configuration. |
Update Run InfoupdateRagPipelineRunInfo | PUT | Update Run Info |
Beta Rag Search Index4
Get Deployment SummariesgetRagIndexSummaries | GET | Fetch all indexes available to a user |
Register (or re-register) a search indexregisterRagIndex | PUT | Register (or re-register) a search index |
Unregister DeploymentunregisterRagIndex | DELETE | Delete all information about a deployment |
Update Index MetricsupdateRagIndexMetrics | PUT | Update the metrics for a given index |
Beta Skill9
Create SkillcreateSkill | POST | CreateSkill |
Create Skill VersioncreateSkillVersion | POST | CreateSkillVersion |
Delete SkilldeleteSkill | DELETE | DeleteSkill |
Get SkillgetSkill | GET | GetSkill |
Get Skill VersiongetSkillVersion | GET | GetSkillVersion |
List Skill VersionslistSkillVersions | GET | ListSkillVersions |
List SkillslistSkills | GET | ListSkills |
Update SkillupdateSkill | PATCH | UpdateSkill |
Update Skill Version MetadataupdateSkillVersion | PATCH | UpdateSkillVersionMetadata |
Beta User3
Get Identityusers_api_get_identity | GET | Get Identity |
List Organizationsusers_api_list_organizations | GET | List every organization the authenticated user is a member of. |
List Workspacesusers_api_list_workspaces | GET | List every workspace the authenticated user is a member of, across all their organizations, each tagged with the organization it belongs to. |
Chat1
Chat CompletionchatMessages | POST | Chat Completion |
Classifier4
Chat ClassificationschatClassifications | POST | Chat Classifications |
Chat ModerationschatModerations | POST | Chat Moderations |
Classificationsclassifications | POST | Classifications |
Moderationsmoderations | POST | Moderations |
Embedding1
Embeddingsembeddings | POST | Embeddings |
Event2
Get Stream Eventsget_stream_events_v1_workflows_events_stream_get | GET | Get Stream Events |
Get Workflow EventslistWorkflowEvents | GET | Get Workflow Events |
File6
Delete FiledeleteFile | DELETE | Delete a file. |
Download FiledownloadFile | GET | Download a file |
Get Signed UrlgetFileSignedUrl | GET | Get Signed Url |
List FileslistFiles | GET | Returns a list of files that belong to the user's organization. |
Retrieve FilegetFile | GET | Returns information about a specific file. |
Upload FileuploadFile | POST | Upload a file that can be used across various endpoints. |
Fim1
Fim Completionfim | POST | FIM completion. |
Model6
Archive Fine Tuned ModelarchiveFineTunedModel | POST | Archive a fine-tuned model. |
Delete ModeldeleteModel | DELETE | Delete a fine-tuned model. |
List ModelslistModels | GET | List all models available to the user. |
Retrieve ModelgetModel | GET | Retrieve information about a model. |
Unarchive Fine Tuned ModelunarchiveFineTunedModel | DELETE | Un-archive a fine-tuned model. |
Update Fine Tuned ModelupdateFineTunedModel | PATCH | Update a model name or description. |
Ocr1
OCRocr | POST | OCR |
Workflow11
Archive WorkflowarchiveWorkflow | PUT | Archive Workflow |
Bulk Archive WorkflowsbulkArchiveWorkflows | PUT | Bulk Archive Workflows |
Bulk Unarchive WorkflowsbulkUnarchiveWorkflows | PUT | Bulk Unarchive Workflows |
Execute WorkflowexecuteWorkflow | POST | Execute Workflow |
Execute Workflow RegistrationexecuteWorkflowRegistration | POST | Execute Workflow Registration |
Get WorkflowgetWorkflow | GET | Get Workflow |
Get Workflow RegistrationgetWorkflowRegistration | GET | Get Workflow Registration |
Get Workflow RegistrationslistWorkflowRegistrations | GET | Get Workflow Registrations |
Get WorkflowslistWorkflows | GET | Get Workflows |
Unarchive WorkflowunarchiveWorkflow | PUT | Unarchive Workflow |
Update WorkflowupdateWorkflow | PUT | Update Workflow |
Workflows Deployment11
Create Deploymentcreate_deployment_v1_workflows_deployments_post | POST | Create Deployment |
Delete Deploymentdelete_deployment_v1_workflows_deployments__name__delete | DELETE | Delete Deployment |
Get DeploymentgetWorkflowDeployment | GET | Get Deployment |
Get Deployment LogsgetWorkflowDeploymentLogs | GET | Retrieve logs for a deployment (across all of its workers). |
List Deployment Workerslist_deployment_workers_v1_workflows_deployments__name__workers_get | GET | List Deployment Workers |
List DeploymentslistWorkflowDeployments | GET | List Deployments |
Restart Deploymentrestart_deployment_v1_workflows_deployments__name__restart_post | POST | Restart Deployment |
Start Deploymentstart_deployment_v1_workflows_deployments__name__start_post | POST | Start Deployment |
Stop Deploymentstop_deployment_v1_workflows_deployments__name__stop_post | POST | Stop Deployment |
Stream Deployment Logsstream_deployment_logs | GET | Stream logs for a deployment (all of its workers) via SSE. |
Update Deploymentupdate_deployment_v1_workflows_deployments__name__patch | PATCH | Update Deployment |
Workflows Execution17
Batch Cancel Workflow ExecutionsbatchCancelWorkflowExecutions | POST | Batch Cancel Workflow Executions |
Batch Terminate Workflow ExecutionsbatchTerminateWorkflowExecutions | POST | Batch Terminate Workflow Executions |
Cancel Workflow ExecutioncancelWorkflowExecution | POST | Cancel Workflow Execution |
Get Workflow ExecutiongetWorkflowExecution | GET | Get Workflow Execution |
Get Workflow Execution HistorygetWorkflowExecutionHistory | GET | Get Workflow Execution History |
Get Workflow Execution LogsgetWorkflowExecutionLogs | GET | Retrieve logs for a workflow execution. |
Get Workflow Execution Trace EventsgetWorkflowExecutionTraceEvents | GET | Get Workflow Execution Trace Events |
Get Workflow Execution Trace Infoget_workflow_execution_trace_info | GET | Get Workflow Execution Trace Info |
Get Workflow Execution Trace OtelgetWorkflowExecutionTraceOtel | GET | Get Workflow Execution Trace Otel |
Get Workflow Execution Trace SummarygetWorkflowExecutionTraceSummary | GET | Get Workflow Execution Trace Summary |
Query Workflow ExecutionqueryWorkflowExecution | POST | Query Workflow Execution |
Reset WorkflowresetWorkflowExecution | POST | Reset Workflow |
Signal Workflow ExecutionsignalWorkflowExecution | POST | Signal Workflow Execution |
Streamstream_v1_workflows_executions__execution_id__stream_get | GET | Stream |
Stream Workflow Execution Logsstream_workflow_execution_logs | GET | Stream logs for a workflow execution via SSE. |
Terminate Workflow ExecutionterminateWorkflowExecution | POST | Terminate Workflow Execution |
Update Workflow ExecutionupdateWorkflowExecution | POST | Update Workflow Execution |
Workflows Metric1
Get Workflow MetricsgetWorkflowMetrics | GET | Get comprehensive metrics for a specific workflow. |
Workflows Run3
Get RungetWorkflowRun | GET | Get Run |
Get Run HistorygetWorkflowRunHistory | GET | Get Run History |
List RunslistWorkflowRuns | GET | List Runs |
Workflows Schedule8
Get SchedulegetWorkflowSchedule | GET | Get Schedule |
Get ScheduleslistWorkflowSchedules | GET | Get Schedules |
Pause SchedulepauseWorkflowSchedule | POST | Pause Schedule |
Resume ScheduleresumeWorkflowSchedule | POST | Resume Schedule |
Schedule WorkflowcreateWorkflowSchedule | POST | Schedule Workflow |
Trigger ScheduletriggerWorkflowSchedule | POST | Trigger Schedule |
Unschedule WorkflowdeleteWorkflowSchedule | DELETE | Unschedule Workflow |
Update ScheduleupdateWorkflowSchedule | PATCH | Update Schedule |