Get a Knap
Retrieve a specific Knap by UUID.
Get details for a specific Knap by its UUID.
Endpoint
GET /api/studio/knap-tools/{knap_tool_uuid}Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
knap_tool_uuid | string | Yes | UUID of the Knap to retrieve |
Request
No request body required.
Response
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"name": "Weekly Report Generator",
"creation_user_id": 123,
"schedule_type": "scheduled",
"is_active": true,
"visibility": "private",
"can_toggle_default_active": false,
"active_by_default": true,
"tool_metadata": {
"action_description": "Generate weekly reports from emails and meetings",
"schedule_description": "every Monday at 9am"
},
"creation_timestamp": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z",
"schedule_info": {
"schedule_type": "weekly",
"schedule_time": "09:00",
"days_of_week": [1],
"days_of_month": null,
"weeks_of_month": null,
"months_of_year": null
},
"next_run_at": "2024-01-22T09:00:00Z"
}Response Fields
| Field | Type | Description |
|---|---|---|
uuid | string | Unique identifier for the Knap |
name | string | Name of the Knap |
creation_user_id | integer | ID of the user who created the Knap |
schedule_type | string | Type of schedule: manual, scheduled, or post_meeting_transcription |
is_active | boolean | Whether the Knap is active for this user |
visibility | string | Visibility level: private, public, or organization name |
can_toggle_default_active | boolean | Whether user can toggle the default active state (admin/owner only) |
active_by_default | boolean | Default active state for shared Knaps |
tool_metadata | object | Metadata including action description and schedule description |
creation_timestamp | string | ISO 8601 timestamp when created |
updated_at | string | ISO 8601 timestamp when last updated |
schedule_info | object | null | Parsed schedule details (read-only, for scheduled Knaps only) |
next_run_at | string | null | ISO 8601 timestamp of next scheduled run |
Error Responses
| Status Code | Description |
|---|---|
404 | Knap not found |
403 | Access denied - user cannot view this Knap |
Example
curl -X GET https://api.knapsack.ai/api/studio/knap-tools/550e8400-e29b-41d4-a716-446655440000 \
-H "Authorization: Bearer {access_token}"