Query a corpus for relevant content

Prod Env

POST

/v1/corpus/{corpus_id}/query

Supports an optional x-api-key header (Bearer token format) for API-key-scoped access.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Bodyapplication/json

🟠4XX

🔴5XX

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/corpus//query' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "enable_rerank": true,
    "mode": "string",
    "only_need_context": true,
    "query": "string"
}'

Response Example

200 - Example 1

{
    "chunks": [
        {
            "content": "string",
            "score": 0,
            "source_id": "string"
        }
    ],
    "entities": [
        {
            "description": "string",
            "name": "string",
            "score": 0,
            "type": "string"
        }
    ],
    "llm_response": "string",
    "metadata": {
        "high_level_keywords": [
            "string"
        ],
        "low_level_keywords": [
            "string"
        ],
        "query_mode": "string",
        "rerank_applied": true
    },
    "references": [
        {
            "content": "string",
            "source_id": "string"
        }
    ],
    "relationships": [
        {
            "description": "string",
            "relationship": "string",
            "score": 0,
            "source": "string",
            "target": "string"
        }
    ],
    "result": "string"
}

Get the ingestion status of a corpus artifact

Get a corpus by id