diff --git a/docs/en/api-reference/introduction.mdx b/docs/en/api-reference/introduction.mdx index 22eb705be..5c4597721 100644 --- a/docs/en/api-reference/introduction.mdx +++ b/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. - - Use the `GET /inputs` endpoint to see what parameters your crew expects. - + + Use the `GET /inputs` endpoint to see what parameters your crew expects. + - - Call `POST /kickoff` with your inputs to start the crew execution and receive a `kickoff_id`. - + + Call `POST /kickoff` with your inputs to start the crew execution and receive + a `kickoff_id`. + - Use `GET /status/{kickoff_id}` to check execution status and retrieve results. + Use `GET /{kickoff_id}/status` to check execution status and retrieve results. @@ -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 | -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. ## 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 -**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. 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: **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? - + Get help with API integration and troubleshooting - + Manage your crews and view execution logs diff --git a/docs/en/api-reference/status.mdx b/docs/en/api-reference/status.mdx index 3110104a9..7d09af649 100644 --- a/docs/en/api-reference/status.mdx +++ b/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" --- - - diff --git a/docs/enterprise-api.base.yaml b/docs/enterprise-api.base.yaml index 84da820ee..7b434ae20 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 /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" diff --git a/docs/enterprise-api.en.yaml b/docs/enterprise-api.en.yaml index 84da820ee..7b434ae20 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 /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" diff --git a/docs/enterprise-api.ko.yaml b/docs/enterprise-api.ko.yaml index f52b1d6d1..7d78c3f41 100644 --- a/docs/enterprise-api.ko.yaml +++ b/docs/enterprise-api.ko.yaml @@ -84,7 +84,7 @@ paths: '500': $ref: '#/components/responses/ServerError' - /status/{kickoff_id}: + /{kickoff_id}/status: get: summary: 실행 상태 조회 description: | diff --git a/docs/enterprise-api.pt-BR.yaml b/docs/enterprise-api.pt-BR.yaml index 9cb2eeab4..f58d29da2 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 /status/{kickoff_id}` + 3. **Monitore o progresso** usando `GET /{kickoff_id}/status` version: 1.0.0 contact: name: CrewAI Suporte @@ -56,7 +56,7 @@ paths: Retorna a lista de parâmetros de entrada que sua crew espera. operationId: getRequiredInputs responses: - '200': + "200": description: Inputs requeridos obtidos com sucesso content: application/json: @@ -69,12 +69,12 @@ paths: type: string description: Nomes dos parâmetros de entrada example: ["budget", "interests", "duration", "age"] - '401': - $ref: '#/components/responses/UnauthorizedError' - '404': - $ref: '#/components/responses/NotFoundError' - '500': - $ref: '#/components/responses/ServerError' + "401": + $ref: "#/components/responses/UnauthorizedError" + "404": + $ref: "#/components/responses/NotFoundError" + "500": + $ref: "#/components/responses/ServerError" /kickoff: post: @@ -104,7 +104,7 @@ paths: age: "35" responses: - '200': + "200": description: Execução iniciada com sucesso content: application/json: @@ -115,12 +115,12 @@ paths: type: string format: uuid example: "abcd1234-5678-90ef-ghij-klmnopqrstuv" - '401': - $ref: '#/components/responses/UnauthorizedError' - '500': - $ref: '#/components/responses/ServerError' + "401": + $ref: "#/components/responses/UnauthorizedError" + "500": + $ref: "#/components/responses/ServerError" - /status/{kickoff_id}: + /{kickoff_id}/status: get: summary: Obter Status da Execução description: | @@ -136,25 +136,25 @@ paths: type: string format: uuid responses: - '200': + "200": description: Status recuperado com sucesso content: application/json: schema: oneOf: - - $ref: '#/components/schemas/ExecutionRunning' - - $ref: '#/components/schemas/ExecutionCompleted' - - $ref: '#/components/schemas/ExecutionError' - '401': - $ref: '#/components/responses/UnauthorizedError' - '404': + - $ref: "#/components/schemas/ExecutionRunning" + - $ref: "#/components/schemas/ExecutionCompleted" + - $ref: "#/components/schemas/ExecutionError" + "401": + $ref: "#/components/responses/UnauthorizedError" + "404": description: Kickoff ID não encontrado content: application/json: schema: - $ref: '#/components/schemas/Error' - '500': - $ref: '#/components/responses/ServerError' + $ref: "#/components/schemas/Error" + "500": + $ref: "#/components/responses/ServerError" /resume: post: @@ -234,7 +234,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: @@ -261,28 +261,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: @@ -324,7 +324,7 @@ components: tasks: type: array items: - $ref: '#/components/schemas/TaskResult' + $ref: "#/components/schemas/TaskResult" execution_time: type: number @@ -380,16 +380,16 @@ components: content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" NotFoundError: description: Recurso não encontrado content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" ServerError: description: Erro interno do servidor content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" diff --git a/docs/ko/api-reference/introduction.mdx b/docs/ko/api-reference/introduction.mdx index 557f1edb8..ea24b63bd 100644 --- a/docs/ko/api-reference/introduction.mdx +++ b/docs/ko/api-reference/introduction.mdx @@ -16,16 +16,17 @@ CrewAI 엔터프라이즈 API 참고 자료에 오신 것을 환영합니다. CrewAI AOP 대시보드에서 자신의 crew 상세 페이지로 이동하여 Status 탭에서 Bearer Token을 복사하세요. - - `GET /inputs` 엔드포인트를 사용하여 crew가 기대하는 파라미터를 확인하세요. - + + `GET /inputs` 엔드포인트를 사용하여 crew가 기대하는 파라미터를 확인하세요. + - - 입력값과 함께 `POST /kickoff`를 호출하여 crew 실행을 시작하고 `kickoff_id`를 받으세요. - + + 입력값과 함께 `POST /kickoff`를 호출하여 crew 실행을 시작하고 `kickoff_id`를 + 받으세요. + - `GET /status/{kickoff_id}`를 사용하여 실행 상태를 확인하고 결과를 조회하세요. + `GET /{kickoff_id}/status`를 사용하여 실행 상태를 확인하고 결과를 조회하세요. @@ -40,13 +41,14 @@ curl -H "Authorization: Bearer YOUR_CREW_TOKEN" \ ### 토큰 유형 -| 토큰 유형 | 범위 | 사용 사례 | -|:-----------|:--------|:----------| -| **Bearer Token** | 조직 단위 접근 | 전체 crew 운영, 서버 간 통합에 이상적 | -| **User Bearer Token** | 사용자 범위 접근 | 제한된 권한, 사용자별 작업에 적합 | +| 토큰 유형 | 범위 | 사용 사례 | +| :-------------------- | :--------------- | :------------------------------------ | +| **Bearer Token** | 조직 단위 접근 | 전체 crew 운영, 서버 간 통합에 이상적 | +| **User Bearer Token** | 사용자 범위 접근 | 제한된 권한, 사용자별 작업에 적합 | -두 토큰 유형 모두 CrewAI AOP 대시보드의 crew 상세 페이지 Status 탭에서 확인할 수 있습니다. + 두 토큰 유형 모두 CrewAI AOP 대시보드의 crew 상세 페이지 Status 탭에서 확인할 + 수 있습니다. ## 기본 URL @@ -63,29 +65,33 @@ https://your-crew-name.crewai.com 1. **탐색**: `GET /inputs`를 호출하여 crew가 필요한 것을 파악합니다. 2. **실행**: `POST /kickoff`를 통해 입력값을 제출하여 처리를 시작합니다. -3. **모니터링**: 완료될 때까지 `GET /status/{kickoff_id}`를 주기적으로 조회합니다. +3. **모니터링**: 완료될 때까지 `GET /{kickoff_id}/status`를 주기적으로 조회합니다. 4. **결과**: 완료된 응답에서 최종 출력을 추출합니다. ## 오류 처리 API는 표준 HTTP 상태 코드를 사용합니다: -| 코드 | 의미 | -|------|:--------| -| `200` | 성공 | -| `400` | 잘못된 요청 - 잘못된 입력 형식 | -| `401` | 인증 실패 - 잘못된 베어러 토큰 | +| 코드 | 의미 | +| ----- | :------------------------------------ | +| `200` | 성공 | +| `400` | 잘못된 요청 - 잘못된 입력 형식 | +| `401` | 인증 실패 - 잘못된 베어러 토큰 | | `404` | 찾을 수 없음 - 리소스가 존재하지 않음 | -| `422` | 유효성 검사 오류 - 필수 입력 누락 | -| `500` | 서버 오류 - 지원팀에 문의하십시오 | +| `422` | 유효성 검사 오류 - 필수 입력 누락 | +| `500` | 서버 오류 - 지원팀에 문의하십시오 | ## 인터랙티브 테스트 -**왜 "전송" 버튼이 없나요?** 각 CrewAI AOP 사용자는 고유한 crew URL을 가지므로, 혼동을 피하기 위해 인터랙티브 플레이그라운드 대신 **참조 모드**를 사용합니다. 이를 통해 비작동 전송 버튼 없이 요청이 어떻게 생겼는지 정확히 보여줍니다. + **왜 "전송" 버튼이 없나요?** 각 CrewAI AOP 사용자는 고유한 crew URL을 + 가지므로, 혼동을 피하기 위해 인터랙티브 플레이그라운드 대신 **참조 모드**를 + 사용합니다. 이를 통해 비작동 전송 버튼 없이 요청이 어떻게 생겼는지 정확히 + 보여줍니다. 각 엔드포인트 페이지에서는 다음을 확인할 수 있습니다: + - ✅ 모든 파라미터가 포함된 **정확한 요청 형식** - ✅ 성공 및 오류 사례에 대한 **응답 예시** - ✅ 여러 언어(cURL, Python, JavaScript 등)로 제공되는 **코드 샘플** @@ -103,6 +109,7 @@ API는 표준 HTTP 상태 코드를 사용합니다: **예시 작업 흐름:** + 1. **cURL 예제를 복사**합니다 (엔드포인트 페이지에서) 2. **`your-actual-crew-name.crewai.com`**을(를) 실제 crew URL로 교체합니다 3. **Bearer 토큰을** 대시보드에서 복사한 실제 토큰으로 교체합니다 @@ -111,10 +118,18 @@ API는 표준 HTTP 상태 코드를 사용합니다: ## 도움이 필요하신가요? - + API 통합 및 문제 해결에 대한 지원을 받으세요 - + crew를 관리하고 실행 로그를 확인하세요 diff --git a/docs/ko/api-reference/status.mdx b/docs/ko/api-reference/status.mdx index ce7802f8f..a0e7a4d50 100644 --- a/docs/ko/api-reference/status.mdx +++ b/docs/ko/api-reference/status.mdx @@ -1,8 +1,6 @@ --- -title: "GET /status/{kickoff_id}" +title: "GET /{kickoff_id}/status" description: "실행 상태 조회" -openapi: "/enterprise-api.ko.yaml GET /status/{kickoff_id}" +openapi: "/enterprise-api.ko.yaml GET /{kickoff_id}/status" mode: "wide" --- - - diff --git a/docs/pt-BR/api-reference/introduction.mdx b/docs/pt-BR/api-reference/introduction.mdx index da0188bb4..2ddbe9720 100644 --- a/docs/pt-BR/api-reference/introduction.mdx +++ b/docs/pt-BR/api-reference/introduction.mdx @@ -16,16 +16,17 @@ Bem-vindo à referência da API do CrewAI AOP. Esta API permite que você intera Navegue até a página de detalhes do seu crew no painel do CrewAI AOP e copie seu Bearer Token na aba Status. - - Use o endpoint `GET /inputs` para ver quais parâmetros seu crew espera. - + + Use o endpoint `GET /inputs` para ver quais parâmetros seu crew espera. + - - Chame `POST /kickoff` com seus inputs para iniciar a execução do crew e receber um `kickoff_id`. - + + Chame `POST /kickoff` com seus inputs para iniciar a execução do crew e + receber um `kickoff_id`. + - Use `GET /status/{kickoff_id}` para checar o status da execução e recuperar os resultados. + Use `GET /{kickoff_id}/status` para checar o status da execução e recuperar os resultados. @@ -40,13 +41,14 @@ curl -H "Authorization: Bearer YOUR_CREW_TOKEN" \ ### Tipos de Token -| Tipo de Token | Escopo | Caso de Uso | -|:--------------------|:------------------------|:---------------------------------------------------------| -| **Bearer Token** | Acesso em nível de organização | Operações completas de crew, ideal para integração server-to-server | -| **User Bearer Token** | Acesso com escopo de usuário | Permissões limitadas, adequado para operações específicas de usuário | +| Tipo de Token | Escopo | Caso de Uso | +| :-------------------- | :----------------------------- | :------------------------------------------------------------------- | +| **Bearer Token** | Acesso em nível de organização | Operações completas de crew, ideal para integração server-to-server | +| **User Bearer Token** | Acesso com escopo de usuário | Permissões limitadas, adequado para operações específicas de usuário | -Você pode encontrar ambos os tipos de token na aba Status da página de detalhes do seu crew no painel do CrewAI AOP. + Você pode encontrar ambos os tipos de token na aba Status da página de + detalhes do seu crew no painel do CrewAI AOP. ## URL Base @@ -63,29 +65,33 @@ 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 /status/{kickoff_id}` até a conclusão +3. **Monitoramento**: Faça polling em `GET /{kickoff_id}/status` até a conclusão 4. **Resultados**: Extraia o output final da resposta concluída ## Tratamento de Erros A API utiliza códigos de status HTTP padrão: -| Código | Significado | -|--------|:--------------------------------------| -| `200` | Sucesso | -| `400` | Requisição Inválida - Formato de input inválido | -| `401` | Não Autorizado - Bearer token inválido | -| `404` | Não Encontrado - Recurso não existe | +| Código | Significado | +| ------ | :----------------------------------------------- | +| `200` | Sucesso | +| `400` | Requisição Inválida - Formato de input inválido | +| `401` | Não Autorizado - Bearer token inválido | +| `404` | Não Encontrado - Recurso não existe | | `422` | Erro de Validação - Inputs obrigatórios ausentes | -| `500` | Erro no Servidor - Contate o suporte | +| `500` | Erro no Servidor - Contate o suporte | ## Testes Interativos -**Por que não há botão "Enviar"?** Como cada usuário do CrewAI AOP possui sua própria URL de crew, utilizamos o **modo referência** em vez de um playground interativo para evitar confusão. Isso mostra exatamente como as requisições devem ser feitas, sem botões de envio não funcionais. + **Por que não há botão "Enviar"?** Como cada usuário do CrewAI AOP possui sua + própria URL de crew, utilizamos o **modo referência** em vez de um playground + interativo para evitar confusão. Isso mostra exatamente como as requisições + devem ser feitas, sem botões de envio não funcionais. Cada página de endpoint mostra para você: + - ✅ **Formato exato da requisição** com todos os parâmetros - ✅ **Exemplos de resposta** para casos de sucesso e erro - ✅ **Exemplos de código** em várias linguagens (cURL, Python, JavaScript, etc.) @@ -103,6 +109,7 @@ Cada página de endpoint mostra para você: **Exemplo de fluxo:** + 1. **Copie este exemplo cURL** de qualquer página de endpoint 2. **Substitua `your-actual-crew-name.crewai.com`** pela URL real do seu crew 3. **Substitua o Bearer token** pelo seu token real do painel @@ -111,10 +118,18 @@ Cada página de endpoint mostra para você: ## Precisa de Ajuda? - + Obtenha ajuda com integração da API e resolução de problemas - + Gerencie seus crews e visualize logs de execução diff --git a/docs/pt-BR/api-reference/status.mdx b/docs/pt-BR/api-reference/status.mdx index 9d0233538..6f1e1dd9c 100644 --- a/docs/pt-BR/api-reference/status.mdx +++ b/docs/pt-BR/api-reference/status.mdx @@ -1,8 +1,6 @@ --- -title: "GET /status/{kickoff_id}" +title: "GET /{kickoff_id}/status" description: "Obter o status da execução" -openapi: "/enterprise-api.pt-BR.yaml GET /status/{kickoff_id}" +openapi: "/enterprise-api.pt-BR.yaml GET /{kickoff_id}/status" mode: "wide" --- - -