DocIntel REST API

# GET / - API catalog
curl -sS "$API" \
  -H "$AUTH" | jq

# GET /me - authenticated principal and effective scopes
curl -sS "$API/me" \
  -H "$AUTH" | jq

# GET /me/workspaces - personal and team contexts
curl -sS "$API/me/workspaces" \
  -H "$AUTH" | jq

# POST /workspace-context - validate and select a team context
curl -sS -X POST "$API/workspace-context" \
  -H "$AUTH" -H "$JSON" \
  --data "{\"workspace_id\":\"$WORKSPACE_ID\"}" | jq

# GET /workspaces - accessible team workspaces
curl -sS "$API/workspaces" \
  -H "$AUTH" | jq

# POST /workspaces - create a team workspace
curl -sS -X POST "$API/workspaces" \
  -H "$AUTH" -H "$JSON" \
  --data '{"name":"Procurement Planning"}' | jq

# GET /workspaces/{workspace_id}
curl -sS "$API/workspaces/$WORKSPACE_ID" \
  -H "$AUTH" -H "$WS" | jq

# PATCH /workspaces/{workspace_id}
curl -sS -X PATCH "$API/workspaces/$WORKSPACE_ID" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data '{"name":"FY27 Procurement Planning"}' | jq

# DELETE /workspaces/{workspace_id}
curl -sS -X DELETE "$API/workspaces/$WORKSPACE_ID" \
  -H "$AUTH" -H "$WS" | jq

# GET /workspaces/{workspace_id}/documents
curl -sS "$API/workspaces/$WORKSPACE_ID/documents" \
  -H "$AUTH" -H "$WS" | jq

# POST /workspaces/{workspace_id}/members
curl -sS -X POST "$API/workspaces/$WORKSPACE_ID/members" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data '{"email":"reviewer@example.com","role":"viewer"}' | jq

export MEMBER_USER_ID="MEMBER_USER_UUID"

# PATCH /workspaces/{workspace_id}/members/{user_id}
curl -sS -X PATCH "$API/workspaces/$WORKSPACE_ID/members/$MEMBER_USER_ID" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data '{"role":"editor"}' | jq

# DELETE /workspaces/{workspace_id}/members/{user_id}
curl -sS -X DELETE "$API/workspaces/$WORKSPACE_ID/members/$MEMBER_USER_ID" \
  -H "$AUTH" -H "$WS" | jq

# POST /workspaces/{workspace_id}/leave
curl -sS -X POST "$API/workspaces/$WORKSPACE_ID/leave" \
  -H "$AUTH" -H "$WS" | jq

# GET /documents - documents in selected context
curl -sS "$API/documents" \
  -H "$AUTH" -H "$WS" | jq

# GET /documents/{document_id}
curl -sS "$API/documents/$DOCUMENT_ID" \
  -H "$AUTH" -H "$WS" | jq

# GET /documents/{document_id}/chunks
curl -sS "$API/documents/$DOCUMENT_ID/chunks" \
  -H "$AUTH" -H "$WS" | jq

export FILE_PATH="./sample-policy.pdf"
export FILE_NAME="$(basename "$FILE_PATH")"
export FILE_SIZE="$(wc -c < "$FILE_PATH" | tr -d ' ')"

# POST /uploads - create a signed upload contract
UPLOAD_SESSION="$(curl -sS -X POST "$API/uploads" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn \
    --arg filename "$FILE_NAME" \
    --argjson file_size "$FILE_SIZE" \
    --arg workspace_id "$WORKSPACE_ID" \
    '{filename:$filename,content_type:"application/pdf",file_size:$file_size,workspace_id:$workspace_id,redact_pii:false}')")"
echo "$UPLOAD_SESSION" | jq

export DOCUMENT_ID="$(echo "$UPLOAD_SESSION" | jq -r '.doc_id')"
export UPLOAD_URL="$(echo "$UPLOAD_SESSION" | jq -r '.upload_url')"
export GCS_SOURCE_PATH="$(echo "$UPLOAD_SESSION" | jq -r '.gcs_source_path')"

# Transfer bytes directly to cloud storage
curl -sS -X PUT "$UPLOAD_URL" \
  -H "Content-Type: application/pdf" \
  --upload-file "$FILE_PATH"

# POST /uploads/complete - verify upload and start chunking
curl -sS -X POST "$API/uploads/complete" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn \
    --arg doc_id "$DOCUMENT_ID" \
    --arg filename "$FILE_NAME" \
    --argjson file_size "$FILE_SIZE" \
    --arg workspace_id "$WORKSPACE_ID" \
    --arg path "$GCS_SOURCE_PATH" \
    '{doc_id:$doc_id,filename:$filename,content_type:"application/pdf",file_size:$file_size,workspace_id:$workspace_id,redact_pii:false,gcs_source_path:$path}')" | jq

# POST /documents/{document_id}/embedding
curl -sS -X POST "$API/documents/$DOCUMENT_ID/embedding" \
  -H "$AUTH" -H "$WS" | jq

# POST /documents/{document_id}/versions
curl -sS -X POST "$API/documents/$DOCUMENT_ID/versions" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data '{"previous_document_id":null,"change_summary":"Initial reviewed version","changed_pages":[1,3]}' | jq

# GET /documents/{document_id}/versions
curl -sS "$API/documents/$DOCUMENT_ID/versions" \
  -H "$AUTH" -H "$WS" | jq

# DELETE /documents/{document_id}
curl -sS -X DELETE "$API/documents/$DOCUMENT_ID" \
  -H "$AUTH" -H "$WS" | jq

# POST /knowledge/query/stream - grounded SSE response
curl -sS -N -X POST "$API/knowledge/query/stream" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  -H "Accept: text/event-stream" \
  --data "$(jq -cn \
    --arg question "Summarize the key obligations and risks." \
    --arg document_id "$DOCUMENT_ID" \
    --arg workspace_id "$WORKSPACE_ID" \
    '{question:$question,document_ids:[$document_id],history:[],workspace_id:$workspace_id,redact_pii:false,agent_mode:"auto"}')"

# POST /summaries/documents/{document_id}/stream
curl -sS -N -X POST "$API/summaries/documents/$DOCUMENT_ID/stream" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  -H "Accept: text/event-stream" \
  --data '{"summary_type":"executive","custom_prompt":"","chunk_indices":[],"redact_pii":false}'

# List and create courses
curl -sS "$API/learning/courses?workspace_id=$WORKSPACE_ID" -H "$AUTH" -H "$WS" | jq
COURSE="$(curl -sS -X POST "$API/learning/courses" -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn --arg ws "$WORKSPACE_ID" '{workspace_id:$ws,title:"Enterprise RAG Foundations",course_code:"AI-101",semester:"Fall 2026",description:"Evidence-grounded learning.",instructor_name:"Course Instructor",objectives:["Explain hybrid retrieval","Evaluate grounded answers"]}')")"
export COURSE_ID="$(echo "$COURSE" | jq -r '.id')"

# Read, update, or delete the course
curl -sS "$API/learning/courses/$COURSE_ID" -H "$AUTH" -H "$WS" | jq
curl -sS -X PATCH "$API/learning/courses/$COURSE_ID" -H "$AUTH" -H "$WS" -H "$JSON" --data '{"semester":"Winter 2027"}' | jq
# curl -sS -X DELETE "$API/learning/courses/$COURSE_ID" -H "$AUTH" -H "$WS" | jq

# Replace curriculum and capture generated module and lesson IDs
COURSE="$(curl -sS -X PUT "$API/learning/courses/$COURSE_ID/curriculum" -H "$AUTH" -H "$WS" -H "$JSON" \
  --data '{"modules":[{"title":"RAG Foundations","description":"Retrieval and grounding.","lessons":[{"title":"Hybrid Retrieval","description":"Keyword and vector retrieval."}]}]}')"
export MODULE_ID="$(echo "$COURSE" | jq -r '.modules[0].id')"
export LESSON_ID="$(echo "$COURSE" | jq -r '.modules[0].lessons[0].id')"

# Discover and attach multimodal workspace content
curl -sS "$API/learning/documents?workspace_id=$WORKSPACE_ID" -H "$AUTH" -H "$WS" | jq
COURSE="$(curl -sS -X POST "$API/learning/courses/$COURSE_ID/assets" -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn --arg doc "$DOCUMENT_ID" --arg module "$MODULE_ID" --arg lesson "$LESSON_ID" '{document_id:$doc,module_id:$module,lesson_id:$lesson,title:"Hybrid Retrieval Lesson"}')")"
export ASSET_ID="$(echo "$COURSE" | jq -r --arg doc "$DOCUMENT_ID" '.assets[] | select(.document_id==$doc) | .id')"

# Verify exact lesson scope, then stream a grounded Tutor answer
curl -sS "$API/learning/courses/$COURSE_ID/scope?module_id=$MODULE_ID&lesson_id=$LESSON_ID" -H "$AUTH" -H "$WS" | jq
curl -sS -N -X POST "$API/learning/courses/$COURSE_ID/tutor/query/stream" -H "$AUTH" -H "$WS" -H "$JSON" -H "Accept: text/event-stream" \
  --data "$(jq -cn --arg module "$MODULE_ID" --arg lesson "$LESSON_ID" '{question:"What is discussed in this lesson?",module_id:$module,lesson_id:$lesson,history:[],response_language:"en",redact_pii:false}')"

# Persist and list grounded learning material
ARTIFACT="$(curl -sS -X POST "$API/learning/courses/$COURSE_ID/artifacts" -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn --arg module "$MODULE_ID" --arg lesson "$LESSON_ID" --arg doc "$DOCUMENT_ID" '{artifact_type:"summary",title:"Hybrid Retrieval Summary",content:"Reviewed grounded summary.",source_document_ids:[$doc],module_id:$module,lesson_id:$lesson}')")"
export SUMMARY_ARTIFACT_ID="$(echo "$ARTIFACT" | jq -r '.id')"
curl -sS "$API/learning/courses/$COURSE_ID/artifacts" -H "$AUTH" -H "$WS" | jq

# Create a schema-valid PracticeQuiz, submit an attempt, and read progress
QUIZ_CONTENT="$(jq -cn '{schema_version:1,instructions:"Select every correct answer.",questions:[{id:"q1",question:"Which retrieval approach combines lexical and semantic evidence?",options:[{id:"A",text:"Hybrid retrieval",correct:true},{id:"B",text:"Vector retrieval only",correct:false},{id:"C",text:"Keyword retrieval only",correct:false},{id:"D",text:"No retrieval",correct:false}],explanation:"Hybrid retrieval combines keyword and vector signals."}]}')"
QUIZ_ARTIFACT="$(curl -sS -X POST "$API/learning/courses/$COURSE_ID/artifacts" -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn --arg module "$MODULE_ID" --arg lesson "$LESSON_ID" --arg doc "$DOCUMENT_ID" --arg content "$QUIZ_CONTENT" '{artifact_type:"practice_questions",title:"Hybrid Retrieval Practice",content:$content,source_document_ids:[$doc],module_id:$module,lesson_id:$lesson}')")"
export ARTIFACT_ID="$(echo "$QUIZ_ARTIFACT" | jq -r '.id')"
curl -sS -X POST "$API/learning/courses/$COURSE_ID/artifacts/$ARTIFACT_ID/attempts" -H "$AUTH" -H "$WS" -H "$JSON" \
  --data '{"answers":{"q1":["A"]},"replace":false}' | jq
curl -sS "$API/learning/courses/$COURSE_ID/progress" -H "$AUTH" -H "$WS" | jq

# Ask and answer a human-guidance question
QUESTION="$(curl -sS -X POST "$API/learning/courses/$COURSE_ID/questions" -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn --arg lesson "$LESSON_ID" '{target_role:"teacher",question:"How should I evaluate retrieval quality?",context:{lesson_id:$lesson}}')")"
export QUESTION_ID="$(echo "$QUESTION" | jq -r '.id')"
curl -sS -X PATCH "$API/learning/courses/$COURSE_ID/questions/$QUESTION_ID" -H "$AUTH" -H "$WS" -H "$JSON" \
  --data '{"answer":"Measure recall, precision, groundedness, and latency.","status":"answered"}' | jq

# Enroll or remove a member
curl -sS -X POST "$API/learning/courses/$COURSE_ID/members" -H "$AUTH" -H "$WS" -H "$JSON" \
  --data '{"email":"student@example.com","persona":"student"}' | jq
# curl -sS -X DELETE "$API/learning/courses/$COURSE_ID/members/$MEMBER_USER_ID" -H "$AUTH" -H "$WS" | jq

# Detach or delete caller-owned learning records
# curl -sS -X DELETE "$API/learning/courses/$COURSE_ID/assets/$ASSET_ID" -H "$AUTH" -H "$WS" | jq
# curl -sS -X DELETE "$API/learning/courses/$COURSE_ID/artifacts/$ARTIFACT_ID" -H "$AUTH" -H "$WS" | jq

# POST /batches/uploads - reserve multiple signed uploads
BATCH_UPLOAD="$(curl -sS -X POST "$API/batches/uploads" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn \
    --arg workspace_id "$WORKSPACE_ID" \
    '{workspace_id:$workspace_id,redact_pii:false,idempotency_key:"upload-2026-001",files:[{filename:"policy-a.pdf",content_type:"application/pdf",file_size:348120},{filename:"policy-b.pdf",content_type:"application/pdf",file_size:228400}]}')")"
echo "$BATCH_UPLOAD" | jq

export BATCH_JOB_ID="$(echo "$BATCH_UPLOAD" | jq -r '.batch_job_id')"
export DOCUMENT_ID_1="$(echo "$BATCH_UPLOAD" | jq -r '.files[0].document_id')"
export DOCUMENT_ID_2="$(echo "$BATCH_UPLOAD" | jq -r '.files[1].document_id')"

# Upload each file using its returned .files[n].upload_url before completion.

# POST /batches/{job_id}/uploads/complete
curl -sS -X POST "$API/batches/$BATCH_JOB_ID/uploads/complete" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn --arg a "$DOCUMENT_ID_1" --arg b "$DOCUMENT_ID_2" '{document_ids:[$a,$b],concurrency:3}')" | jq

# POST /batches/embedding
curl -sS -X POST "$API/batches/embedding" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn --arg ws "$WORKSPACE_ID" --arg a "$DOCUMENT_ID_1" --arg b "$DOCUMENT_ID_2" '{workspace_id:$ws,document_ids:[$a,$b],concurrency:3,force:false,idempotency_key:"embed-2026-001"}')" | jq

# POST /batches/classification
curl -sS -X POST "$API/batches/classification" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn --arg ws "$WORKSPACE_ID" --arg a "$DOCUMENT_ID_1" --arg b "$DOCUMENT_ID_2" '{workspace_id:$ws,document_ids:[$a,$b],concurrency:3,force:false,idempotency_key:"classify-2026-001"}')" | jq

# POST /batches/workspace-summary
curl -sS -X POST "$API/batches/workspace-summary" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn --arg ws "$WORKSPACE_ID" '{workspace_id:$ws,document_ids:[],summary_type:"executive",custom_prompt:"",redact_pii:false,language:"en",concurrency:2,idempotency_key:"summary-2026-001"}')" | jq

# GET /batches - filter jobs
curl -sS "$API/batches?workspace_id=$WORKSPACE_ID&status=running&limit=25" \
  -H "$AUTH" -H "$WS" | jq

# GET /batches/{job_id}
curl -sS "$API/batches/$BATCH_JOB_ID" \
  -H "$AUTH" -H "$WS" | jq

# GET /batches/{job_id}/results
curl -sS "$API/batches/$BATCH_JOB_ID/results" \
  -H "$AUTH" -H "$WS" | jq

# POST /batches/{job_id}/retry
curl -sS -X POST "$API/batches/$BATCH_JOB_ID/retry" \
  -H "$AUTH" -H "$WS" | jq

# POST /batches/{job_id}/resume
curl -sS -X POST "$API/batches/$BATCH_JOB_ID/resume" \
  -H "$AUTH" -H "$WS" | jq

# POST /batches/{job_id}/cancel
curl -sS -X POST "$API/batches/$BATCH_JOB_ID/cancel" \
  -H "$AUTH" -H "$WS" | jq

# GET /operations/catalog
curl -sS "$API/operations/catalog" \
  -H "$AUTH" -H "$WS" | jq

# GET /operations
curl -sS "$API/operations?workspace_id=$WORKSPACE_ID&status=running&limit=25" \
  -H "$AUTH" -H "$WS" | jq

export OPERATION_ID="YOUR_OPERATION_UUID"

# GET /operations/{operation_id}
curl -sS "$API/operations/$OPERATION_ID" \
  -H "$AUTH" -H "$WS" | jq

export WORKFLOW="healthcare_prior_auth"

# GET /workflows/{workflow}/schema
curl -sS "$API/workflows/$WORKFLOW/schema" \
  -H "$AUTH" -H "$WS" | jq

# POST /workflows/{workflow}/validate
curl -sS -X POST "$API/workflows/$WORKFLOW/validate" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn --arg document_id "$DOCUMENT_ID" '{document_ids:[$document_id],policy_document_ids:[$document_id]}')" | jq

# GET /events
curl -sS "$API/events?after=0&resource_type=document&resource_id=$DOCUMENT_ID&limit=100" \
  -H "$AUTH" -H "$WS" | jq

# POST /event-subscriptions
SUBSCRIPTION="$(curl -sS -X POST "$API/event-subscriptions" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn --arg ws "$WORKSPACE_ID" '{event_types:["document.embedded","document.failed","batch.completed"],workspace_id:$ws,resource_type:null,resource_id:null,webhook_url:"https://webhooks.example.com/docintel/events"}')")"
echo "$SUBSCRIPTION" | jq
export SUBSCRIPTION_ID="$(echo "$SUBSCRIPTION" | jq -r '.subscription_id // .id')"

# GET /event-subscriptions
curl -sS "$API/event-subscriptions" \
  -H "$AUTH" -H "$WS" | jq

# DELETE /event-subscriptions/{subscription_id}
curl -sS -X DELETE "$API/event-subscriptions/$SUBSCRIPTION_ID" \
  -H "$AUTH" -H "$WS" | jq

# GET /webhook-deliveries
curl -sS "$API/webhook-deliveries?subscription_id=$SUBSCRIPTION_ID&status=failed&limit=100" \
  -H "$AUTH" -H "$WS" | jq

export DELIVERY_ID="YOUR_DELIVERY_UUID"

# POST /webhook-deliveries/{delivery_id}/retry
curl -sS -X POST "$API/webhook-deliveries/$DELIVERY_ID/retry" \
  -H "$AUTH" -H "$WS" | jq

# POST /webhook-deliveries/process-due
curl -sS -X POST "$API/webhook-deliveries/process-due?limit=50" \
  -H "$AUTH" -H "$WS" | jq

export EVENT_ID="YOUR_EVENT_UUID"

# POST /events/{event_id}/replay
curl -sS -X POST "$API/events/$EVENT_ID/replay" \
  -H "$AUTH" -H "$WS" | jq

export WORKFLOW_RUN_ID="YOUR_WORKFLOW_RUN_ID"

# POST /reviews
REVIEW="$(curl -sS -X POST "$API/reviews" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn --arg ws "$WORKSPACE_ID" --arg run "$WORKFLOW_RUN_ID" '{vertical:"healthcare",run_id:$run,title:"Review prior authorization packet",workspace_id:$ws,priority:"high",due_at:null,metadata:{source:"public_api"}}')")"
echo "$REVIEW" | jq
export REVIEW_TASK_ID="$(echo "$REVIEW" | jq -r '.task_id // .id')"

# GET /reviews
curl -sS "$API/reviews?status=pending&limit=100" \
  -H "$AUTH" -H "$WS" | jq

# POST /reviews/{task_id}/assign
curl -sS -X POST "$API/reviews/$REVIEW_TASK_ID/assign" \
  -H "$AUTH" -H "$WS" | jq

# POST /reviews/{task_id}/decision
curl -sS -X POST "$API/reviews/$REVIEW_TASK_ID/decision" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data '{"decision":"approved","reviewer_notes":"Evidence and packet reviewed."}' | jq

# POST /artifacts
curl -sS -X POST "$API/artifacts" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn --arg ws "$WORKSPACE_ID" --arg doc "$DOCUMENT_ID" '{artifact_type:"review_packet",title:"Approved review packet",content:{summary:"Reviewed and approved."},workspace_id:$ws,source_document_ids:[$doc],source_trace_id:null,status:"approved"}')" | jq

# GET /artifacts
curl -sS "$API/artifacts?workspace_id=$WORKSPACE_ID" \
  -H "$AUTH" -H "$WS" | jq

export TRACE_ID="YOUR_TRACE_ID"

# POST /evaluations
curl -sS -X POST "$API/evaluations" \
  -H "$AUTH" -H "$WS" -H "$JSON" \
  --data "$(jq -cn --arg trace_id "$TRACE_ID" '{trace_id:$trace_id,evaluation_type:"groundedness"}')" | jq