API & Models

ActiveRecord models and the JSON API surface.

Database models

The persisted models the engine installs.

JSON API endpoints

Served under /rcrewai/api/v1/.

MethodPath
GET/crews
GET/crews/:id
POST/crews
POST/crews/:id/execute
GET/executions
GET/executions/:id
GET/executions/:id/status
GET/executions/:id/logs

Running executions

Executions run through ActiveJob by default.

crew.execute_async(inputs)   # enqueue (default)
crew.execute_sync(inputs)    # run inline

# Custom job options:
RcrewAI::Rails::CrewExecutionJob.set(wait: 5.minutes).perform_later(crew, inputs)