Skip to content

Supercharge your AI agents with data from the web and beyond. Building the library for superintelligence. 🔥

docs: update cancel crawl response

Ademílson Tonato34e3911a97c2
diff --git a/apps/api/requests.http b/apps/api/requests.http
index d8cc3633d..f7b7de9cf 100644
--- a/apps/api/requests.http
+++ b/apps/api/requests.http
@@ -28,6 +28,11 @@ content-type: application/json
GET {{baseUrl}}/v1/crawl/{{crawlId}} HTTP/1.1
Authorization: Bearer {{$dotenv TEST_API_KEY}}
+### Cancel Crawl
+@crawlId = {{crawl.response.body.$.id}}
+# @name cancelCrawl
+DELETE {{baseUrl}}/v1/crawl/{{crawlId}} HTTP/1.1
+Authorization: Bearer {{$dotenv TEST_API_KEY}}
### Batch Scrape Websites
# @name batchScrape
diff --git a/apps/api/v1-openapi.json b/apps/api/v1-openapi.json
index 9aab05c9f..ba22f5704 100644
--- a/apps/api/v1-openapi.json
+++ b/apps/api/v1-openapi.json
@@ -840,19 +840,16 @@
],
"responses": {
"200": {
- "description": "Successful cancellation",
+ "description": "Crawl job successfully cancelled",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
- "success": {
- "type": "boolean",
- "example": true
- },
- "message": {
+ "status": {
"type": "string",
- "example": "Crawl job successfully cancelled."
+ "enum": ["cancelled"],
+ "example": "cancelled"
}
}
}
@@ -988,19 +985,16 @@
],
"responses": {
"200": {
- "description": "Successful cancellation",
+ "description": "Crawl job successfully cancelled",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
- "success": {
- "type": "boolean",
- "example": true
- },
- "message": {
+ "status": {
"type": "string",
- "example": "Crawl job successfully cancelled."
+ "enum": ["cancelled"],
+ "example": "cancelled"
}
}
}