Skip to main content
POST
https://api.crewship.dev
/
v1
/
runs
curl -X POST https://api.crewship.dev/v1/runs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "deployment": "my-crew",
    "input": {
      "topic": "AI agents",
      "style": "technical"
    }
  }'

{
  "data": {
    "id": "run_xyz789abc",
    "deployment_id": "dep_abc123xyz",
    "project": "my-crew",
    "status": "pending",
    "input": {
      "topic": "AI agents",
      "style": "technical"
    },
    "created_at": "2024-01-15T10:35:00Z",
    "events_url": "https://api.crewship.dev/v1/runs/run_xyz789abc/events"
  }
}

​
Request

​
deployment
string
required
Deployment ID or project name (uses latest deployment)
​
input
object
Input data passed to your crew’s kickoff function
​
entrypoint
string
default:"default"
Entrypoint to invoke (for crews with multiple entrypoints)

​
Response

​
id
string
Run ID (e.g., run_abc123xyz)
​
deployment_id
string
Deployment ID
​
status
string
Run status: pending, running, succeeded, failed, canceled
​
created_at
string
ISO 8601 timestamp
​
events_url
string
URL to stream events
curl -X POST https://api.crewship.dev/v1/runs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "deployment": "my-crew",
    "input": {
      "topic": "AI agents",
      "style": "technical"
    }
  }'

{
  "data": {
    "id": "run_xyz789abc",
    "deployment_id": "dep_abc123xyz",
    "project": "my-crew",
    "status": "pending",
    "input": {
      "topic": "AI agents",
      "style": "technical"
    },
    "created_at": "2024-01-15T10:35:00Z",
    "events_url": "https://api.crewship.dev/v1/runs/run_xyz789abc/events"
  }
}

​
Notes

  • Runs are queued and executed asynchronously
  • Use the events_url to stream real-time updates
  • Poll the run status endpoint for completion