mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 13:18:10 +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>
136 lines
4.6 KiB
Plaintext
136 lines
4.6 KiB
Plaintext
---
|
|
title: "Introdução"
|
|
description: "Referência completa para a API REST do CrewAI AMP"
|
|
icon: "code"
|
|
mode: "wide"
|
|
---
|
|
|
|
# CrewAI AMP API
|
|
|
|
Bem-vindo à referência da API do CrewAI AMP. Esta API permite que você interaja programaticamente com seus crews implantados, possibilitando a integração com seus aplicativos, fluxos de trabalho e serviços.
|
|
|
|
## Início Rápido
|
|
|
|
<Steps>
|
|
<Step title="Obtenha suas credenciais de API">
|
|
Navegue até a página de detalhes do seu crew no painel do CrewAI AMP e copie seu Bearer Token na aba Status.
|
|
</Step>
|
|
|
|
<Step title="Descubra os Inputs Necessários">
|
|
Use o endpoint `GET /inputs` para ver quais parâmetros seu crew espera.
|
|
</Step>
|
|
|
|
<Step title="Inicie uma Execução de Crew">
|
|
Chame `POST /kickoff` com seus inputs para iniciar a execução do crew e
|
|
receber um `kickoff_id`.
|
|
</Step>
|
|
|
|
<Step title="Monitore o Progresso">
|
|
Use `GET /status/{kickoff_id}` para checar o status da execução e recuperar os resultados.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Autenticação
|
|
|
|
Todas as requisições à API exigem autenticação usando um Bearer token. Inclua seu token no header `Authorization`:
|
|
|
|
```bash
|
|
curl -H "Authorization: Bearer YOUR_CREW_TOKEN" \
|
|
https://your-crew-url.crewai.com/inputs
|
|
```
|
|
|
|
### 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 |
|
|
|
|
<Tip>
|
|
Você pode encontrar ambos os tipos de token na aba Status da página de
|
|
detalhes do seu crew no painel do CrewAI AMP.
|
|
</Tip>
|
|
|
|
## URL Base
|
|
|
|
Cada crew implantado possui um endpoint de API único:
|
|
|
|
```
|
|
https://your-crew-name.crewai.com
|
|
```
|
|
|
|
Substitua `your-crew-name` pela URL real do seu crew no painel.
|
|
|
|
## Fluxo Típico
|
|
|
|
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
|
|
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 |
|
|
| `422` | Erro de Validação - Inputs obrigatórios ausentes |
|
|
| `500` | Erro no Servidor - Contate o suporte |
|
|
|
|
## Testes Interativos
|
|
|
|
<Info>
|
|
**Por que não há botão "Enviar"?** Como cada usuário do CrewAI AMP 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.
|
|
</Info>
|
|
|
|
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.)
|
|
- ✅ **Exemplos de autenticação** com o formato adequado de Bearer token
|
|
|
|
### **Para testar sua API de verdade:**
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Copie Exemplos cURL" icon="terminal">
|
|
Copie os exemplos cURL e substitua a URL + token por seus valores reais
|
|
</Card>
|
|
<Card title="Use Postman/Insomnia" icon="play">
|
|
Importe os exemplos na sua ferramenta de testes de API preferida
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
**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
|
|
4. **Execute a requisição** no seu terminal ou cliente de API
|
|
|
|
## Precisa de Ajuda?
|
|
|
|
<CardGroup cols={2}>
|
|
<Card
|
|
title="Suporte Enterprise"
|
|
icon="headset"
|
|
href="mailto:support@crewai.com"
|
|
>
|
|
Obtenha ajuda com integração da API e resolução de problemas
|
|
</Card>
|
|
<Card
|
|
title="Painel Enterprise"
|
|
icon="chart-line"
|
|
href="https://app.crewai.com"
|
|
>
|
|
Gerencie seus crews e visualize logs de execução
|
|
</Card>
|
|
</CardGroup>
|