From ec8a522c2cadfe0756a23777aa14ad3041db39c4 Mon Sep 17 00:00:00 2001 From: iris-clawd Date: Mon, 4 May 2026 20:29:49 -0300 Subject: [PATCH] fix: correct status endpoint path from /{kickoff_id}/status to /status/{kickoff_id} --- docs/ar/api-reference/introduction.mdx | 4 ++-- docs/ar/api-reference/status.mdx | 4 ++-- docs/en/api-reference/introduction.mdx | 4 ++-- docs/en/api-reference/status.mdx | 4 ++-- docs/enterprise-api.base.yaml | 4 ++-- docs/enterprise-api.en.yaml | 4 ++-- docs/enterprise-api.ko.yaml | 2 +- docs/enterprise-api.pt-BR.yaml | 4 ++-- docs/ko/api-reference/introduction.mdx | 4 ++-- docs/ko/api-reference/status.mdx | 4 ++-- docs/pt-BR/api-reference/introduction.mdx | 4 ++-- docs/pt-BR/api-reference/status.mdx | 4 ++-- 12 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/ar/api-reference/introduction.mdx b/docs/ar/api-reference/introduction.mdx index 1d368341c..60f7bb118 100644 --- a/docs/ar/api-reference/introduction.mdx +++ b/docs/ar/api-reference/introduction.mdx @@ -26,7 +26,7 @@ mode: "wide" - استخدم `GET /{kickoff_id}/status` للتحقق من حالة التنفيذ واسترجاع النتائج. + استخدم `GET /status/{kickoff_id}` للتحقق من حالة التنفيذ واسترجاع النتائج. @@ -65,7 +65,7 @@ https://your-crew-name.crewai.com 1. **الاكتشاف**: استدعِ `GET /inputs` لفهم ما يحتاجه طاقمك 2. **التنفيذ**: أرسل المدخلات عبر `POST /kickoff` لبدء المعالجة -3. **المراقبة**: استعلم عن `GET /{kickoff_id}/status` حتى الاكتمال +3. **المراقبة**: استعلم عن `GET /status/{kickoff_id}` حتى الاكتمال 4. **النتائج**: استخرج المخرجات النهائية من الاستجابة المكتملة ## معالجة الأخطاء diff --git a/docs/ar/api-reference/status.mdx b/docs/ar/api-reference/status.mdx index b57fd0091..5403a36a0 100644 --- a/docs/ar/api-reference/status.mdx +++ b/docs/ar/api-reference/status.mdx @@ -1,6 +1,6 @@ --- -title: "GET /{kickoff_id}/status" +title: "GET /status/{kickoff_id}" description: "الحصول على حالة التنفيذ" -openapi: "/enterprise-api.en.yaml GET /{kickoff_id}/status" +openapi: "/enterprise-api.en.yaml GET /status/{kickoff_id}" mode: "wide" --- diff --git a/docs/en/api-reference/introduction.mdx b/docs/en/api-reference/introduction.mdx index 45ccac71e..0874af7d2 100644 --- a/docs/en/api-reference/introduction.mdx +++ b/docs/en/api-reference/introduction.mdx @@ -26,7 +26,7 @@ Welcome to the CrewAI AMP API reference. This API allows you to programmatically - Use `GET /{kickoff_id}/status` to check execution status and retrieve results. + Use `GET /status/{kickoff_id}` to check execution status and retrieve results. @@ -65,7 +65,7 @@ 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 /{kickoff_id}/status` until completion +3. **Monitoring**: Poll `GET /status/{kickoff_id}` until completion 4. **Results**: Extract the final output from the completed response ## Error Handling diff --git a/docs/en/api-reference/status.mdx b/docs/en/api-reference/status.mdx index 7d09af649..0eed0f825 100644 --- a/docs/en/api-reference/status.mdx +++ b/docs/en/api-reference/status.mdx @@ -1,6 +1,6 @@ --- -title: "GET /{kickoff_id}/status" +title: "GET /status/{kickoff_id}" description: "Get execution status" -openapi: "/enterprise-api.en.yaml GET /{kickoff_id}/status" +openapi: "/enterprise-api.en.yaml GET /status/{kickoff_id}" mode: "wide" --- diff --git a/docs/enterprise-api.base.yaml b/docs/enterprise-api.base.yaml index 03ae18aa3..1755fcba5 100644 --- a/docs/enterprise-api.base.yaml +++ b/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 /{kickoff_id}/status` + 3. **Monitor progress** using `GET /status/{kickoff_id}` version: 1.0.0 contact: name: CrewAI Support @@ -207,7 +207,7 @@ paths: "500": $ref: "#/components/responses/ServerError" - /{kickoff_id}/status: + /status/{kickoff_id}: get: summary: Get Execution Status description: | diff --git a/docs/enterprise-api.en.yaml b/docs/enterprise-api.en.yaml index 03ae18aa3..1755fcba5 100644 --- a/docs/enterprise-api.en.yaml +++ b/docs/enterprise-api.en.yaml @@ -35,7 +35,7 @@ info: 1. **Discover inputs** using `GET /inputs` 2. **Start execution** using `POST /kickoff` - 3. **Monitor progress** using `GET /{kickoff_id}/status` + 3. **Monitor progress** using `GET /status/{kickoff_id}` version: 1.0.0 contact: name: CrewAI Support @@ -207,7 +207,7 @@ paths: "500": $ref: "#/components/responses/ServerError" - /{kickoff_id}/status: + /status/{kickoff_id}: get: summary: Get Execution Status description: | diff --git a/docs/enterprise-api.ko.yaml b/docs/enterprise-api.ko.yaml index 7d78c3f41..f52b1d6d1 100644 --- a/docs/enterprise-api.ko.yaml +++ b/docs/enterprise-api.ko.yaml @@ -84,7 +84,7 @@ paths: '500': $ref: '#/components/responses/ServerError' - /{kickoff_id}/status: + /status/{kickoff_id}: get: summary: 실행 상태 조회 description: | diff --git a/docs/enterprise-api.pt-BR.yaml b/docs/enterprise-api.pt-BR.yaml index 831ab81e5..9cf95001c 100644 --- a/docs/enterprise-api.pt-BR.yaml +++ b/docs/enterprise-api.pt-BR.yaml @@ -35,7 +35,7 @@ info: 1. **Descubra os inputs** usando `GET /inputs` 2. **Inicie a execução** usando `POST /kickoff` - 3. **Monitore o progresso** usando `GET /{kickoff_id}/status` + 3. **Monitore o progresso** usando `GET /status/{kickoff_id}` version: 1.0.0 contact: name: CrewAI Suporte @@ -120,7 +120,7 @@ paths: "500": $ref: "#/components/responses/ServerError" - /{kickoff_id}/status: + /status/{kickoff_id}: get: summary: Obter Status da Execução description: | diff --git a/docs/ko/api-reference/introduction.mdx b/docs/ko/api-reference/introduction.mdx index 967e06264..8f961587e 100644 --- a/docs/ko/api-reference/introduction.mdx +++ b/docs/ko/api-reference/introduction.mdx @@ -26,7 +26,7 @@ CrewAI 엔터프라이즈 API 참고 자료에 오신 것을 환영합니다. - `GET /{kickoff_id}/status`를 사용하여 실행 상태를 확인하고 결과를 조회하세요. + `GET /status/{kickoff_id}`를 사용하여 실행 상태를 확인하고 결과를 조회하세요. @@ -65,7 +65,7 @@ https://your-crew-name.crewai.com 1. **탐색**: `GET /inputs`를 호출하여 crew가 필요한 것을 파악합니다. 2. **실행**: `POST /kickoff`를 통해 입력값을 제출하여 처리를 시작합니다. -3. **모니터링**: 완료될 때까지 `GET /{kickoff_id}/status`를 주기적으로 조회합니다. +3. **모니터링**: 완료될 때까지 `GET /status/{kickoff_id}`를 주기적으로 조회합니다. 4. **결과**: 완료된 응답에서 최종 출력을 추출합니다. ## 오류 처리 diff --git a/docs/ko/api-reference/status.mdx b/docs/ko/api-reference/status.mdx index a0e7a4d50..663aee483 100644 --- a/docs/ko/api-reference/status.mdx +++ b/docs/ko/api-reference/status.mdx @@ -1,6 +1,6 @@ --- -title: "GET /{kickoff_id}/status" +title: "GET /status/{kickoff_id}" description: "실행 상태 조회" -openapi: "/enterprise-api.ko.yaml GET /{kickoff_id}/status" +openapi: "/enterprise-api.ko.yaml GET /status/{kickoff_id}" mode: "wide" --- diff --git a/docs/pt-BR/api-reference/introduction.mdx b/docs/pt-BR/api-reference/introduction.mdx index e071e3b1b..85a6b9274 100644 --- a/docs/pt-BR/api-reference/introduction.mdx +++ b/docs/pt-BR/api-reference/introduction.mdx @@ -26,7 +26,7 @@ Bem-vindo à referência da API do CrewAI AMP. Esta API permite que você intera - Use `GET /{kickoff_id}/status` para checar o status da execução e recuperar os resultados. + Use `GET /status/{kickoff_id}` para checar o status da execução e recuperar os resultados. @@ -65,7 +65,7 @@ Substitua `your-crew-name` pela URL real do seu crew no painel. 1. **Descoberta**: Chame `GET /inputs` para entender o que seu crew precisa 2. **Execução**: Envie os inputs via `POST /kickoff` para iniciar o processamento -3. **Monitoramento**: Faça polling em `GET /{kickoff_id}/status` até a conclusão +3. **Monitoramento**: Faça polling em `GET /status/{kickoff_id}` até a conclusão 4. **Resultados**: Extraia o output final da resposta concluída ## Tratamento de Erros diff --git a/docs/pt-BR/api-reference/status.mdx b/docs/pt-BR/api-reference/status.mdx index 6f1e1dd9c..e443adba9 100644 --- a/docs/pt-BR/api-reference/status.mdx +++ b/docs/pt-BR/api-reference/status.mdx @@ -1,6 +1,6 @@ --- -title: "GET /{kickoff_id}/status" +title: "GET /status/{kickoff_id}" description: "Obter o status da execução" -openapi: "/enterprise-api.pt-BR.yaml GET /{kickoff_id}/status" +openapi: "/enterprise-api.pt-BR.yaml GET /status/{kickoff_id}" mode: "wide" ---