Context Data (1.0.0)

Download OpenAPI specification:Download

Authentication

Token

Login using your Context Data user login and generate your token

Request Body schema: application/json
required
username
required
string (Username) <= 150 characters

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

password
required
string (Password)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Logout

Authorizations:
AuthBearer

Responses

Workspace

Get Source Connections

Get all configured source connections

Authorizations:
AuthBearer

Responses

Get Source Connection

Retrieve details of a source connection

Authorizations:
AuthBearer
path Parameters
connection_identifier
required
string (Connection Identifier)

Responses

Get Embedding Models

Get all configured embedding models

Authorizations:
AuthBearer

Responses

Get Chat Models

Get all configured chat models

Authorizations:
AuthBearer

Responses

Get Target Connections

Get all configured target connections

Authorizations:
AuthBearer

Responses

Get Target Connection

Retrieve details of a target connection

Authorizations:
AuthBearer
path Parameters
connection_identifier
required
string (Connection Identifier)

Responses

Get Flows

Get all Flows created within this account

Authorizations:
AuthBearer

Responses

Get Flow

Retrieve details of a Flow

Authorizations:
AuthBearer
path Parameters
flow_identifier
required
string (Flow Identifier)

Responses

Trigger Flow

Trigger a flow externally

Authorizations:
AuthBearer
path Parameters
flow_identifier
required
string (Flow Identifier)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": { }
}

Get Flow Logs

Get Flow Logs for a specific flow

Authorizations:
AuthBearer
path Parameters
flow_identifier
required
string (Flow Identifier)

Responses

Query

Run a vector search query on configured target connection

Authorizations:
AuthBearer
Request Body schema: application/json
required
vector_store_identifier
required
string (Vector Store Identifier)

Vector Store (Target Connection) identifier. Get the UUID from the '/target_connections' endpoint

vector_store_column
required
Array of strings (Vector Store Column)

Specify the columns/fields in the target vector store connection

embedding_model_identifier
required
string (Embedding Model Identifier)

Embedding model identifier. Get the UUID from the '/embedding_models' endpoint

query_text
required
string (Query Text)

Your query text

Response Limit (integer) or Response Limit (null) (Response Limit)

Responses

Request samples

Content type
application/json
{
  • "vector_store_identifier": "string",
  • "vector_store_column": [
    ],
  • "embedding_model_identifier": "string",
  • "query_text": "string",
  • "response_limit": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": { }
}

Get Query Sessions

Get all Query Sessions

Authorizations:
AuthBearer

Responses

Create Query Session

Create a new Query Session

Authorizations:
AuthBearer
Request Body schema: application/json
required
session_name
required
string (Session Name)

Provide a unique name to identify your session

vector_store_identifier
required
string (Vector Store Identifier)

Vector Store (Target Connection) identifier. Get the UUID from the '/target_connections' endpoint

vector_store_column
required
string (Vector Store Column)

Specify the column/field in the target vector store connection

embedding_model_identifier
required
string (Embedding Model Identifier)

Embedding model identifier. Get the UUID from the '/embedding_models' endpoint

required
System Message (string) or System Message (null) (System Message)

[Optional] Add an initial system message to the session

chat_model_identifier
required
string (Chat Model Identifier)

Chat Model identifier. Get the UUID from the '/chat_models' endpoint

required
Response Limit (integer) or Response Limit (null) (Response Limit)
required
Max Tokens (integer) or Max Tokens (null) (Max Tokens)

[Optional] Enter the maximum number of tokens for each query and response

temperature
required
number (Temperature) > 0

Enter your desired temperature

Responses

Request samples

Content type
application/json
{
  • "session_name": "string",
  • "vector_store_identifier": "string",
  • "vector_store_column": "string",
  • "embedding_model_identifier": "string",
  • "system_message": "string",
  • "chat_model_identifier": "string",
  • "response_limit": 0,
  • "max_tokens": 0,
  • "temperature": 0
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": { }
}

Session Chat

Conduct a RAG Interaction with your Query Session

Authorizations:
AuthBearer
path Parameters
session_identifier
required
string (Session Identifier)
Request Body schema: application/json
required
query_text
required
string (Query Text)

Responses

Request samples

Content type
application/json
{
  • "query_text": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": { }
}

Get Session History

Get Query Session History

Authorizations:
AuthBearer
path Parameters
session_identifier
required
string (Session Identifier)

Responses