docs: document /stop/{kickoff_id} endpoint for cancelling executions#5208
Open
iris-clawd wants to merge 2 commits into
Open
docs: document /stop/{kickoff_id} endpoint for cancelling executions#5208iris-clawd wants to merge 2 commits into
iris-clawd wants to merge 2 commits into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Collaborator
|
@bragamat @iris-clawd I checked the built preview and our reference to /stop endpoint is not there. it should have its own page like 
|
lorenzejay
requested changes
Apr 1, 2026
| https://your-crew-url.crewai.com/status/abcd1234-5678-90ef-ghij-klmnopqrstuv | ||
| ``` | ||
|
|
||
| ## Stopping a Running Execution |
Collaborator
There was a problem hiding this comment.
@bragamat @iris-clawd I checked the built preview and our reference to /stop endpoint is not there. it should have its own page like api-reference/kickoff
Address review feedback to create a dedicated stop endpoint page in api-reference, matching the pattern used by kickoff endpoint. Added stop.mdx for all languages (en, ko, pt-BR, ar) and updated docs.json navigation. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
alex-clawd
force-pushed
the
docs/stop-execution-endpoint
branch
from
e03da9c to
0650d19
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document the existing
/stop/{kickoff_id}API endpoint that allows stopping running crew and flow executions. This endpoint exists in crewAI-enterprise but was not previously documented in the public docs or OpenAPI spec.Changes
docs/en/enterprise/guides/kickoff-crew.mdx: Added "Stopping a Running Execution" section with API usage examples, success/error responses, and notes about terminal states.docs/enterprise-api.base.yamlanddocs/enterprise-api.en.yaml: Added/stop/{kickoff_id}endpoint to OpenAPI spec with full request/response documentation andStopExecutionResponseschema.docs/enterprise-api.ko.yaml: Added localized stop endpoint and schema (Korean).docs/enterprise-api.pt-BR.yaml: Added localized stop endpoint and schema (Brazilian Portuguese).Note
Low Risk
Low risk: documentation/OpenAPI-only updates with no runtime code changes. Main risk is mismatched endpoint behavior across locales/specs if the documented responses/status codes diverge from the implementation.
Overview
Documents the existing
POST /stop/{kickoff_id}endpoint for cancelling a running crew/flow execution, including request/response examples and terminal-state constraints.Adds the
/stop/{kickoff_id}path andStopExecutionResponseschema to the OpenAPI specs (enterprise-api.base.yaml/enterprise-api.en.yaml) and localizes the endpoint inenterprise-api.ko.yamlandenterprise-api.pt-BR.yaml, plus new API reference pages (*/api-reference/stop.mdx) and navigation entries indocs.json.Written by Cursor Bugbot for commit 0650d19. This will update automatically on new commits. Configure here.