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

{
  "run_id": "run_xyz789abc",
  "version_id": "ver_abc123xyz",
  "version_number": 3,
  "status": "running"
}

Documentation Index

Fetch the complete documentation index at: https://docs.crewship.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Request

​
deployment_id
string
required
Deployment ID
​
input
object
Input data passed to your crew’s kickoff function
​
environment
string
default:"production"
Environment to run in: production or staging

​
Response

Returns HTTP 202 (Accepted).
​
run_id
string
Run ID (e.g., run_abc123xyz)
​
version_id
string
Version ID used for this run
​
version_number
integer
Version number used for this run
​
status
string
Run status: running
curl -X POST https://api.crewship.dev/v1/runs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "deployment_id": "dep_abc123xyz",
    "input": {
      "topic": "AI agents",
      "style": "technical"
    }
  }'

{
  "run_id": "run_xyz789abc",
  "version_id": "ver_abc123xyz",
  "version_number": 3,
  "status": "running"
}

​
Notes

  • Runs are created and executed asynchronously
  • Use the Stream Events endpoint to get real-time updates
  • Poll the Get Run endpoint for completion status