Clear Tangle
Sign in Try for free

Captures API.

Manage captures programmatically.

The Captures API allows you to create, read, update, and delete captures in your Clear Tangle account. Captures are automatically processed by AI to generate summaries, tags, categories, and Smart search embeddings.

Endpoints

METHODENDPOINTDESCRIPTION
GET/capturesList all captures
POST/capturesCreate a capture
GET/captures/:idGet a capture
PATCH/captures/:idUpdate a capture
DELETE/captures/:idDelete a capture
GET/captures/searchSearch captures

Create a capture

Create a new capture. The API automatically processes the content to generate AI summaries, extract tags, and create Smart search embeddings. Tasks mentioned in the content are automatically extracted.

Request

Create capture · bash
curl -X POST "https://api.cleartangle.com/captures" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"content": "Meeting notes: Discussed Q1 roadmap with team. Action items: finalize budget by Friday.",
"tags": ["meeting", "planning"],
"projectId": "proj_123456",
"metadata": {
"source": "api",
"importance": "high"
}
}'

Request body

FIELDTYPEREQUIREDDESCRIPTION
contentstringYesThe capture content (max 50,000 chars)
tagsstring[]NoArray of tags to apply
projectIdstringNoProject to associate with
metadataobjectNoCustom metadata key-value pairs
skipAiProcessingbooleanNoSkip AI processing (default: false)

Response

Response · json
{
"success": true,
"data": {
"id": "cap_789xyz",
"content": "Meeting notes: Discussed Q1 roadmap with team. Action items: finalize budget by Friday.",
"summary": "Q1 roadmap meeting with budget action item",
"tags": ["meeting", "planning"],
"projectId": "proj_123456",
"category": "work",
"embedding": [...],
"extractedTasks": [
{
"id": "task_abc123",
"title": "Finalize budget",
"dueDate": "2024-01-19"
}
],
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
}
AI PROCESSING
By default, all captures are processed by AI to extract summaries, tags, and tasks. Set skipAiProcessing: true if you want to bypass this for bulk imports.

List captures

Retrieve a paginated list of captures with optional filtering.

List captures · bash
curl -X GET "https://api.cleartangle.com/captures?limit=20&page=1&tags=meeting" \
-H "Authorization: Bearer YOUR_API_KEY"

Query parameters

PARAMETERTYPEDESCRIPTION
pageintegerPage number (default: 1)
limitintegerItems per page (default: 20, max: 100)
tagsstringComma-separated tag filter
projectIdstringFilter by project
categorystringFilter by category
startDateISO8601Filter by creation date (from)
endDateISO8601Filter by creation date (to)
sortstringSort field (createdAt, updatedAt)
orderstringSort order (asc, desc)

Search captures

Search captures using keyword or Smart search. Smart search uses AI embeddings to find conceptually similar content.

Search captures · bash
curl -X GET "https://api.cleartangle.com/captures/search?q=budget+roadmap&semantic=true" \
-H "Authorization: Bearer YOUR_API_KEY"

Search parameters

qSearch query string
semanticEnable Smart search (true/false, default: false)
thresholdSimilarity threshold for Smart search (0–1, default: 0.7)
limitMaximum results (default: 20)

Update a capture

Update an existing capture. Only provided fields will be updated.

Update capture · bash
curl -X PATCH "https://api.cleartangle.com/captures/cap_789xyz" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"tags": ["meeting", "planning", "important"],
"projectId": "proj_newproject"
}'

Updating the content field triggers AI reprocessing to update summaries and embeddings.

Delete a capture

Permanently delete a capture. This action cannot be undone.

Delete capture · bash
curl -X DELETE "https://api.cleartangle.com/captures/cap_789xyz" \
-H "Authorization: Bearer YOUR_API_KEY"
CASCADING DELETE
Deleting a capture also deletes any tasks that were automatically extracted from it.

Related documentation

Captures API | Clear Tangle Documentation
Clear Tangle
Sign in Try for free

Captures API.

Manage captures programmatically.

The Captures API allows you to create, read, update, and delete captures in your Clear Tangle account. Captures are automatically processed by AI to generate summaries, tags, categories, and Smart search embeddings.

Endpoints

METHODENDPOINTDESCRIPTION
GET/capturesList all captures
POST/capturesCreate a capture
GET/captures/:idGet a capture
PATCH/captures/:idUpdate a capture
DELETE/captures/:idDelete a capture
GET/captures/searchSearch captures

Create a capture

Create a new capture. The API automatically processes the content to generate AI summaries, extract tags, and create Smart search embeddings. Tasks mentioned in the content are automatically extracted.

Request

Create capture · bash
curl -X POST "https://api.cleartangle.com/captures" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"content": "Meeting notes: Discussed Q1 roadmap with team. Action items: finalize budget by Friday.",
"tags": ["meeting", "planning"],
"projectId": "proj_123456",
"metadata": {
"source": "api",
"importance": "high"
}
}'

Request body

FIELDTYPEREQUIREDDESCRIPTION
contentstringYesThe capture content (max 50,000 chars)
tagsstring[]NoArray of tags to apply
projectIdstringNoProject to associate with
metadataobjectNoCustom metadata key-value pairs
skipAiProcessingbooleanNoSkip AI processing (default: false)

Response

Response · json
{
"success": true,
"data": {
"id": "cap_789xyz",
"content": "Meeting notes: Discussed Q1 roadmap with team. Action items: finalize budget by Friday.",
"summary": "Q1 roadmap meeting with budget action item",
"tags": ["meeting", "planning"],
"projectId": "proj_123456",
"category": "work",
"embedding": [...],
"extractedTasks": [
{
"id": "task_abc123",
"title": "Finalize budget",
"dueDate": "2024-01-19"
}
],
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
}
AI PROCESSING
By default, all captures are processed by AI to extract summaries, tags, and tasks. Set skipAiProcessing: true if you want to bypass this for bulk imports.

List captures

Retrieve a paginated list of captures with optional filtering.

List captures · bash
curl -X GET "https://api.cleartangle.com/captures?limit=20&page=1&tags=meeting" \
-H "Authorization: Bearer YOUR_API_KEY"

Query parameters

PARAMETERTYPEDESCRIPTION
pageintegerPage number (default: 1)
limitintegerItems per page (default: 20, max: 100)
tagsstringComma-separated tag filter
projectIdstringFilter by project
categorystringFilter by category
startDateISO8601Filter by creation date (from)
endDateISO8601Filter by creation date (to)
sortstringSort field (createdAt, updatedAt)
orderstringSort order (asc, desc)

Update a capture

Update an existing capture. Only provided fields will be updated.

Update capture · bash
curl -X PATCH "https://api.cleartangle.com/captures/cap_789xyz" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"tags": ["meeting", "planning", "important"],
"projectId": "proj_newproject"
}'

Updating the content field triggers AI reprocessing to update summaries and embeddings.

Delete a capture

Permanently delete a capture. This action cannot be undone.

Delete capture · bash
curl -X DELETE "https://api.cleartangle.com/captures/cap_789xyz" \
-H "Authorization: Bearer YOUR_API_KEY"
CASCADING DELETE
Deleting a capture also deletes any tasks that were automatically extracted from it.