Your next connection.

Validate the API key and inspect its scope. Returns connector name, scope, accessible board count, writable board count, and last-used timestamp. Call this once on startup to fail fast on a missing or revoked key.

List every board this key can access. Each board reports id, name, description, role, entry count, and read/write capability. Pass ?writable_only=true to filter to boards the key can write into.

Search boards by topic or keywords. Returns the most relevant accessible boards with a match_score and match_reason. Useful before a deterministic write when the AI app needs to choose a board itself. Query: ?q=…, ?limit=, ?writable_only=.

Read context entries from a specific board. Pass ?board_id= plus an optional ?query= to rank by query relevance. Results combine text and available semantic matches, with short summaries, a score, and match_reasons explaining the ranking. Scores are relative ranking signals, not confidence percentages.

Search context across all boards the key can read. Pass ?query= and an optional ?limit=. Each result includes the source board so a reading AI can tell which memory came from where. Only accessible, processed entries are returned. Exact repeated text is collapsed; different details and exceptions remain separate results.

Find a destination for a memory without supplying a Board ID. Index ranks writable Boards, checks relevance, and processes accepted attempts. A suitable destination is not guaranteed. Optional topic gives the search more context.

curl -X POST $INDEX_API_BASE/connector/capture \
  -H "X-API-Key: $INDEX_CONNECTOR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "London prefers Ableton Live for music production and recently bought a Push 3.",
    "topic": "music production"
  }'

Check what actually happened

A 201 response means the capture request completed. It can still contain no saved memory. Read outcome and every item in attempts before confirming a save.

• written: attempts were accepted. Check each final_status: processed is ready for retrieval; merged points to an existing entry through entry.merged_into_id; conflict needs review.
• deduplicated: every accepted attempt matched existing memory. This is not a new fact.
• partially_written: some attempts were rejected. Keep the accepted results and retry only the rejected ones.
• rejected or no_match: no attempt was accepted. Read rejection_reason, each attempt’s error, and next_steps.

written_count counts accepted attempts, including duplicates and entries needing conflict review. It does not count new, retrievable facts. Candidate Board IDs, names, match scores and reasons in candidate_boards are limited to destinations this connection can write to. Choosing an explicit Board never bypasses permissions or relevance checks.

classification reports the suggested topic, scoring method and routing_eligible flag. Its confidence value is a heuristic or model-reported score, not a measured probability. A weak topic label is diagnostic only; it is not added as an automatic topic tag or used alone to justify relevance.

Write a memory entry into a specific board. Use when the AI app already has the board id — the target is explicit. Board permissions and the relevance gate still apply, and the Orchestrator runs before the write result is returned. Check final_status and the returned entry as described under capture results; a merged or conflicted entry is not a new processed memory.

curl -X POST $INDEX_API_BASE/connector/write \
  -H "X-API-Key: $INDEX_CONNECTOR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "board_id": "brd_01HX...",
    "content": "User finalised the Q2 launch checklist in this conversation."
  }'