Skip to main content
POST
/
run
Error
A valid request URL is required to generate request examples
{
  "run_id": "<string>"
}

​
Request Body

Content-Type: application/json 
{
  "query": "string",      // Query for which to get related chunks and embeddings
  "file_ids": ["string"], // Array of file UUIDs to search in
  "k": 3                  // Optional: Number of related chunks to return (default: 3)
}

​
Authentication

Before making requests to the AI Tutor RAG API, you need to obtain your API key from your dashboard.

​
Example Request

const res = await fetch("https://rag-api-llm.up.railway.app/embeddings", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "authorization": apiKey,
  },
  body: JSON.stringify({
    query: "search query",
    file_ids: ["939b2cd7-56d5-4c44-b491-14bfc202e9a0"]
  }),
});

​
Response

{
  "success": true,
  "documents": [
    {
      "content": "my name is jon.",
      "file_id": "939b2cd7-56d5-4c44-b491-14bfc202e9a0",
      "score": "0.273"
    }
  ]
}

​
Request Parameters

NameRequiredTypeDescription
queryYesstringQuery for which to get related chunks and embeddings
file_idsYesarrayArray of file UUIDs to search in. Must contain at least one file ID
kNointegerNumber of related chunks to return. Default: 3

​
Error Responses

{
  "success": false,
  "error": {
    "message": "Invalid API key provided",
    "code": "unauthorized"
  }
}

{
  "success": false,
  "error": {
    "message": "No file IDs provided",
    "code": "invalid_request"
  }
}

Authorizations

​
Authorization
string
header
required

API token created in Comfy Deploy /api-keys

Body

application/json
​
deployment_id
string
required
​
inputs
object

Response

Workflow queued

​
run_id
string
required