Cortex API

Ask AI

Endpoint

AI-powered question answering

Ask a question

POST

http://localhost:8000

/api/ask

Get an AI-generated answer with sources

Ask a question › Request Body

question

string · required

use_graph

boolean

Default: true

max_hops

integer

Default: 2

use_reranking

boolean

Default: true

use_agentic

boolean

Default: false

use_fast_search

boolean

Default: false

collection_id

string

object[]

Ask a question › Responses

200

Answer generated

answer

string

object[]

object

retrieval_stats

object

POST/api/ask

curl --request POST \
  --url http://localhost:8000/api/ask \
  --header 'Content-Type: application/json' \
  --data '
{
  "question": "question",
  "use_graph": true,
  "max_hops": 0,
  "use_reranking": true,
  "use_agentic": true,
  "use_fast_search": true,
  "collection_id": "collection_id",
  "conversation_history": [
    {
      "role": "user",
      "content": "content"
    }
  ]
}
'

shell

Example Request Body

{
  "question": "question",
  "use_graph": true,
  "max_hops": 0,
  "use_reranking": true,
  "use_agentic": true,
  "use_fast_search": true,
  "collection_id": "collection_id",
  "conversation_history": [
    {
      "role": "user",
      "content": "content"
    }
  ]
}

json

Example Responses

{
  "answer": "answer",
  "sources": [
    {
      "content": "content",
      "document_id": "document_id",
      "filename": "filename",
      "score": 0
    }
  ],
  "graph_context": {
    "entities": [
      "string"
    ],
    "relationships": [
      {}
    ],
    "communities": [
      {}
    ]
  },
  "retrieval_stats": {}
}

json

application/json

Streaming answer

POST

http://localhost:8000

/api/ask/stream

Get a streaming answer using Server-Sent Events

Streaming answer › Request Body

question

string · required

use_graph

boolean

Default: true

max_hops

integer

Default: 2

use_reranking

boolean

Default: true

use_agentic

boolean

Default: false

use_fast_search

boolean

Default: false

collection_id

string

object[]

Streaming answer › Responses

200

Streaming response

string

POST/api/ask/stream

curl --request POST \
  --url http://localhost:8000/api/ask/stream \
  --header 'Content-Type: application/json' \
  --data '
{
  "question": "question",
  "use_graph": true,
  "max_hops": 0,
  "use_reranking": true,
  "use_agentic": true,
  "use_fast_search": true,
  "collection_id": "collection_id",
  "conversation_history": [
    {
      "role": "user",
      "content": "content"
    }
  ]
}
'

shell

Example Request Body

{
  "question": "question",
  "use_graph": true,
  "max_hops": 0,
  "use_reranking": true,
  "use_agentic": true,
  "use_fast_search": true,
  "collection_id": "collection_id",
  "conversation_history": [
    {
      "role": "user",
      "content": "content"
    }
  ]
}

json

Example Responses

string

plain

text/event-stream

Streaming with extended thinking

POST

http://localhost:8000

/api/ask/stream/thinking

Stream answer with visible reasoning steps

Streaming with extended thinking › Request Body

question

string · required

use_graph

boolean

Default: true

max_hops

integer

Default: 2

use_reranking

boolean

Default: true

use_agentic

boolean

Default: false

use_fast_search

boolean

Default: false

collection_id

string

object[]

Streaming with extended thinking › Responses

200

Streaming response with thinking

string

POST/api/ask/stream/thinking

curl --request POST \
  --url http://localhost:8000/api/ask/stream/thinking \
  --header 'Content-Type: application/json' \
  --data '
{
  "question": "question",
  "use_graph": true,
  "max_hops": 0,
  "use_reranking": true,
  "use_agentic": true,
  "use_fast_search": true,
  "collection_id": "collection_id",
  "conversation_history": [
    {
      "role": "user",
      "content": "content"
    }
  ]
}
'

shell

Example Request Body

{
  "question": "question",
  "use_graph": true,
  "max_hops": 0,
  "use_reranking": true,
  "use_agentic": true,
  "use_fast_search": true,
  "collection_id": "collection_id",
  "conversation_history": [
    {
      "role": "user",
      "content": "content"
    }
  ]
}

json

Example Responses

string

plain

text/event-stream

Search Knowledge Graph

Cortex API

Ask AI

Endpoint

AI-powered question answering

Ask a question

POST

http://localhost:8000

/api/ask

Get an AI-generated answer with sources

Ask a question › Request Body

question

string · required

use_graph

boolean

Default: true

max_hops

integer

Default: 2

use_reranking

boolean

Default: true

use_agentic

boolean

Default: false

use_fast_search

boolean

Default: false

collection_id

string

object[]

Ask a question › Responses

200

Answer generated

answer

string

object[]

object

retrieval_stats

object

POST/api/ask

curl --request POST \
  --url http://localhost:8000/api/ask \
  --header 'Content-Type: application/json' \
  --data '
{
  "question": "question",
  "use_graph": true,
  "max_hops": 0,
  "use_reranking": true,
  "use_agentic": true,
  "use_fast_search": true,
  "collection_id": "collection_id",
  "conversation_history": [
    {
      "role": "user",
      "content": "content"
    }
  ]
}
'

shell

Example Request Body

{
  "question": "question",
  "use_graph": true,
  "max_hops": 0,
  "use_reranking": true,
  "use_agentic": true,
  "use_fast_search": true,
  "collection_id": "collection_id",
  "conversation_history": [
    {
      "role": "user",
      "content": "content"
    }
  ]
}

json

Example Responses

{
  "answer": "answer",
  "sources": [
    {
      "content": "content",
      "document_id": "document_id",
      "filename": "filename",
      "score": 0
    }
  ],
  "graph_context": {
    "entities": [
      "string"
    ],
    "relationships": [
      {}
    ],
    "communities": [
      {}
    ]
  },
  "retrieval_stats": {}
}

json

application/json

Streaming answer

POST

http://localhost:8000

/api/ask/stream

Get a streaming answer using Server-Sent Events

Streaming answer › Request Body

question

string · required

use_graph

boolean

Default: true

max_hops

integer

Default: 2

use_reranking

boolean

Default: true

use_agentic

boolean

Default: false

use_fast_search

boolean

Default: false

collection_id

string

object[]

Streaming answer › Responses

200

Streaming response

string

POST/api/ask/stream

curl --request POST \
  --url http://localhost:8000/api/ask/stream \
  --header 'Content-Type: application/json' \
  --data '
{
  "question": "question",
  "use_graph": true,
  "max_hops": 0,
  "use_reranking": true,
  "use_agentic": true,
  "use_fast_search": true,
  "collection_id": "collection_id",
  "conversation_history": [
    {
      "role": "user",
      "content": "content"
    }
  ]
}
'

shell

Example Request Body

{
  "question": "question",
  "use_graph": true,
  "max_hops": 0,
  "use_reranking": true,
  "use_agentic": true,
  "use_fast_search": true,
  "collection_id": "collection_id",
  "conversation_history": [
    {
      "role": "user",
      "content": "content"
    }
  ]
}

json

Example Responses

string

plain

text/event-stream

Streaming with extended thinking

POST

http://localhost:8000

/api/ask/stream/thinking

Stream answer with visible reasoning steps

Streaming with extended thinking › Request Body

question

string · required

use_graph

boolean

Default: true

max_hops

integer

Default: 2

use_reranking

boolean

Default: true

use_agentic

boolean

Default: false

use_fast_search

boolean

Default: false

collection_id

string

object[]

Streaming with extended thinking › Responses

200

Streaming response with thinking

string

POST/api/ask/stream/thinking

curl --request POST \
  --url http://localhost:8000/api/ask/stream/thinking \
  --header 'Content-Type: application/json' \
  --data '
{
  "question": "question",
  "use_graph": true,
  "max_hops": 0,
  "use_reranking": true,
  "use_agentic": true,
  "use_fast_search": true,
  "collection_id": "collection_id",
  "conversation_history": [
    {
      "role": "user",
      "content": "content"
    }
  ]
}
'

shell

Example Request Body

{
  "question": "question",
  "use_graph": true,
  "max_hops": 0,
  "use_reranking": true,
  "use_agentic": true,
  "use_fast_search": true,
  "collection_id": "collection_id",
  "conversation_history": [
    {
      "role": "user",
      "content": "content"
    }
  ]
}

json

Example Responses

string

plain

text/event-stream

Search Knowledge Graph