ContextPier.
Browse documentation

Reference

API reference

A compact map of the installed Go endpoints. Use the exported OpenAPI specification for complete schemas.

Read the installed contract

Export the installed specification with the Go CLI. The command below runs from the repository root and describes the current installed API contracts.

Shell
make cli ARGS='openapi'

Documents and source reads

Use owned inventory pages and exact immutable identities. Cursor values are bookmarks, not access credentials.

  • GET /api/documents — owned document summaries.
  • POST /api/documents — admit plain text or Markdown.
  • POST /api/documents/files?documentId=… — admit a PDF.
  • GET /api/documents/parse-jobs — owned PDF parsing receipts.
  • GET /api/documents/jobs — owned indexing receipts.
  • POST /api/sources/read — read {documentId, versionId, chunkId}.

Retrieval and answers

Search returns original passages. Question operations can generate an answer from the available evidence.

  • POST /api/search — search {query, mode?, limit?}.
  • POST /api/questions — ask {question}.
  • POST /api/questions/stream — stream {question, requestKey}.
  • GET /api/conversations — discover readable saved questions.
  • POST /api/conversations/read — read {requestKey}.

Identity

Sign-up creates an account; sign-in issues a bearer. The token-free session endpoint reports the current identity.

  • POST /api/auth/sign-up/email — create an account.
  • POST /api/auth/sign-in/email — sign in.
  • GET /api/auth/get-session — inspect the current session.
  • POST /api/auth/sign-out — revoke the current session.

Request boundaries

Use the Go API base URL for direct integrations. Dashboard requests instead use the same-origin /api/backend adapter, which applies its fixed destination and cookie-derived bearer.

Unknown fields and malformed identities are rejected. Keep expected input errors, insufficient evidence, and technical failures separate in your client.