chore(docs): bring AMP doc refresh from release/v1.0.0 into main (#3637)
Some checks failed
CodeQL Advanced / Analyze (actions) (push) Has been cancelled
CodeQL Advanced / Analyze (python) (push) Has been cancelled
Notify Downstream / notify-downstream (push) Has been cancelled
Mark stale issues and pull requests / stale (push) Has been cancelled

* WIP: v1 docs (#3626)

(cherry picked from commit d46e20fa09bcd2f5916282f5553ddeb7183bd92c)

* docs: parity for all translations

* docs: full name of acronym AMP

* docs: fix lingering unused code

* docs: expand contextual options in docs.json

* docs: add contextual action to request feature on GitHub

* chore: tidy docs formatting
This commit is contained in:
Tony Kipkemboi
2025-10-02 11:36:04 -04:00
committed by GitHub
parent f47e0c82c4
commit bf9e0423f2
242 changed files with 8999 additions and 3637 deletions

View File

@@ -1,40 +1,40 @@
openapi: 3.0.3
info:
title: CrewAI Enterprise API
title: CrewAI AMP API
description: |
REST API para interagir com suas crews implantadas no CrewAI Enterprise.
REST API para interagir com suas crews implantadas no CrewAI AMP.
## Introdução
1. **Encontre a URL da sua crew**: Obtenha sua URL única no painel do CrewAI Enterprise
1. **Encontre a URL da sua crew**: Obtenha sua URL única no painel do CrewAI AMP
2. **Copie os exemplos**: Use os exemplos de cada endpoint como modelo
3. **Substitua os placeholders**: Atualize URLs e tokens com seus valores reais
4. **Teste com suas ferramentas**: Use cURL, Postman ou seu cliente preferido
## Autenticação
Todas as requisições exigem um token bearer. Existem dois tipos:
- **Bearer Token**: Token em nível de organização para operações completas
- **User Bearer Token**: Token com escopo de usuário com permissões limitadas
Você encontra os tokens na aba Status da sua crew no painel do CrewAI Enterprise.
Você encontra os tokens na aba Status da sua crew no painel do CrewAI AMP.
## Documentação de Referência
Este documento fornece exemplos completos para cada endpoint:
- **Formatos de requisição** com parâmetros obrigatórios e opcionais
- **Exemplos de resposta** para sucesso e erro
- **Amostras de código** em várias linguagens
- **Padrões de autenticação** com uso correto de Bearer token
Copie os exemplos e personalize com sua URL e tokens reais.
## Fluxo
1. **Descubra os inputs** usando `GET /inputs`
2. **Inicie a execução** usando `POST /kickoff`
2. **Inicie a execução** usando `POST /kickoff`
3. **Monitore o progresso** usando `GET /status/{kickoff_id}`
version: 1.0.0
contact:
@@ -43,7 +43,7 @@ info:
url: https://crewai.com
servers:
- url: https://your-actual-crew-name.crewai.com
description: Substitua pela URL real da sua crew no painel do CrewAI Enterprise
description: Substitua pela URL real da sua crew no painel do CrewAI AMP
security:
- BearerAuth: []
paths:
@@ -52,7 +52,7 @@ paths:
summary: Obter Inputs Requeridos
description: |
**📋 Exemplo de Referência** - *Mostra o formato da requisição. Para testar com sua crew real, copie o cURL e substitua URL + token.*
Retorna a lista de parâmetros de entrada que sua crew espera.
operationId: getRequiredInputs
responses:
@@ -81,7 +81,7 @@ paths:
summary: Iniciar Execução da Crew
description: |
**📋 Exemplo de Referência** - *Mostra o formato da requisição. Para testar com sua crew real, copie o cURL e substitua URL + token.*
Inicia uma nova execução da crew com os inputs fornecidos e retorna um kickoff ID.
operationId: startCrewExecution
requestBody:
@@ -102,7 +102,7 @@ paths:
interests: "games, tech, ai, relaxing hikes, amazing food"
duration: "7 days"
age: "35"
responses:
'200':
description: Execução iniciada com sucesso
@@ -125,7 +125,7 @@ paths:
summary: Obter Status da Execução
description: |
**📋 Exemplo de Referência** - *Mostra o formato da requisição. Para testar com sua crew real, copie o cURL e substitua URL + token.*
Retorna o status atual e os resultados de uma execução usando o kickoff ID.
operationId: getExecutionStatus
parameters:
@@ -163,7 +163,7 @@ components:
scheme: bearer
description: |
**📋 Referência** - *Os tokens mostrados são apenas exemplos.*
Use seus tokens reais do painel do CrewAI Enterprise.
Use seus tokens reais do painel do CrewAI AMP.
schemas:
ExecutionRunning:
@@ -180,7 +180,7 @@ components:
completed_tasks:
type: integer
total_tasks:
type: integer
type: integer
ExecutionCompleted:
type: object
@@ -265,4 +265,3 @@ components:
application/json:
schema:
$ref: '#/components/schemas/Error'