Skip to main content

Overview

The Crewship API allows you to programmatically:
  • Trigger and monitor runs
  • Stream real-time events
  • Manage threads for stateful conversations
  • Store and query structured data tables

Base URL

https://api.crewship.dev

Authentication

All API requests require authentication using an API key:
curl https://api.crewship.dev/v1/runs \
  -H "Authorization: Bearer YOUR_API_KEY"

Getting an API Key

  1. Open the Crewship Console
  2. Go to SettingsAPI Keys
  3. Click Create API Key
  4. Copy and store the key securely
API keys are shown only once. Store them securely and never commit them to version control.

Request Format

Headers

HeaderRequiredDescription
AuthorizationYesBearer YOUR_API_KEY
Content-TypeFor POST/PUTapplication/json

Request Body

POST requests accept JSON:
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"}
  }'

Response Format

Success Responses

Responses return JSON objects directly:
{
  "run_id": "run_abc123",
  "version_id": "ver_xyz789",
  "version_number": 3,
  "status": "running"
}

List Responses

List endpoints return arrays under a named key:
{
  "runs": [
    { "id": "run_abc123", "status": "succeeded", ... },
    { "id": "run_xyz789", "status": "running", ... }
  ]
}

Error Responses

{
  "error": {
    "message": "deployment_id is required"
  }
}

HTTP Status Codes

CodeDescription
200Success
201Created
202Accepted (async operation)
400Bad request (invalid parameters)
401Unauthorized (invalid API key)
404Not found
409Conflict (e.g., thread is busy)
503Service unavailable

SDKs

TypeScript

Coming soon

Python

Coming soon

Go

Coming soon

API Endpoints