mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-06 07:29:24 +00:00
a237ebabba
* feat: adopt directory-based docs versioning with Edge channel Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
179 lines
5.2 KiB
Plaintext
179 lines
5.2 KiB
Plaintext
---
|
|
title: "Kickoff Crew"
|
|
description: "Inicie um Crew no CrewAI AMP"
|
|
icon: "flag-checkered"
|
|
mode: "wide"
|
|
---
|
|
|
|
## Visão Geral
|
|
|
|
Uma vez que você tenha implantado seu crew na plataforma CrewAI AMP, é possível iniciar execuções pela interface web ou pela API. Este guia aborda ambos os métodos.
|
|
|
|
## Método 1: Usando a Interface Web
|
|
|
|
### Passo 1: Navegue até seu Crew Implantado
|
|
|
|
1. Faça login no [CrewAI AMP](https://app.crewai.com)
|
|
2. Clique no nome do crew na sua lista de projetos
|
|
3. Você será direcionado para a página de detalhes do crew
|
|
|
|
<Frame></Frame>
|
|
|
|
### Passo 2: Iniciar Execução
|
|
|
|
Na página de detalhes do seu crew, você tem duas opções para iniciar uma execução:
|
|
|
|
#### Opção A: Kickoff Rápido
|
|
|
|
1. Clique no link `Kickoff` na seção Test Endpoints
|
|
2. Insira os parâmetros de entrada necessários para seu crew no editor JSON
|
|
3. Clique no botão `Send Request`
|
|
|
|
<Frame></Frame>
|
|
|
|
#### Opção B: Usando a Interface Visual
|
|
|
|
1. Clique na aba `Run` na página de detalhes do crew
|
|
2. Insira os inputs necessários nos campos do formulário
|
|
3. Clique no botão `Run Crew`
|
|
|
|
<Frame></Frame>
|
|
|
|
### Passo 3: Monitorar o Progresso da Execução
|
|
|
|
Após iniciar a execução:
|
|
|
|
1. Você receberá uma resposta contendo um `kickoff_id` - **copie este ID**
|
|
2. Esse ID é fundamental para o acompanhamento da sua execução
|
|
|
|
<Frame></Frame>
|
|
|
|
### Passo 4: Verificar o Status da Execução
|
|
|
|
Para monitorar o andamento da sua execução:
|
|
|
|
1. Clique no endpoint "Status" na seção Test Endpoints
|
|
2. Cole o `kickoff_id` no campo indicado
|
|
3. Clique no botão "Get Status"
|
|
|
|
<Frame></Frame>
|
|
|
|
A resposta de status mostrará:
|
|
|
|
- Estado atual da execução (`running`, `completed`, etc.)
|
|
- Detalhes sobre quais tarefas estão em andamento
|
|
- Quaisquer outputs gerados até o momento
|
|
|
|
### Passo 5: Visualizar Resultados Finais
|
|
|
|
Quando a execução for concluída:
|
|
|
|
1. O status mudará para `completed`
|
|
2. Você poderá visualizar todos os resultados e outputs da execução
|
|
3. Para uma visão mais detalhada, acesse a aba `Executions` na página de detalhes do crew
|
|
|
|
## Método 2: Usando a API
|
|
|
|
Você também pode iniciar crews programaticamente usando a REST API do CrewAI AMP.
|
|
|
|
### Autenticação
|
|
|
|
Todas as requisições à API exigem um bearer token para autenticação:
|
|
|
|
```bash
|
|
curl -H "Authorization: Bearer YOUR_CREW_TOKEN" https://your-crew-url.crewai.com
|
|
```
|
|
|
|
Seu bearer token está disponível na aba Status na página de detalhes do seu crew.
|
|
|
|
### Verificando o Status do Crew
|
|
|
|
Antes de executar operações, você pode verificar se seu crew está funcionando corretamente:
|
|
|
|
```bash
|
|
curl -H "Authorization: Bearer YOUR_CREW_TOKEN" https://your-crew-url.crewai.com
|
|
```
|
|
|
|
Uma resposta de sucesso trará uma mensagem indicando que o crew está operacional:
|
|
|
|
```
|
|
Healthy%
|
|
```
|
|
|
|
### Passo 1: Recuperar Entradas Necessárias
|
|
|
|
Primeiro, descubra quais entradas seu crew exige:
|
|
|
|
```bash
|
|
curl -X GET \
|
|
-H "Authorization: Bearer YOUR_CREW_TOKEN" \
|
|
https://your-crew-url.crewai.com/inputs
|
|
```
|
|
|
|
A resposta será um objeto JSON contendo um array de parâmetros de entrada obrigatórios, por exemplo:
|
|
|
|
```json
|
|
{ "inputs": ["topic", "current_year"] }
|
|
```
|
|
|
|
Este exemplo mostra que este crew em particular requer dois inputs: `topic` e `current_year`.
|
|
|
|
### Passo 2: Iniciar Execução
|
|
|
|
Inicie a execução fornecendo os inputs obrigatórios:
|
|
|
|
```bash
|
|
curl -X POST \
|
|
-H "Content-Type: application/json" \
|
|
-H "Authorization: Bearer YOUR_CREW_TOKEN" \
|
|
-d '{"inputs": {"topic": "AI Agent Frameworks", "current_year": "2025"}}' \
|
|
https://your-crew-url.crewai.com/kickoff
|
|
```
|
|
|
|
A resposta incluirá um `kickoff_id` que você precisará para o acompanhamento:
|
|
|
|
```json
|
|
{ "kickoff_id": "abcd1234-5678-90ef-ghij-klmnopqrstuv" }
|
|
```
|
|
|
|
### Passo 3: Verificar Status da Execução
|
|
|
|
Acompanhe o progresso da execução usando o kickoff_id:
|
|
|
|
```bash
|
|
curl -X GET \
|
|
-H "Authorization: Bearer YOUR_CREW_TOKEN" \
|
|
https://your-crew-url.crewai.com/status/abcd1234-5678-90ef-ghij-klmnopqrstuv
|
|
```
|
|
|
|
## Gerenciando Execuções
|
|
|
|
### Execuções de Longa Duração
|
|
|
|
Para execuções que possam demandar mais tempo:
|
|
|
|
1. Considere implementar um mecanismo de polling para verificar status periodicamente
|
|
2. Utilize webhooks (se disponíveis) para notificação quando a execução for concluída
|
|
3. Implemente tratamento de erros para possíveis timeouts
|
|
|
|
### Contexto da Execução
|
|
|
|
O contexto da execução inclui:
|
|
|
|
- Inputs fornecidos no momento do kickoff
|
|
- Variáveis de ambiente configuradas durante o deploy
|
|
- Qualquer estado mantido entre as tarefas
|
|
|
|
### Depuração de Execuções com Falha
|
|
|
|
Se uma execução falhar:
|
|
|
|
1. Verifique a aba "Executions" para logs detalhados
|
|
2. Avalie a aba "Traces" para detalhes passo a passo da execução
|
|
3. Procure por respostas LLM e uso de ferramentas nos detalhes do trace
|
|
|
|
<Card title="Precisa de Ajuda?" icon="headset" href="mailto:support@crewai.com">
|
|
Entre em contato com nossa equipe de suporte para obter ajuda com problemas de
|
|
execução ou dúvidas sobre a plataforma Enterprise.
|
|
</Card>
|