Skip to article
/ docs

Search documentation

Popular starting points. Search all 37 articles.

  • Get startedProduct availability and preview limitationsUnderstand what works in the frontend and which product capabilities are not connected yet.
  • Get startedBuild your first RAG pipelineBuild and inspect your first seven-node Basic RAG graph and learn what validation means.
  • Build pipelinesBasic RAG and Hybrid Search templatesCompare Ragify's two starting graphs and decide which pattern to explore.
  • Node referenceUnderstand the node libraryBrowse the ten registered node types by role in the workflow.

↑ ↓ to navigate · Enter to open · Esc to close

Back to Ragify ↗
On this page

Documentation

NON-OPERATIONAL EXAMPLE

Illustrative pipeline query contract

Review the intended shape of a pipeline-query request without treating it as a stable API reference.

Planned API — not available. The endpoint below is an illustrative shape shown by the frontend's API-access concept. It is not an operational or versioned public API contract. Request fields, response fields, error codes, and authentication details may change before release.

Conceptual endpoint #

http · illustrative example
POST /v1/pipelines/{id}/query

A future server would accept a request for a deployed pipeline and return either a model-backed answer or a structured error. The reviewed frontend does not provide an executable endpoint at this path.

Conceptual request #

json · illustrative example
{
  "question": "What does our onboarding guide say about permissions?"
}

The question field above is illustrative and should not be assumed to match a final published schema.

Conceptual response shape #

json · illustrative example
{
  "answer": "Example response only; no pipeline was executed.",
  "sources": [],
  "status": "illustrative"
}

These values describe the idea of returning an answer with associated source references. They are not an actual Ragify server response, a guaranteed response contract, or evidence that the pipeline executed.

Do not use real secrets #

No live API key is issued by the frontend preview. Never put secrets into example pages, screenshots, local storage for demos, or publicly accessible scripts.

When to update this page #

Replace illustrative content only after backend owners publish a validated OpenAPI specification, working authentication flow, error responses, and runnable end-to-end examples.