CrewAI Cloud

opencollection: 1.0.0
info:
  name: CrewAI AMP REST API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Inputs
    type: folder
  items:
  - info:
      name: List Required Crew Inputs
      type: http
    http:
      method: GET
      url: https://{crewName}.crewai.com/inputs
    docs: 'Retrieves the list of input parameter names this crew expects when you kick it off.

      Use this to discover the keys you must populate in the `inputs` object on `POST /kickoff`.

      '
- info:
    name: Kickoff
    type: folder
  items:
  - info:
      name: Kick Off Crew Execution
      type: http
    http:
      method: POST
      url: https://{crewName}.crewai.com/kickoff
      body:
        type: json
        data: '{}'
    docs: 'Launches a crew execution with the supplied inputs and optional webhook callback URLs.

      Returns a `kickoff_id` you can use with `GET /status/{kickoff_id}` to poll progress

      or to correlate webhook events.

      '
- info:
    name: Status
    type: folder
  items:
  - info:
      name: Get Kickoff Status
      type: http
    http:
      method: GET
      url: https://{crewName}.crewai.com/status/:kickoff_id
      params:
      - name: kickoff_id
        value: ''
        type: path
        description: UUID returned by `POST /kickoff`.
    docs: 'Returns the current status of a crew execution identified by `kickoff_id`. The response

      shape varies by state: `running` includes current task and progress; `completed` includes

      per-task outputs and total execution time; `error` includes an error message.

      '
- info:
    name: Resume
    type: folder
  items:
  - info:
      name: Resume Crew with Human Feedback
      type: http
    http:
      method: POST
      url: https://{crewName}.crewai.com/resume
      body:
        type: json
        data: '{}'
    docs: 'Resumes a crew execution that paused for human-in-the-loop review. Supply

      `execution_id` and `task_id`, the reviewer''s `human_feedback`, and `is_approve`

      (`true` to proceed, `false` to retry the task with the feedback as additional context).

      '
bundled: true