Download OpenAPI specification:Download
Public API endpoints for Gravy Connect (no authentication required)
Retrieve history items with pagination, filtering, and sorting support
| connectionId required | string Connection ID |
| page | number Default: 1 Example: page=1 Page number (1-based) |
| limit | number [ 1 .. 100 ] Default: 20 Example: limit=20 Items per page (1-100) |
| sortBy | string Enum: "createdAt" "updatedAt" "title" "type" Sort field |
| sortOrder | string Enum: "asc" "desc" Sort order |
| type | string Example: type=book Filter by type (book/movie) |
| search | string Example: search=Harry Potter Search by title |
| startDate | string Example: startDate=2024-01-01T00:00:00.000Z Filter by start date (ISO) |
| endDate | string Example: endDate=2024-12-31T23:59:59.999Z Filter by end date (ISO) |
{- "data": [
- {
- "id": "string",
- "type": "book",
- "progress": 50,
- "title": "string",
- "authors": [
- "string"
], - "isbn": "string",
- "isbn13": "string",
- "isbn10": "string",
- "asin": "string",
- "description": "string",
- "read": true,
- "thumbnailUrl": "string"
}
], - "meta": {
- "page": 1,
- "limit": 20,
- "total": 150,
- "totalPages": 8,
- "hasNext": true,
- "hasPrev": false,
- "itemCount": 20
}, - "timestamp": "2024-01-15T10:30:00.000Z",
- "version": "v1"
}| page | number Default: 1 Example: page=1 Page number (1-based) |
| limit | number [ 1 .. 100 ] Default: 20 Example: limit=20 Number of items per page |
| sortBy | string Default: "createdAt" Enum: "createdAt" "updatedAt" Sort by field |
| sortOrder | string Default: "desc" Enum: "asc" "desc" Sort order |
| status | string Example: status=connected Filter by status |
| integrationId | string Example: integrationId=spotify Filter by integration ID |
{- "data": [
- {
- "id": "string",
- "integrationId": "string",
- "status": "pending",
- "connectionMetadata": { }
}
], - "meta": {
- "page": 1,
- "limit": 20,
- "total": 150,
- "totalPages": 8,
- "hasNext": true,
- "hasPrev": false,
- "itemCount": 20
}, - "timestamp": "2024-01-15T10:30:00.000Z",
- "version": "v1"
}| integrationId required | string The integration ID |
| products required | Array of strings Deprecated The products to be requested |
| userId required | string The client managed user ID |
| prompts required | Array of arrays AI Prompts to be used for the connection. Each prompt contains a name (key) and value (instruction) that will be used to customize the AI behavior for this connection. |
| debug required | boolean Whether the intent token is for debug purposes |
{- "integrationId": "audible",
- "products": [
- "history"
], - "userId": "123",
- "prompts": [
- {
- "name": "roast",
- "value": "roast me in the style of Jeff Ross"
}
], - "debug": false
}{- "intentToken": "123",
- "connectionId": "123",
- "debug": false
}Exchange client credentials for an access token using OAuth 2.0 client credentials flow
| grant_type required | string The grant type |
| client_id required | string The client ID |
| client_secret required | string The client secret |
| scope required | string The scope |
{- "grant_type": "client_credentials",
- "client_id": "123",
- "client_secret": "123",
- "scope": "read write"
}{- "access_token": "123",
- "token_type": "Bearer",
- "expires_in": 3600,
- "scope": "read write"
}