mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 21:28: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.2 KiB
Plaintext
136 lines
4.2 KiB
Plaintext
---
|
|
title: "Introduction"
|
|
description: "Complete reference for the CrewAI AMP REST API"
|
|
icon: "code"
|
|
mode: "wide"
|
|
---
|
|
|
|
# CrewAI AMP API
|
|
|
|
Welcome to the CrewAI AMP API reference. This API allows you to programmatically interact with your deployed crews, enabling integration with your applications, workflows, and services.
|
|
|
|
## Quick Start
|
|
|
|
<Steps>
|
|
<Step title="Get Your API Credentials">
|
|
Navigate to your crew's detail page in the CrewAI AMP dashboard and copy your Bearer Token from the Status tab.
|
|
</Step>
|
|
|
|
<Step title="Discover Required Inputs">
|
|
Use the `GET /inputs` endpoint to see what parameters your crew expects.
|
|
</Step>
|
|
|
|
<Step title="Start a Crew Execution">
|
|
Call `POST /kickoff` with your inputs to start the crew execution and receive
|
|
a `kickoff_id`.
|
|
</Step>
|
|
|
|
<Step title="Monitor Progress">
|
|
Use `GET /{kickoff_id}/status` to check execution status and retrieve results.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Authentication
|
|
|
|
All API requests require authentication using a Bearer token. Include your token in the `Authorization` header:
|
|
|
|
```bash
|
|
curl -H "Authorization: Bearer YOUR_CREW_TOKEN" \
|
|
https://your-crew-url.crewai.com/inputs
|
|
```
|
|
|
|
### 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 |
|
|
|
|
<Tip>
|
|
You can find both token types in the Status tab of your crew's detail page in
|
|
the CrewAI AMP dashboard.
|
|
</Tip>
|
|
|
|
## Base URL
|
|
|
|
Each deployed crew has its own unique API endpoint:
|
|
|
|
```
|
|
https://your-crew-name.crewai.com
|
|
```
|
|
|
|
Replace `your-crew-name` with your actual crew's URL from the dashboard.
|
|
|
|
## Typical Workflow
|
|
|
|
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
|
|
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 |
|
|
| `422` | Validation Error - Missing required inputs |
|
|
| `500` | Server Error - Contact support |
|
|
|
|
## Interactive Testing
|
|
|
|
<Info>
|
|
**Why no "Send" button?** Since each CrewAI AMP 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.
|
|
</Info>
|
|
|
|
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.)
|
|
- ✅ **Authentication examples** with proper Bearer token format
|
|
|
|
### **To Test Your Actual API:**
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Copy cURL Examples" icon="terminal">
|
|
Copy the cURL examples and replace the URL + token with your real values
|
|
</Card>
|
|
<Card title="Use Postman/Insomnia" icon="play">
|
|
Import the examples into your preferred API testing tool
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
**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
|
|
4. **Run the request** in your terminal or API client
|
|
|
|
## Need Help?
|
|
|
|
<CardGroup cols={2}>
|
|
<Card
|
|
title="Enterprise Support"
|
|
icon="headset"
|
|
href="mailto:support@crewai.com"
|
|
>
|
|
Get help with API integration and troubleshooting
|
|
</Card>
|
|
<Card
|
|
title="Enterprise Dashboard"
|
|
icon="chart-line"
|
|
href="https://app.crewai.com"
|
|
>
|
|
Manage your crews and view execution logs
|
|
</Card>
|
|
</CardGroup>
|