curl --request POST \
--url https://api.recoupable.dev/api/context \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"action": "brief",
"request_id": "11111111-1111-4111-8111-111111111111",
"additional_request_ids": [
"22222222-2222-4222-8222-222222222222"
],
"purpose": "creative_direction",
"max_characters": 12000
}
'Context Engine
Coverage note: this reference describes a subset of the current Context Engine action catalog. Additional actions are being reconciled in mono#329; this page is not a complete capability inventory. Save reusable music context, read progress, or compile a task-specific evidence brief. This reference documents the ingestion, read, brief, save_brief and read_brief actions of the shared HTTP/MCP operation. Brief compilation combines up to ten completed or partial requests in one authorized workspace, reuses saved evidence without provider or model calls, and returns bounded Markdown plus the selected input versions. Creative direction prioritizes lyrics and artwork; playlist pitching prioritizes catalog/audio metadata. Shared artist evidence appears once, with coverage reported separately for each request. Briefs are evidence packets, not generated creative concepts or finished outreach. Inspect readiness, request_coverage and gaps. The brief action is read-only; use save_brief with the same inputs and an idempotency_key to freeze the server-compiled output, then read_brief with its brief_id to retrieve it without recompilation. A newer document revision marks the snapshot superseded without rewriting it. Withdrawn/unavailable evidence, cancelled requests, or removed subject scope withhold the payload. Saving rechecks current evidence before committing. Apply the companion snapshot migration before using save_brief/read_brief. Ingestion dispatches a durable workflow; retry the same input and idempotency key after dispatch failure.
curl --request POST \
--url https://api.recoupable.dev/api/context \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"action": "brief",
"request_id": "11111111-1111-4111-8111-111111111111",
"additional_request_ids": [
"22222222-2222-4222-8222-222222222222"
],
"purpose": "creative_direction",
"max_characters": 12000
}
'Authorizations
Body
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
"ingest"Spotify track URL. Albums, playlists and YouTube ingestion are not enabled in this pilot.
Stable key for retrying the same input without duplicate work.
1 - 128^[A-Za-z0-9._:-]+$Optional organization that owns the private context. Current membership is checked.
1 - 10 elementsrelease_metadata, artist_metadata, catalog_metadata, lyrics, song_summary, artwork_branding, artist_research, artist_brand, era, video_narrative Stored customer direction. Metadata extraction does not interpret it as source facts.
4000Response
Read returns request. Brief returns request_id, request_ids, purpose, readiness, bounded Markdown text and text_characters, documents and their serialized characters count, missingTopics, guidance, gaps, request_coverage, and input_manifest. Each coverage entry includes requestId, readiness and missingTopics; overall readiness remains partial if any request has a gap or partial evidence. The manifest includes compilerVersion, method, requestIds, excludedTopics, and selected documents with documentId, resultId (null only if unavailable), subjectId, topic, version and sourceVersionIds. The result is returned without creating a saved brief record. Save/read brief return {snapshot: {id, created_at, purpose, state, superseded, brief}}. state is saved or unavailable; unavailable snapshots return brief: null. saved snapshots return the exact compiled response including its input manifest. Another workspace cannot read the record.
Was this page helpful?