mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-09-29 14:13:33 +00:00
Compare commits
1 Commits
main
...
fix/status
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5340a98e5b |
97
.github/security.md
vendored
97
.github/security.md
vendored
@@ -1,92 +1,15 @@
|
||||
# Security policy
|
||||
## CrewAI Security Policy
|
||||
|
||||
Thank you for helping keep CrewAI and the people who use it safe. This page
|
||||
explains how to report a security issue, what to include, what is in scope,
|
||||
and what you can expect from us.
|
||||
We are committed to protecting the confidentiality, integrity, and availability of the
|
||||
CrewAI ecosystem.
|
||||
|
||||
## How to report
|
||||
### How to Report
|
||||
|
||||
- **A vulnerability in this repository's code:** open a private report at
|
||||
https://github.com/crewAIInc/crewAI/security/advisories/new. The details
|
||||
stay private, and we can work on the fix, the advisory, and the CVE with
|
||||
you in one place.
|
||||
- **Anything else** (the CrewAI platform at app.crewai.com, Factory,
|
||||
crewAI-tools, another CrewAI service, or you are not sure where it
|
||||
belongs): email **security@crewai.com**.
|
||||
Please submit reports through one of the following channels:
|
||||
|
||||
Please do not report security issues through public GitHub issues, pull
|
||||
requests, discussions, or social media.
|
||||
- **crewai-vdp-ess@submit.bugcrowd.com**
|
||||
- https://security.crewai.com
|
||||
|
||||
## What to include
|
||||
|
||||
- The product and the version, commit, or URL affected.
|
||||
- Where the problem is: endpoint, file, function, or setting.
|
||||
- Steps to reproduce, or a proof of concept. Plain text beats screenshots;
|
||||
please do not send executables.
|
||||
- What an attacker could do with it.
|
||||
- How you would like to be credited, if at all.
|
||||
|
||||
## Scope
|
||||
|
||||
- crewAI (this repository) and crewAI-tools
|
||||
- The CrewAI AMP platform at app.crewai.com
|
||||
- CrewAI Factory releases
|
||||
|
||||
## Out of scope
|
||||
|
||||
- Third-party services and sites CrewAI does not operate
|
||||
- Denial of service, load testing, and other volumetric testing
|
||||
- Social engineering and physical attacks
|
||||
- Scanner output without demonstrated impact: missing headers, SPF, DMARC
|
||||
or CAA records, version banners, rate limiting
|
||||
- Generic "the LLM can be jailbroken" findings without a crewAI-specific
|
||||
defect
|
||||
- trust.crewai.com, which is operated by Vanta, except where the finding
|
||||
concerns CrewAI's own content on it
|
||||
|
||||
If a report is out of scope, we will tell you so in one reply.
|
||||
|
||||
## What we commit to
|
||||
|
||||
- Acknowledgment within 2 business days.
|
||||
- A substantive response within 10 business days: confirmed, not
|
||||
reproducible, out of scope, already known, or still investigating with a
|
||||
date for the next update.
|
||||
- An update at least every 14 days until the report is closed.
|
||||
- Coordinated disclosure. We publish the fix and the advisory together, by
|
||||
default within 90 days of acknowledgment; earlier if the fix ships sooner,
|
||||
later only by agreement with you.
|
||||
- A CVE, through GitHub's CNA, for confirmed vulnerabilities in publicly
|
||||
distributed CrewAI products.
|
||||
- Credit in the advisory if you want it.
|
||||
|
||||
## Bounties
|
||||
|
||||
CrewAI does not run a paid bug bounty program. We credit reporters who want
|
||||
credit.
|
||||
|
||||
## Safe harbor
|
||||
|
||||
CrewAI will not pursue or support legal action against anyone who reports a
|
||||
security issue in good faith and follows these rules:
|
||||
|
||||
- Test only against your own account, your own self-hosted Factory instance,
|
||||
or your own copy of our open-source software.
|
||||
- Do not access, modify, copy, or keep data that is not yours. If you
|
||||
encounter customer or personal data, stop and tell us immediately.
|
||||
- Do not degrade our service: no denial-of-service testing, no bulk automated
|
||||
scanning against AMP, no spam.
|
||||
- No social engineering of CrewAI staff, customers, or vendors; no physical
|
||||
attempts against CrewAI property.
|
||||
- Report promptly via private vulnerability reporting for this repository's
|
||||
code, or security@crewai.com for other issues. Give us the agreed time to
|
||||
fix before disclosing publicly.
|
||||
|
||||
Good-faith research within these rules is authorized access for the purposes
|
||||
of applicable computer misuse laws. Activity outside these rules is not
|
||||
covered.
|
||||
|
||||
## Canonical policy
|
||||
|
||||
This page is the canonical version of CrewAI's disclosure policy. A copy at
|
||||
https://crewai.com/security will link back here.
|
||||
- **Please do not** disclose vulnerabilities via public GitHub issues, pull requests,
|
||||
or social media
|
||||
- Reports submitted via channels other than the methods above will not be reviewed and will be dismissed
|
||||
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -27,7 +27,6 @@ conceptual_plan.md
|
||||
build_image
|
||||
chromadb-*.lock
|
||||
.claude
|
||||
.codex
|
||||
.crewai/memory
|
||||
blogs/*
|
||||
secrets/*
|
||||
|
||||
1594
docs/docs.json
1594
docs/docs.json
File diff suppressed because it is too large
Load Diff
@@ -4,44 +4,6 @@ description: "تحديثات المنتج والتحسينات وإصلاحات
|
||||
icon: "clock"
|
||||
mode: "wide"
|
||||
---
|
||||
<Update label="28 سبتمبر 2026">
|
||||
## v1.15.23
|
||||
|
||||
[عرض الإصدار على GitHub](https://github.com/crewAIInc/crewAI/releases/tag/1.15.23)
|
||||
|
||||
## ما الذي تغير
|
||||
|
||||
### الميزات
|
||||
- إضافة دعم لـ Gemini 3.8 Flash الأصلي
|
||||
- تنفيذ تقييم آخر تشغيل تم تتبعه من خلال AMP في crewai eval
|
||||
- تسجيل آخر تشغيل تم تتبعه لـ crewai eval بدلاً من طباعته
|
||||
- تحسين تجربة إعداد تكامل المنصة
|
||||
- إعطاء الأولوية لتكاملات المنصة الشائعة
|
||||
- تعزيز مهام تتبع الفترات لتشمل تنسيق الإخراج المعلن والنتائج
|
||||
|
||||
### إصلاحات الأخطاء
|
||||
- إصلاح رؤية اللوحة لعرض التتبع
|
||||
- حل مشكلة تشغيل التتبع وإضافة زر تقييم في TUI
|
||||
- إعادة محاولة استدعاءات المزود المقيدة في LLM
|
||||
- العودة إلى الاستدعاءات المتزامنة من acall في Bedrock
|
||||
- طباعة المناطق التي تم تقييمها في CLI
|
||||
- التأكد من عرض الرابط بعد إنهاء التتبع
|
||||
- الحفاظ على قابلية إعادة استخدام برنامج تشغيل Selenium
|
||||
- إغلاق أجسام استجابة S3 بشكل صحيح
|
||||
- طي المحتوى متعدد الوسائط بمساعدة مشتركة
|
||||
- مطابقة الأدوار في LLM overlay التي تختلف فقط بواسطة المسافات المحيطة
|
||||
- إغلاق اتصالات SQLite في تدفق الاستمرارية ومزود SQLite
|
||||
- الحفاظ على مسارات قائمة الدلائل
|
||||
|
||||
### الوثائق
|
||||
- تحديث الأدلة للمساعدين إلى أدوات المنصة
|
||||
|
||||
## المساهمون
|
||||
|
||||
@Copilot, @Mairaarshad19, @SharoonSharif, @Vidit-Ostwal, @gaoanze888, @joaomdmoura, @lorenzejay, @sclfcz, @stepchanges, @vinibrsl
|
||||
|
||||
</Update>
|
||||
|
||||
<Update label="16 سبتمبر 2026">
|
||||
## v1.15.22
|
||||
|
||||
|
||||
@@ -4,44 +4,6 @@ description: "Product updates, improvements, and bug fixes for CrewAI"
|
||||
icon: "clock"
|
||||
mode: "wide"
|
||||
---
|
||||
<Update label="Sep 28, 2026">
|
||||
## v1.15.23
|
||||
|
||||
[View release on GitHub](https://github.com/crewAIInc/crewAI/releases/tag/1.15.23)
|
||||
|
||||
## What's Changed
|
||||
|
||||
### Features
|
||||
- Add support for native Gemini 3.8 Flash
|
||||
- Implement evaluation of the last traced run through AMP in crewai eval
|
||||
- Record the last traced run for crewai eval instead of printing it
|
||||
- Improve platform integration setup UX
|
||||
- Prioritize popular platform integrations
|
||||
- Enhance tracing task spans to include declared output format and results
|
||||
|
||||
### Bug Fixes
|
||||
- Fix visibility of the panel for viewing traces
|
||||
- Resolve issue with turning tracing on and add an Evaluate button in the TUI
|
||||
- Retry throttled provider calls in LLM
|
||||
- Fall back to synchronous calls from acall in Bedrock
|
||||
- Print areas graded by the evaluation in CLI
|
||||
- Ensure link is shown after finalizing traces
|
||||
- Keep Selenium driver reusable
|
||||
- Close S3 response bodies properly
|
||||
- Collapse multimodal content with shared helper
|
||||
- Match roles in LLM overlay that differ only by surrounding whitespace
|
||||
- Close SQLite connections in flow persistence and SQLite provider
|
||||
- Preserve directory listing paths
|
||||
|
||||
### Documentation
|
||||
- Update guides for assistants to platform tools
|
||||
|
||||
## Contributors
|
||||
|
||||
@Copilot, @Mairaarshad19, @SharoonSharif, @Vidit-Ostwal, @gaoanze888, @joaomdmoura, @lorenzejay, @sclfcz, @stepchanges, @vinibrsl
|
||||
|
||||
</Update>
|
||||
|
||||
<Update label="Sep 16, 2026">
|
||||
## v1.15.22
|
||||
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -4,44 +4,6 @@ description: "CrewAI의 제품 업데이트, 개선 사항 및 버그 수정"
|
||||
icon: "clock"
|
||||
mode: "wide"
|
||||
---
|
||||
<Update label="2026년 9월 28일">
|
||||
## v1.15.23
|
||||
|
||||
[GitHub 릴리스 보기](https://github.com/crewAIInc/crewAI/releases/tag/1.15.23)
|
||||
|
||||
## 변경 사항
|
||||
|
||||
### 기능
|
||||
- 네이티브 Gemini 3.8 Flash 지원 추가
|
||||
- crewai eval을 통해 마지막으로 추적된 실행 평가 구현
|
||||
- 출력 대신 crewai eval을 위한 마지막 추적 실행 기록
|
||||
- 플랫폼 통합 설정 UX 개선
|
||||
- 인기 있는 플랫폼 통합 우선 순위 지정
|
||||
- 선언된 출력 형식 및 결과를 포함하도록 추적 작업 범위 향상
|
||||
|
||||
### 버그 수정
|
||||
- 추적 보기 패널의 가시성 수정
|
||||
- 추적 활성화 문제 해결 및 TUI에 평가 버튼 추가
|
||||
- LLM에서 제한된 공급자 호출 재시도
|
||||
- Bedrock에서 acall의 동기 호출로 대체
|
||||
- CLI에서 평가에 의해 채점된 영역 출력
|
||||
- 추적 최종화 후 링크 표시 보장
|
||||
- Selenium 드라이버 재사용 가능 유지
|
||||
- S3 응답 본문을 적절히 닫기
|
||||
- 공유 도우미로 다중 모드 콘텐츠 축소
|
||||
- 주변 공백만 다른 LLM 오버레이의 역할 일치
|
||||
- 흐름 지속성 및 SQLite 공급자에서 SQLite 연결 닫기
|
||||
- 디렉토리 목록 경로 보존
|
||||
|
||||
### 문서
|
||||
- 플랫폼 도구에 대한 보조 가이드 업데이트
|
||||
|
||||
## 기여자
|
||||
|
||||
@Copilot, @Mairaarshad19, @SharoonSharif, @Vidit-Ostwal, @gaoanze888, @joaomdmoura, @lorenzejay, @sclfcz, @stepchanges, @vinibrsl
|
||||
|
||||
</Update>
|
||||
|
||||
<Update label="2026년 9월 16일">
|
||||
## v1.15.22
|
||||
|
||||
|
||||
@@ -4,44 +4,6 @@ description: "Atualizações de produto, melhorias e correções do CrewAI"
|
||||
icon: "clock"
|
||||
mode: "wide"
|
||||
---
|
||||
<Update label="28 set 2026">
|
||||
## v1.15.23
|
||||
|
||||
[Ver release no GitHub](https://github.com/crewAIInc/crewAI/releases/tag/1.15.23)
|
||||
|
||||
## O Que Mudou
|
||||
|
||||
### Recursos
|
||||
- Adicionar suporte para Flash nativo do Gemini 3.8
|
||||
- Implementar a avaliação da última execução rastreada através do AMP na avaliação do crewai
|
||||
- Registrar a última execução rastreada para a avaliação do crewai em vez de imprimi-la
|
||||
- Melhorar a experiência do usuário na configuração de integração da plataforma
|
||||
- Priorizar integrações populares da plataforma
|
||||
- Aprimorar as spans de tarefas de rastreamento para incluir o formato de saída declarado e os resultados
|
||||
|
||||
### Correções de Bugs
|
||||
- Corrigir a visibilidade do painel para visualização de rastros
|
||||
- Resolver problema com a ativação do rastreamento e adicionar um botão Avaliar na TUI
|
||||
- Repetir chamadas de provedores limitados no LLM
|
||||
- Reverter para chamadas síncronas a partir de acall no Bedrock
|
||||
- Imprimir áreas avaliadas pela avaliação no CLI
|
||||
- Garantir que o link seja exibido após a finalização dos rastros
|
||||
- Manter o driver Selenium reutilizável
|
||||
- Fechar corretamente os corpos de resposta do S3
|
||||
- Colapsar conteúdo multimodal com um helper compartilhado
|
||||
- Combinar funções na sobreposição do LLM que diferem apenas por espaços em branco ao redor
|
||||
- Fechar conexões SQLite na persistência de fluxo e provedor SQLite
|
||||
- Preservar caminhos de listagem de diretórios
|
||||
|
||||
### Documentação
|
||||
- Atualizar guias para assistentes das ferramentas da plataforma
|
||||
|
||||
## Contribuidores
|
||||
|
||||
@Copilot, @Mairaarshad19, @SharoonSharif, @Vidit-Ostwal, @gaoanze888, @joaomdmoura, @lorenzejay, @sclfcz, @stepchanges, @vinibrsl
|
||||
|
||||
</Update>
|
||||
|
||||
<Update label="16 set 2026">
|
||||
## v1.15.22
|
||||
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -105,10 +105,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/ExecutionRunning'
|
||||
- $ref: '#/components/schemas/ExecutionCompleted'
|
||||
- $ref: '#/components/schemas/ExecutionError'
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
'401':
|
||||
$ref: '#/components/responses/UnauthorizedError'
|
||||
'404':
|
||||
@@ -257,50 +254,109 @@ components:
|
||||
**📋 참고** - *예시의 토큰은 자리 표시자입니다.* 실제 토큰을 사용하세요.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/TaskResult'
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -141,10 +141,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -294,50 +291,109 @@ components:
|
||||
Use seus tokens reais do painel do CrewAI AMP.
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
total_tasks:
|
||||
type: integer
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
execution_time:
|
||||
type: number
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
@@ -215,10 +215,10 @@ paths:
|
||||
|
||||
Retrieves the current status and results of a crew execution using its kickoff ID.
|
||||
|
||||
The response structure varies depending on the execution state:
|
||||
- **running**: Execution in progress with current task info
|
||||
- **completed**: Execution finished with full results
|
||||
- **error**: Execution failed with error details
|
||||
The response returns a `TaskStatus` object with the execution state and details.
|
||||
The `state` field indicates the current execution state: `PENDING`, `STARTED`, `RUNNING`,
|
||||
`SUCCESS`, `FAILED`, `PAUSED`, `REVOKED`, or `NOT FOUND`.
|
||||
The `status` field contains an optional human-readable message (null on success).
|
||||
operationId: getExecutionStatus
|
||||
parameters:
|
||||
- name: kickoff_id
|
||||
@@ -235,41 +235,47 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
oneOf:
|
||||
- $ref: "#/components/schemas/ExecutionRunning"
|
||||
- $ref: "#/components/schemas/ExecutionCompleted"
|
||||
- $ref: "#/components/schemas/ExecutionError"
|
||||
$ref: "#/components/schemas/TaskStatus"
|
||||
examples:
|
||||
running:
|
||||
summary: Execution in progress
|
||||
value:
|
||||
status: "running"
|
||||
current_task: "research_task"
|
||||
state: "RUNNING"
|
||||
status: null
|
||||
result: null
|
||||
progress:
|
||||
completed_tasks: 1
|
||||
total_tasks: 3
|
||||
completed:
|
||||
completed: 1
|
||||
total: 3
|
||||
current: "research_task"
|
||||
current_agent: "Travel Researcher"
|
||||
source: "application"
|
||||
success:
|
||||
summary: Execution completed successfully
|
||||
value:
|
||||
status: "completed"
|
||||
result:
|
||||
output: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
tasks:
|
||||
- task_id: "research_task"
|
||||
output: "Research findings on tech destinations in Japan..."
|
||||
agent: "Travel Researcher"
|
||||
execution_time: 45.2
|
||||
- task_id: "planning_task"
|
||||
output: "7-day detailed itinerary with activities and recommendations..."
|
||||
agent: "Trip Planner"
|
||||
execution_time: 62.8
|
||||
execution_time: 108.5
|
||||
error:
|
||||
state: "SUCCESS"
|
||||
status: null
|
||||
result: "Comprehensive travel itinerary for 7 days in Japan focusing on tech culture..."
|
||||
result_json: null
|
||||
usage_metrics:
|
||||
total_tokens: 15230
|
||||
prompt_tokens: 12100
|
||||
completion_tokens: 3130
|
||||
source: "memory"
|
||||
failed:
|
||||
summary: Execution failed
|
||||
value:
|
||||
status: "error"
|
||||
error: "Task execution failed: Invalid API key for external service"
|
||||
execution_time: 23.1
|
||||
state: "FAILED"
|
||||
status: "Task execution failed: Invalid API key for external service"
|
||||
result: null
|
||||
source: "memory"
|
||||
paused:
|
||||
summary: Execution paused for human input
|
||||
value:
|
||||
state: "PAUSED"
|
||||
status: "Waiting for human feedback"
|
||||
result: null
|
||||
flow_id: "flow-abc123"
|
||||
source: "application"
|
||||
"401":
|
||||
$ref: "#/components/responses/UnauthorizedError"
|
||||
"404":
|
||||
@@ -426,67 +432,109 @@ components:
|
||||
**User Bearer Token**: User-scoped access with limited permissions
|
||||
|
||||
schemas:
|
||||
ExecutionRunning:
|
||||
TaskStatus:
|
||||
type: object
|
||||
description: Execution status response from the CrewAI API
|
||||
required:
|
||||
- state
|
||||
- source
|
||||
properties:
|
||||
state:
|
||||
type: string
|
||||
enum: ["PENDING", "STARTED", "RUNNING", "SUCCESS", "FAILED", "PAUSED", "REVOKED", "NOT FOUND"]
|
||||
description: Primary execution state
|
||||
status:
|
||||
type: string
|
||||
enum: ["running"]
|
||||
example: "running"
|
||||
current_task:
|
||||
nullable: true
|
||||
description: Human-readable status message. Null on success.
|
||||
result:
|
||||
nullable: true
|
||||
description: The execution output (present on success)
|
||||
result_json:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Parsed JSON result if the output is valid JSON
|
||||
usage_metrics:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Token usage metrics for the execution
|
||||
properties:
|
||||
total_tokens:
|
||||
type: integer
|
||||
prompt_tokens:
|
||||
type: integer
|
||||
completion_tokens:
|
||||
type: integer
|
||||
flow_id:
|
||||
type: string
|
||||
description: Name of the currently executing task
|
||||
example: "research_task"
|
||||
nullable: true
|
||||
description: Flow ID (present when state is PAUSED)
|
||||
last_step:
|
||||
nullable: true
|
||||
description: Information about the last step executed
|
||||
last_executed_task:
|
||||
nullable: true
|
||||
description: Details of the last executed task
|
||||
last_event:
|
||||
type: object
|
||||
nullable: true
|
||||
description: The most recent event
|
||||
events:
|
||||
type: array
|
||||
nullable: true
|
||||
description: List of execution events
|
||||
events_count:
|
||||
type: integer
|
||||
nullable: true
|
||||
description: Total number of events
|
||||
events_by_type:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Events grouped by type
|
||||
progress:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Execution progress details
|
||||
properties:
|
||||
completed_tasks:
|
||||
type: integer
|
||||
description: Number of completed tasks
|
||||
example: 1
|
||||
total_tasks:
|
||||
type: integer
|
||||
description: Total number of tasks in the crew
|
||||
example: 3
|
||||
|
||||
ExecutionCompleted:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum: ["completed"]
|
||||
example: "completed"
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
output:
|
||||
unit:
|
||||
type: string
|
||||
description: Final output from the crew execution
|
||||
example: "Comprehensive travel itinerary..."
|
||||
tasks:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/TaskResult"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Total execution time in seconds
|
||||
example: 108.5
|
||||
|
||||
ExecutionError:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
completed:
|
||||
type: integer
|
||||
total:
|
||||
type: integer
|
||||
remaining:
|
||||
type: integer
|
||||
current:
|
||||
type: string
|
||||
description: Current task name
|
||||
current_agent:
|
||||
type: string
|
||||
description: Name of the currently active agent
|
||||
started_at:
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
duration_seconds:
|
||||
type: number
|
||||
triggered_by:
|
||||
type: object
|
||||
nullable: true
|
||||
description: Information about who triggered the execution
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
id:
|
||||
type: string
|
||||
execution_origin:
|
||||
type: string
|
||||
enum: ["error"]
|
||||
example: "error"
|
||||
error:
|
||||
nullable: true
|
||||
description: Origin of the execution
|
||||
source:
|
||||
type: string
|
||||
description: Error message describing what went wrong
|
||||
example: "Task execution failed: Invalid API key"
|
||||
execution_time:
|
||||
type: number
|
||||
description: Time until error occurred in seconds
|
||||
example: 23.1
|
||||
enum: ["memory", "application"]
|
||||
description: Where the status was retrieved from
|
||||
|
||||
TaskResult:
|
||||
type: object
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user