API Reference
Workflows
Runs
Knowledge Bases
- GETGet Knowledge Base
- POSTAdd Knowledge Base
- GETGet Knowledge Bases
- DELDelete Knowledge Base
- PATCHUpdate Knowledge Base
- POSTAdd Knowledge Base Document
- GETGet Knowledge Base Document
- GETGet Knowledge Base Documents
- PATCHUpdate Knowledge Base Document
- DELDelete Knowledge Base Document
- POSTUpload Train Knowledge Base
- POSTGeneric Train Knowledge Base
- POSTRetry Reingesting all Documents with Errors
- GETGet Knowledge Base Running Jobs
Conversations
Conversations
Add Message
Add a message to a conversation
POST
/
v1
/
conversations
/
{conversation_id}
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"last_updated_at": "2023-11-07T05:31:56Z",
"etag": "<string>",
"settings": {
"model_selection": [
"<string>"
],
"temperature": 0.4,
"max_tokens": 123,
"tools": [
{
"name": "Web Research",
"description": "Search the web for information",
"enabled": true,
"type": "web_research"
},
{
"name": "Noxus Q&A",
"description": "Answer questions about the Noxus platform",
"enabled": true,
"type": "noxus_qa"
},
{
"name": "Select Knowledge Base Q&A",
"description": "Select a knowledge base to answer questions about",
"enabled": true,
"type": "kb_selector"
}
],
"extra_instructions": "<string>"
},
"messages": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"message_parts": [
{
"role": "user",
"type": "user",
"content": "",
"tool": "web_research",
"kb_id": "<string>",
"files": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"size": 123,
"type": "<string>",
"status": "pending",
"url": "<string>"
}
],
"model_selection": [
"<string>"
],
"images": [
"<string>"
]
}
]
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
application/json
Response
200
application/json
Successful Response
The response is of type object
.
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"last_updated_at": "2023-11-07T05:31:56Z",
"etag": "<string>",
"settings": {
"model_selection": [
"<string>"
],
"temperature": 0.4,
"max_tokens": 123,
"tools": [
{
"name": "Web Research",
"description": "Search the web for information",
"enabled": true,
"type": "web_research"
},
{
"name": "Noxus Q&A",
"description": "Answer questions about the Noxus platform",
"enabled": true,
"type": "noxus_qa"
},
{
"name": "Select Knowledge Base Q&A",
"description": "Select a knowledge base to answer questions about",
"enabled": true,
"type": "kb_selector"
}
],
"extra_instructions": "<string>"
},
"messages": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"message_parts": [
{
"role": "user",
"type": "user",
"content": "",
"tool": "web_research",
"kb_id": "<string>",
"files": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"size": 123,
"type": "<string>",
"status": "pending",
"url": "<string>"
}
],
"model_selection": [
"<string>"
],
"images": [
"<string>"
]
}
]
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.