Overview
SDK Endpoints
- GETList all agents in the workspace
- POSTCreate a new agent
- GETGet a specific agent by ID
- PUTUpdate an existing agent
- DELDelete an agent
- GETGet user input collection for an agent
- POSTCreate user input collection for an agent
- GETGet summary of an agent
- GETList all QAndAs in the workspace
- POSTCreate a new QAndA
- GETGet a specific QAndA by ID
- PUTUpdate an existing QAndA
- DELDelete a QAndA
- GETList all QAndAs used by a specific agent
- GETGet a specific action by ID
- PUTUpdate an existing action
- DELDelete a action
- GETList all actions for a specific agent
- POSTCreate a new action
- GETList all existing guardrails
- POSTCreate a new guardrail
- GETGet a specific guardrail by ID
- PUTUpdate an existing guardrail
- DELDelete a guardrail
- GETList all guardrails for a specific agent
- POSTSend a message to an agent and gets the response
- GETGet list of chat runs/conversations
- GETGet chat runs for a specific agent
- GETGet detailed chat run data
- GETGet chat messages for a run
- POSTAdd Guardrail Variable
- POSTGet Guardrail Variable
- POSTAdd Format Answer
- POSTGet Format Answer
- GETGet Tool Calls For Agent
- DELDelete all tool calls for an agent
- POSTAdd Tool Call
- POSTTest Tool
Evaluation API Endpoints
- GETHealth check
- GETList agents
- POSTCreate agent
- POSTCreate anonymous agent
- GETGet agent by ID
- PUTUpdate agent
- DELDelete agent
- PATCHPartially update agent
- POSTClaim agent
- GETGet agent configs
- POSTCreate agent config
- DELDelete agent config
- GETGet test prompts
- POSTCreate test prompt
- PUTUpdate test prompt
- DELDelete test prompt
- GETGet test results
- POSTReset test results
- POSTRun test for prompt
- POSTImport knowledge from URL
- POSTUpload PDF
- POSTCreate session
- GETGet session messages
- POSTCreate session message
- GETGet message generation steps
- POSTCreate message generation step
- POSTCheck hallucination
- POSTQuick chat
- GETGet optimization knowledge elements
- POSTGenerate QA pair
- GETGet optimization items
- POSTCreate optimization item
- DELDelete all optimization items
- DELDelete optimization item
- PATCHUpdate optimization item
Get a specific guardrail by ID
Copy
curl --request GET \
--url https://api.example.com/api/sdk/guardrail/{guardrail_id}Copy
{
"guardrails": [
{
"type": "<string>",
"instruction": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}SDK Endpoints
Get a specific guardrail by ID
GET
/
api
/
sdk
/
guardrail
/
{guardrail_id}
Get a specific guardrail by ID
Copy
curl --request GET \
--url https://api.example.com/api/sdk/guardrail/{guardrail_id}Copy
{
"guardrails": [
{
"type": "<string>",
"instruction": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
]
}⌘I