fixed api-reference/status docs page (#4109)

Author: lorenzejay

docs/en/api-reference/introduction.mdx

@@ -16,16 +16,17 @@ Welcome to the CrewAI AOP API reference. This API allows you to programmatically
     Navigate to your crew's detail page in the CrewAI AOP dashboard and copy your Bearer Token from the Status tab.
   </Step>
 
-  <Step title="Discover Required Inputs">
-    Use the `GET /inputs` endpoint to see what parameters your crew expects.
-  </Step>
+<Step title="Discover Required Inputs">
+  Use the `GET /inputs` endpoint to see what parameters your crew expects.
+</Step>
 
-  <Step title="Start a Crew Execution">
-    Call `POST /kickoff` with your inputs to start the crew execution and receive a `kickoff_id`.
-  </Step>
+<Step title="Start a Crew Execution">
+  Call `POST /kickoff` with your inputs to start the crew execution and receive
+  a `kickoff_id`.
+</Step>
 
   <Step title="Monitor Progress">
-    Use `GET /status/{kickoff_id}` to check execution status and retrieve results.
+    Use `GET /{kickoff_id}/status` to check execution status and retrieve results.
   </Step>
 </Steps>
 
@@ -40,13 +41,14 @@ curl -H "Authorization: Bearer YOUR_CREW_TOKEN" \
 
 ### Token Types
 
-| Token Type | Scope | Use Case |
-|:-----------|:--------|:----------|
-| **Bearer Token** | Organization-level access | Full crew operations, ideal for server-to-server integration |
-| **User Bearer Token** | User-scoped access | Limited permissions, suitable for user-specific operations |
+| Token Type            | Scope                     | Use Case                                                     |
+| :-------------------- | :------------------------ | :----------------------------------------------------------- |
+| **Bearer Token**      | Organization-level access | Full crew operations, ideal for server-to-server integration |
+| **User Bearer Token** | User-scoped access        | Limited permissions, suitable for user-specific operations   |
 
 <Tip>
-You can find both token types in the Status tab of your crew's detail page in the CrewAI AOP dashboard.
+  You can find both token types in the Status tab of your crew's detail page in
+  the CrewAI AOP dashboard.
 </Tip>
 
 ## Base URL
@@ -63,29 +65,33 @@ Replace `your-crew-name` with your actual crew's URL from the dashboard.
 
 1. **Discovery**: Call `GET /inputs` to understand what your crew needs
 2. **Execution**: Submit inputs via `POST /kickoff` to start processing
-3. **Monitoring**: Poll `GET /status/{kickoff_id}` until completion
+3. **Monitoring**: Poll `GET /{kickoff_id}/status` until completion
 4. **Results**: Extract the final output from the completed response
 
 ## Error Handling
 
 The API uses standard HTTP status codes:
 
-| Code | Meaning |
-|------|:--------|
-| `200` | Success |
-| `400` | Bad Request - Invalid input format |
-| `401` | Unauthorized - Invalid bearer token |
-| `404` | Not Found - Resource doesn't exist |
+| Code  | Meaning                                    |
+| ----- | :----------------------------------------- |
+| `200` | Success                                    |
+| `400` | Bad Request - Invalid input format         |
+| `401` | Unauthorized - Invalid bearer token        |
+| `404` | Not Found - Resource doesn't exist         |
 | `422` | Validation Error - Missing required inputs |
-| `500` | Server Error - Contact support |
+| `500` | Server Error - Contact support             |
 
 ## Interactive Testing
 
 <Info>
-**Why no "Send" button?** Since each CrewAI AOP user has their own unique crew URL, we use **reference mode** instead of an interactive playground to avoid confusion. This shows you exactly what the requests should look like without non-functional send buttons.
+  **Why no "Send" button?** Since each CrewAI AOP user has their own unique crew
+  URL, we use **reference mode** instead of an interactive playground to avoid
+  confusion. This shows you exactly what the requests should look like without
+  non-functional send buttons.
 </Info>
 
 Each endpoint page shows you:
+
 - ✅ **Exact request format** with all parameters
 - ✅ **Response examples** for success and error cases
 - ✅ **Code samples** in multiple languages (cURL, Python, JavaScript, etc.)
@@ -103,6 +109,7 @@ Each endpoint page shows you:
 </CardGroup>
 
 **Example workflow:**
+
 1. **Copy this cURL example** from any endpoint page
 2. **Replace `your-actual-crew-name.crewai.com`** with your real crew URL
 3. **Replace the Bearer token** with your real token from the dashboard
@@ -111,10 +118,18 @@ Each endpoint page shows you:
 ## Need Help?
 
 <CardGroup cols={2}>
-  <Card title="Enterprise Support" icon="headset" href="mailto:[email protected]">
+  <Card
+    title="Enterprise Support"
+    icon="headset"
+    href="mailto:[email protected]"
+  >
     Get help with API integration and troubleshooting
   </Card>
-  <Card title="Enterprise Dashboard" icon="chart-line" href="https://app.crewai.com">
+  <Card
+    title="Enterprise Dashboard"
+    icon="chart-line"
+    href="https://app.crewai.com"
+  >
     Manage your crews and view execution logs
   </Card>
 </CardGroup>

docs/en/api-reference/status.mdx

@@ -1,8 +1,6 @@
 ---
-title: "GET /status/{kickoff_id}"
+title: "GET /{kickoff_id}/status"
 description: "Get execution status"
-openapi: "/enterprise-api.en.yaml GET /status/{kickoff_id}"
+openapi: "/enterprise-api.en.yaml GET /{kickoff_id}/status"
 mode: "wide"
 ---
-
-

docs/enterprise-api.base.yaml

@@ -35,7 +35,7 @@ info:
 
     1. **Discover inputs** using `GET /inputs`
     2. **Start execution** using `POST /kickoff`
-    3. **Monitor progress** using `GET /status/{kickoff_id}`
+    3. **Monitor progress** using `GET /{kickoff_id}/status`
   version: 1.0.0
   contact:
     name: CrewAI Support
@@ -63,7 +63,7 @@ paths:
         Use this endpoint to discover what inputs you need to provide when starting a crew execution.
       operationId: getRequiredInputs
       responses:
-        '200':
+        "200":
           description: Successfully retrieved required inputs
           content:
             application/json:
@@ -84,13 +84,21 @@ paths:
                 outreach_crew:
                   summary: Outreach crew inputs
                   value:
-                    inputs: ["name", "title", "company", "industry", "our_product", "linkedin_url"]
-        '401':
-          $ref: '#/components/responses/UnauthorizedError'
-        '404':
-          $ref: '#/components/responses/NotFoundError'
-        '500':
-          $ref: '#/components/responses/ServerError'
+                    inputs:
+                      [
+                        "name",
+                        "title",
+                        "company",
+                        "industry",
+                        "our_product",
+                        "linkedin_url",
+                      ]
+        "401":
+          $ref: "#/components/responses/UnauthorizedError"
+        "404":
+          $ref: "#/components/responses/NotFoundError"
+        "500":
+          $ref: "#/components/responses/ServerError"
 
   /kickoff:
     post:
@@ -170,7 +178,7 @@ paths:
                   taskWebhookUrl: "https://api.example.com/webhooks/task"
                   crewWebhookUrl: "https://api.example.com/webhooks/crew"
       responses:
-        '200':
+        "200":
           description: Crew execution started successfully
           content:
             application/json:
@@ -182,24 +190,24 @@ paths:
                     format: uuid
                     description: Unique identifier for tracking this execution
                     example: "abcd1234-5678-90ef-ghij-klmnopqrstuv"
-        '400':
+        "400":
           description: Invalid request body or missing required inputs
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Error'
-        '401':
-          $ref: '#/components/responses/UnauthorizedError'
-        '422':
+                $ref: "#/components/schemas/Error"
+        "401":
+          $ref: "#/components/responses/UnauthorizedError"
+        "422":
           description: Validation error - ensure all required inputs are provided
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ValidationError'
-        '500':
-          $ref: '#/components/responses/ServerError'
+                $ref: "#/components/schemas/ValidationError"
+        "500":
+          $ref: "#/components/responses/ServerError"
 
-  /status/{kickoff_id}:
+  /{kickoff_id}/status:
     get:
       summary: Get Execution Status
       description: |
@@ -222,15 +230,15 @@ paths:
             format: uuid
             example: "abcd1234-5678-90ef-ghij-klmnopqrstuv"
       responses:
-        '200':
+        "200":
           description: Successfully retrieved execution status
           content:
             application/json:
               schema:
                 oneOf:
-                  - $ref: '#/components/schemas/ExecutionRunning'
-                  - $ref: '#/components/schemas/ExecutionCompleted'
-                  - $ref: '#/components/schemas/ExecutionError'
+                  - $ref: "#/components/schemas/ExecutionRunning"
+                  - $ref: "#/components/schemas/ExecutionCompleted"
+                  - $ref: "#/components/schemas/ExecutionError"
               examples:
                 running:
                   summary: Execution in progress
@@ -262,19 +270,19 @@ paths:
                     status: "error"
                     error: "Task execution failed: Invalid API key for external service"
                     execution_time: 23.1
-        '401':
-          $ref: '#/components/responses/UnauthorizedError'
-        '404':
+        "401":
+          $ref: "#/components/responses/UnauthorizedError"
+        "404":
           description: Kickoff ID not found
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Error'
+                $ref: "#/components/schemas/Error"
               example:
                 error: "Execution not found"
                 message: "No execution found with ID: abcd1234-5678-90ef-ghij-klmnopqrstuv"
-        '500':
-          $ref: '#/components/responses/ServerError'
+        "500":
+          $ref: "#/components/responses/ServerError"
 
   /resume:
     post:
@@ -354,7 +362,7 @@ paths:
                   taskWebhookUrl: "https://api.example.com/webhooks/task"
                   crewWebhookUrl: "https://api.example.com/webhooks/crew"
       responses:
-        '200':
+        "200":
           description: Execution resumed successfully
           content:
             application/json:
@@ -381,28 +389,28 @@ paths:
                   value:
                     status: "retrying"
                     message: "Task will be retried with your feedback"
-        '400':
+        "400":
           description: Invalid request body or execution not in pending state
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Error'
+                $ref: "#/components/schemas/Error"
               example:
                 error: "Invalid Request"
                 message: "Execution is not in pending human input state"
-        '401':
-          $ref: '#/components/responses/UnauthorizedError'
-        '404':
+        "401":
+          $ref: "#/components/responses/UnauthorizedError"
+        "404":
           description: Execution ID or Task ID not found
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Error'
+                $ref: "#/components/schemas/Error"
               example:
                 error: "Not Found"
                 message: "Execution ID not found"
-        '500':
-          $ref: '#/components/responses/ServerError'
+        "500":
+          $ref: "#/components/responses/ServerError"
 
 components:
   securitySchemes:
@@ -458,7 +466,7 @@ components:
             tasks:
               type: array
               items:
-                $ref: '#/components/schemas/TaskResult'
+                $ref: "#/components/schemas/TaskResult"
         execution_time:
           type: number
           description: Total execution time in seconds
@@ -536,7 +544,7 @@ components:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: "#/components/schemas/Error"
           example:
             error: "Unauthorized"
             message: "Invalid or missing bearer token"
@@ -546,7 +554,7 @@ components:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: "#/components/schemas/Error"
           example:
             error: "Not Found"
             message: "The requested resource was not found"
@@ -556,7 +564,7 @@ components:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Error'
+            $ref: "#/components/schemas/Error"
           example:
             error: "Internal Server Error"
             message: "An unexpected error occurred"