retriever

POST`/api/v1/retriever/retrieve`

Retrieve

Retrieve documents.

Request Body

`query`
Required
Query

`index_name`
Required
Index Name

Status code	Description
`200`	Successful Response
`422`	Validation Error

curl -X POST "https://example.com/api/v1/retriever/retrieve" \
  -d '{
  "query": "string",
  "index_name": "string"
}'

null

POST`/api/v1/retriever/ingest`

Ingest

Ingest documents.

Request Body

`index_name`
Required
Index Name

`loader_type`
Required
Loader Type

`kwargs`
Required
Kwargs

Status code	Description
`200`	Successful Response
`422`	Validation Error

curl -X POST "https://example.com/api/v1/retriever/ingest" \
  -d '{
  "index_name": "string",
  "loader_type": "string",
  "kwargs": {}
}'

null

GET`/api/v1/retriever/ingest/status/{task_id}`

Ingest Status

Get ingest task status.

Path Parameters

`task_id`
Required
Task Id

Status code	Description
`200`	Successful Response
`422`	Validation Error

curl -X GET "https://example.com/api/v1/retriever/ingest/status/string"

null

retriever

POST/api/v1/retriever/retrieve

Retrieve

Request Body

queryRequiredQuery

index_nameRequiredIndex Name

Response

Typescript

POST/api/v1/retriever/ingest

Ingest

Request Body

index_nameRequiredIndex Name

loader_typeRequiredLoader Type

kwargsRequiredKwargs

Object Type

Response

Typescript

GET/api/v1/retriever/ingest/status/{task_id}

Ingest Status

Path Parameters

task_idRequiredTask Id

Response

Typescript

On this page

POST`/api/v1/retriever/retrieve`

`query`
Required
Query

`index_name`
Required
Index Name

POST`/api/v1/retriever/ingest`

`index_name`
Required
Index Name

`loader_type`
Required
Loader Type

`kwargs`
Required
Kwargs

GET`/api/v1/retriever/ingest/status/{task_id}`

`task_id`
Required
Task Id