{"openapi":"3.1.0","info":{"title":"Mistral workflow runs, schedules, deployments and metrics (your key) API","version":"0.1.0","description":"Mistral workflow runs, schedules, deployments and metrics (your key) lets an AI assistant read your own Mistral Workflows data through the Mistral Workflows API with a key you supply (Mistral API key). Read-only: 8 tools (list_workflow_runs, get_workflow_run, list_workflow_schedules, list_workflow_deployments, get_workflow_deployment, get_workflow_metrics, get_workflow,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-mistral-workflows.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-mistral-workflows/docs"},"termsOfService":"https://connectorbay.com/byok-mistral-workflows/terms"},"servers":[{"url":"https://byok-mistral-workflows.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-mistral-workflows/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_workflow_runs":{"post":{"operationId":"list_workflow_runs","summary":"List workflow runs (executions) with workflow name, status, start and end time and duration in milliseconds; the run res","description":"List workflow runs (executions) with workflow name, status, start and end time and duration in milliseconds; the run results are not returned. Reads workflow metadata only: it starts, stops and changes nothing. Use for \"Which Mistral workflow runs failed recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workflow_identifier":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only runs of this workflow name or id.","title":"Workflow Identifier"},"search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Search by workflow name, display name or id.","title":"Search"},"status":{"anyOf":[{"enum":["RUNNING","COMPLETED","FAILED","CANCELED","TERMINATED","CONTINUED_AS_NEW","TIMED_OUT","RETRYING_AFTER_ERROR"],"type":"string"},{"type":"null"}],"default":null,"description":"Only runs with this status.","title":"Status"},"page_size":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many runs to return (1 to 1000, default 50).","title":"Page Size"},"next_page_token":{"anyOf":[{"maxLength":2000,"type":"string"},{"type":"null"}],"default":null,"description":"Token from the previous answer's next_page_token for the next page.","title":"Next Page Token"}},"title":"list_workflow_runsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_workflow_run":{"post":{"operationId":"get_workflow_run","summary":"Get one workflow run by execution id: workflow name, status, times and duration. The run result is not returned. Reads w","description":"Get one workflow run by execution id: workflow name, status, times and duration. The run result is not returned. Reads workflow metadata only: it starts, stops and changes nothing. Use for \"Did Mistral workflow run exec_abc123 complete\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"run_id":{"description":"Execution id of the run as returned by list_workflow_runs.","maxLength":200,"title":"Run Id","type":"string"}},"required":["run_id"],"title":"get_workflow_runArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_workflow_schedules":{"post":{"operationId":"list_workflow_schedules","summary":"List workflow schedules with schedule id, cron expressions, time zone and start and end times; schedule inputs are not r","description":"List workflow schedules with schedule id, cron expressions, time zone and start and end times; schedule inputs are not returned. Reads workflow metadata only: it starts, stops and changes nothing. Use for \"What Mistral workflow schedules are configured\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_workflow_schedulesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_workflow_deployments":{"post":{"operationId":"list_workflow_deployments","summary":"List workflow deployments with name, whether a worker is live, and creation and update times. Reads workflow metadata on","description":"List workflow deployments with name, whether a worker is live, and creation and update times. Reads workflow metadata only: it starts, stops and changes nothing. Use for \"Which Mistral workflow deployments are active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"active_only":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True (default) to list only deployments with a live worker; false to include inactive ones.","title":"Active Only"},"workflow_name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only deployments of this workflow name.","title":"Workflow Name"}},"title":"list_workflow_deploymentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_workflow_deployment":{"post":{"operationId":"get_workflow_deployment","summary":"Get one workflow deployment by name with its live-worker flag and times. Reads workflow metadata only: it starts, stops ","description":"Get one workflow deployment by name with its live-worker flag and times. Reads workflow metadata only: it starts, stops and changes nothing. Use for \"Is the Mistral workflow deployment reports-prod live\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"description":"Deployment name as returned by list_workflow_deployments.","maxLength":200,"title":"Name","type":"string"}},"required":["name"],"title":"get_workflow_deploymentArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_workflow_metrics":{"post":{"operationId":"get_workflow_metrics","summary":"Get run metrics of a workflow: execution count, success count, error count, average latency in milliseconds and retry ra","description":"Get run metrics of a workflow: execution count, success count, error count, average latency in milliseconds and retry rate, optionally within a time window. Reads workflow metadata only: it starts, stops and changes nothing. Use for \"What is the error rate of the Mistral workflow daily-report this week\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workflow_name":{"description":"Workflow name.","maxLength":200,"title":"Workflow Name","type":"string"},"start_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only runs started after this ISO 8601 time, for example 2026-10-01T00:00:00Z.","title":"Start Time"},"end_time":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only runs started before this ISO 8601 time.","title":"End Time"}},"required":["workflow_name"],"title":"get_workflow_metricsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_workflow":{"post":{"operationId":"get_workflow","summary":"Get one workflow by name or id: display name, type, description, and whether it is active, archived or available in the ","description":"Get one workflow by name or id: display name, type, description, and whether it is active, archived or available in the chat assistant. Reads workflow metadata only: it starts, stops and changes nothing. Use for \"Is the Mistral workflow daily-report archived\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workflow_identifier":{"description":"Workflow name or id.","maxLength":200,"title":"Workflow Identifier","type":"string"}},"required":["workflow_identifier"],"title":"get_workflowArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_workflow_registrations":{"post":{"operationId":"list_workflow_registrations","summary":"List workflow registrations (deployed versions) with task queue, workflow id and chat assistant compatibility; definitio","description":"List workflow registrations (deployed versions) with task queue, workflow id and chat assistant compatibility; definitions are not returned. Reads workflow metadata only: it starts, stops and changes nothing. Use for \"Which Mistral workflow versions are registered on the reports queue\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workflow_search":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only registrations of workflows whose name matches this text.","title":"Workflow Search"},"task_queue":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only registrations on this task queue.","title":"Task Queue"},"active_only":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to list only active versions.","title":"Active Only"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many registrations to return (default 50).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from the previous answer's next_cursor for the next page.","title":"Cursor"}},"title":"list_workflow_registrationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}