Get Query

GET

https://api.captain.dev/v2/queries/:query_id

GET

/v2/queries/:query_id

import requests
import json
BASE_URL = "https://api.captain.dev"
API_KEY = "your_api_key"
QUERY_ID = "019a0e2a-7b31-7c4e-9d2f-3a8c1e5b6f90"
headers = {
    "Authorization": f"Bearer {API_KEY}",
}
response = requests.get(
    f"{BASE_URL}/v2/queries/{QUERY_ID}",
    headers=headers,
    timeout=30.0,
)
q = response.json()
print(q["query_text"], q["body_status"])
for r in q["results"]:
    print(f"#{r['rank']} {r['filename']} {r['score']:.3f}: {r['text'][:80]}")
print(json.dumps(q["request"], indent=2))

{
  "query_id": "019a0e2a-7b31-7c4e-9d2f-3a8c1e5b6f90",
  "body_status": "available",
  "query_text": "What are the adverse reactions listed for metformin?",
  "collection_name": "clinical-docs",
  "environment": "production",
  "status": "completed",
  "api_version": "v3",
  "created_at": "2026-09-05T18:46:25.660882Z",
  "latency_ms": 412,
  "result_count": 5,
  "request_id": "req_1788633985_84509ca6",
  "params": {
    "limit": 5,
    "semantic_ratio": 0.5,
    "has_filter": false,
    "has_boost": false,
    "exclude_chunk_types": null,
    "include": null,
    "rerank": true
  },
  "results": [
    {
      "rank": 1,
      "chunk_id": "chk_7d0c2b",
      "score": 0.9134,
      "rerank_score": 0.88,
      "text": "Common adverse reactions (≥5%) include diarrhea, nausea/vomiting, flatulence, asthenia, indigestion, abdominal discomfort, and headache.",
      "filename": "metformin-label.pdf",
      "document_id": "2f517447a1b22714dcdbd80dd777fd07",
      "modality": "pdf",
      "chunk_type": "body",
      "location": {
        "page_start": 4,
        "page_end": 4,
        "start_seconds": null,
        "end_seconds": null,
        "sheet_name": null,
        "row_start": null
      }
    }
  ],
  "request": {
    "query": "What are the adverse reactions listed for metformin?",
    "limit": 5,
    "rerank": true,
    "semantic_ratio": 0.5
  },
  "response": {
    "results": [
      {
        "chunk_id": "chk_7d0c2b",
        "score": 0.9134,
        "rerank_score": 0.88,
        "text": "Common adverse reactions (≥5%) include diarrhea, nausea/vomiting, flatulence, asthenia, indigestion, abdominal discomfort, and headache.",
        "document": {
          "id": "2f517447a1b22714dcdbd80dd777fd07",
          "filename": "metformin-label.pdf"
        },
        "location": {
          "page_start": 4,
          "page_end": 4
        },
        "modality": "pdf",
        "chunk_type": "body"
      }
    ],
    "total_results": 5
  },
  "error_message": null,
  "error_type": null
}

One stored query with its request body, response body and the retrieved chunks in one normalised shape (results[]: rank, score, text, filename, document id and a page, time or sheet location, whether the query ran on v2 or v3).

query_id is the id from GET /v2/queries or the query_id field of a query response. The request_id a query response returns (req_...) is accepted in its place, so a query can be fetched straight after running it.

body_status says what came back: available, archived (bodies are archived 90 days after the query and only the summary remains) or missing. A query from another organization or environment is a 404, the same as an unknown id.

Path parameters

query_idstringRequired

Response

Successful Response

query_idstring

body_statusstring

query_textstring or nullOptional

collection_namestring or nullOptional

environmentstring or nullOptional

statusstring or nullOptional

api_versionstring or nullOptional

created_atstring or nullOptional

latency_msinteger or nullOptional

result_countinteger or nullOptional

request_idstring or nullOptional

paramsobject or nullOptional

resultslist of objects or nullOptional

requestobject or nullOptional

responseobject or nullOptional

error_messagestring or nullOptional

error_typestring or nullOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

Path parameters

Headers

Response

Errors