Cortex API

Custom Inputs

Endpoint

Manual knowledge input (Q&A, text, markdown)

Create custom input

POST

http://localhost:8000

/api/custom-input

Add Q&A pair, text, or markdown content manually

Create custom input › Request Body

input_type

string · enum · required

Enum values:

text

markdown

content

string · required

answer

string

Required for Q&A type

collection_id

string

source

string

Custom source identifier (defaults to 'custom_input' if not set)

Create custom input › Responses

200

Custom input created

id

string

input_type

string

filename

string

source

string

Origin of the document

created_at

string · date-time

POST/api/custom-input

curl --request POST \
  --url http://localhost:8000/api/custom-input \
  --header 'Content-Type: application/json' \
  --data '
{
  "input_type": "qa",
  "content": "content",
  "answer": "answer",
  "collection_id": "collection_id",
  "source": "source"
}
'

shell

Example Request Body

{
  "input_type": "qa",
  "content": "content",
  "answer": "answer",
  "collection_id": "collection_id",
  "source": "source"
}

json

Example Responses

{
  "id": "id",
  "input_type": "input_type",
  "filename": "filename",
  "source": "source",
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Generate topic hint

POST

http://localhost:8000

/api/custom-input/generate-topic

Use LLM to suggest a title for content

Generate topic hint › Request Body

content

string · required

Generate topic hint › Responses

200

Topic generated

topic

string

POST/api/custom-input/generate-topic

curl --request POST \
  --url http://localhost:8000/api/custom-input/generate-topic \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "content"
}
'

shell

Example Request Body

{
  "content": "content"
}

json

Example Responses

{
  "topic": "topic"
}

json

application/json

List custom inputs

GET

http://localhost:8000

/api/custom-inputs

List custom inputs › Responses

200

Custom inputs retrieved

object[]

GET/api/custom-inputs

curl --request GET \
  --url http://localhost:8000/api/custom-inputs

shell

Example Responses

{
  "custom_inputs": [
    {
      "id": "id",
      "input_type": "input_type",
      "content": "content",
      "answer": "answer",
      "filename": "filename",
      "collection_id": "collection_id",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Get custom input details

GET

http://localhost:8000

/api/custom-inputs/{input_id}

Get custom input details › path Parameters

input_id

string · required

Get custom input details › Responses

200

Custom input retrieved

id

string

input_type

string

content

string

answer

string

filename

string

collection_id

string

created_at

string · date-time

GET/api/custom-inputs/{input_id}

curl --request GET \
  --url http://localhost:8000/api/custom-inputs/:input_id

shell

Example Responses

{
  "id": "id",
  "input_type": "input_type",
  "content": "content",
  "answer": "answer",
  "filename": "filename",
  "collection_id": "collection_id",
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Documents Search

Cortex API

Custom Inputs

Endpoint

Manual knowledge input (Q&A, text, markdown)

Create custom input

POST

http://localhost:8000

/api/custom-input

Add Q&A pair, text, or markdown content manually

Create custom input › Request Body

input_type

string · enum · required

Enum values:

text

markdown

content

string · required

answer

string

Required for Q&A type

collection_id

string

source

string

Custom source identifier (defaults to 'custom_input' if not set)

Create custom input › Responses

200

Custom input created

id

string

input_type

string

filename

string

source

string

Origin of the document

created_at

string · date-time

POST/api/custom-input

curl --request POST \
  --url http://localhost:8000/api/custom-input \
  --header 'Content-Type: application/json' \
  --data '
{
  "input_type": "qa",
  "content": "content",
  "answer": "answer",
  "collection_id": "collection_id",
  "source": "source"
}
'

shell

Example Request Body

{
  "input_type": "qa",
  "content": "content",
  "answer": "answer",
  "collection_id": "collection_id",
  "source": "source"
}

json

Example Responses

{
  "id": "id",
  "input_type": "input_type",
  "filename": "filename",
  "source": "source",
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Generate topic hint

POST

http://localhost:8000

/api/custom-input/generate-topic

Use LLM to suggest a title for content

Generate topic hint › Request Body

content

string · required

Generate topic hint › Responses

200

Topic generated

topic

string

POST/api/custom-input/generate-topic

curl --request POST \
  --url http://localhost:8000/api/custom-input/generate-topic \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "content"
}
'

shell

Example Request Body

{
  "content": "content"
}

json

Example Responses

{
  "topic": "topic"
}

json

application/json

List custom inputs

GET

http://localhost:8000

/api/custom-inputs

List custom inputs › Responses

200

Custom inputs retrieved

object[]

GET/api/custom-inputs

curl --request GET \
  --url http://localhost:8000/api/custom-inputs

shell

Example Responses

{
  "custom_inputs": [
    {
      "id": "id",
      "input_type": "input_type",
      "content": "content",
      "answer": "answer",
      "filename": "filename",
      "collection_id": "collection_id",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Get custom input details

GET

http://localhost:8000

/api/custom-inputs/{input_id}

Get custom input details › path Parameters

input_id

string · required

Get custom input details › Responses

200

Custom input retrieved

id

string

input_type

string

content

string

answer

string

filename

string

collection_id

string

created_at

string · date-time

GET/api/custom-inputs/{input_id}

curl --request GET \
  --url http://localhost:8000/api/custom-inputs/:input_id

shell

Example Responses

{
  "id": "id",
  "input_type": "input_type",
  "content": "content",
  "answer": "answer",
  "filename": "filename",
  "collection_id": "collection_id",
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Documents Search