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
Authentication
All API requests require authentication using an API key:Getting an API Key
- Open the Crewship Console
- Go to Settings → API Keys
- Click Create API Key
- Copy and store the key securely
Request Format
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer YOUR_API_KEY |
Content-Type | For POST/PUT | application/json |
Request Body
POST requests accept JSON:Response Format
Success Responses
Responses return JSON objects directly:List Responses
List endpoints return arrays under a named key:Error Responses
HTTP Status Codes
| Code | Description |
|---|---|
200 | Success |
201 | Created |
202 | Accepted (async operation) |
400 | Bad request (invalid parameters) |
401 | Unauthorized (invalid API key) |
404 | Not found |
409 | Conflict (e.g., thread is busy) |
503 | Service unavailable |
SDKs
TypeScript
Coming soon
Python
Coming soon
Go
Coming soon