- Overview
- Changelog
- Versioning
- FAQs
- Guides
- Authentication
- Agents
- Agent Access
- Agent Alias
- Agent Tags
- Agent Chat Threads
- Agent Comment
- Agent Rating
- Agent Review
- Agent Tools
- Agent User
- Agent User Permission
- Agent Vote
- Agent Type
- Evaluation Datasets
- Evaluation Runs
- Get all Agents
- Create a new Agent
- Get an Agent
- Update an Agent
- Delete an Agent
- Activate an Agent
- Get Agent-Corpus Connections
- Delete Agent-Corpus Connections
- Get Agent-Corpus Connection Details
- Create Agent-Corpus Connection
- Update Agent-Corpus Connection
- Delete Agent-Corpus Connection
- Get agent history with pagination
- Restore an agent to a previous checkpoint
- Create Custom Instructions for an Agent
- Get Agent Prompt History
- Create a Recent Agent
- Delete a Recent Agent
- Get Agent Details with Starred Status
- Create Starred Agent
- Delete Starred Agent
- Get the Status of an Agent
- Get User's Team Role for an Agent
- Get all Character Voices
- Get Agent Filter
- Generate an image for an agent based on the provided description
- Get all Agents by Project
- Get list of Recent Agents
- Get all Starred Agents of the Authenticated User
- Get Agents accessible to the Current User across their Teams
- Get Agents by Project team, User team
- Create Multiple Agent-Corpus Connections
- Agent Response
- Get an Agent Response
- Stream Agent Response (SSE)
- Generate Agent Response (Non-Streaming)
- Update an Agent Response
- Delete an Agent Response
- Get Comments for Agent Response
- Create a Comment for Agent Response
- Create a Feedback for an Agent Response
- Pin an Agent Response
- Unpin an Agent Response
- Get Supporting Content of an Agent Response
- Get Thoughts of an Agent Response
- Get Agent Responses based on filters
- Get Agent Responses of an Agent
- Create Agent Response Log
- Get Pinned Agent Responses
- Create Bulk Agent Response Logs
- Chat Thread
- Chat Logs
- Conversation Starters
- Teams
- Projects
- Retrieve all Projects
- Create a Project
- Get a Project
- Update a Project
- Delete a Project
- Get Agent Responses using Project ID
- Add a Recent Project for a User
- Add Users to a Project
- Remove a User from a Project
- Get all Workflows for a Project
- Get multiple Projects by their IDs
- Get Projects based on filters
- Get Recent Projects for a User
- Get Projects with Team Details
- Corpora
- Get all Corpus
- Upload a Document to a Corpus
- Create a Corpus
- Get a Corpus
- Update a Corpus
- Delete a Corpus
- Get Corpus Agent Connections
- Get Default Corpus Agent Connection
- Annotate/Tag a Corpus
- Get Conversation Starters for a Corpus
- Get all Documents for a Corpus
- Delete Document(s) from a Corpus
- Check Duplicate Documents in a Corpus
- Get all Permissions for a Corpus
- Create a new Permission for a Corpus
- Delete a user permission for a corpus
- Get all user permissions for a corpus
- Trigger a Refresh (Reindex) of a Corpus
- Get Sitemaps for a Corpus
- Get Corpora with Refresh (Reindex) Enabled
- Documents
- Organizations
- Get all Configurations
- Get active configuration for an Organization
- Get the Model Deployment for an Organization
- Get all Tools in an Organization
- Disable a Tool for all Agents in an Organization
- Enable a Tool for all Agents in an Organization
- Get all API Tool Templates
- Create a new API Tool Template
- Create a new API tool
- Create an attachment tool
- Create a new RAG tool in an Organization
- Create a Web Search Tool in an Organization
- Get all Users in an Organization
- Create a User in an Organization
- Get all Configurations of user's Organization
- Users
- Get a User
- Update a User
- Delete a User
- Get Agent Responses of a User
- Get all User Permissions
- Create a new User Organization Permission
- Update the Organization Permission of a User
- Delete a User Organization Permission
- Get Projects of a User
- Get all Workflow Tables for a User
- Get all Workflows for a User
- Delete multiple Users
- Get a specific User by user_email
- Get all Users
- Get authenticated User
- Get User Projects
- Analytics
- Get Agent Cost Data
- Get Agent Document Count Data
- Get Agent Indexing Mode Data
- Get Agent Most Active Data
- Get Agent Query Count Data
- Get Recent Agent Data
- Get Agent Summary Statistics
- Get Agent Token Data
- Get Agent Vote Data
- Get Corpus Document Count Data
- Get Corpus Indexing Mode Data
- Get Cost Data
- Get Document Count Data
- Get Indexing Mode Data
- Get Project Cost Data
- Get Project Document Count Data
- Get Project Indexing Mode Data
- Get Project Most Active Data
- Get Project Query Count Data
- Get Recent Project Data
- Get Project Summary Statistics
- Get Project Token Data
- Get Project Vote Data
- Get Overall Summary Statistics
- Get Team Cost Data
- Get Team Document Count Data
- Get Team Indexing Mode Data
- Get Team Most Active Data
- Get Team Query Count Data
- Get Recent Team Data
- Get Team Summary Statistics
- Get Team Token Data
- Get Team Vote Data
- Get Total Entity Counts
- Get User Cost Data
- Get User Document Count Data
- Get User Indexing Mode Data
- Get User Most Active Data
- Get User Query Count Data
- Get Recent User Data
- Get User Summary Statistics
- Get User Token Data
- Get User Vote Data
- Get Vote Count Data
- Get Query Count Data
- Get Token Data
- Configurations
- Guardrails
- Feature Flags
- Get All Feature Flags
- Get Agent Alias Feature Flag
- Get Api Tools Feature Flag
- Get Caching Feature Flag
- Get Call Feature Flag
- Get Chat Agent Creation Feature Flag
- Get Chat Widget Feature Flag
- Get dall_e Image Generation Feature Flag
- Get Developer Portal Feature Flag
- Get Guardrail Feature Flag
- Get PII Redaction Feature Flag
- Get Share Agent Feature Flag
- Get Sharepoint Connector Feature Flag
- Get Sharepoint Index Feature Flag
- Get Flush Cache Feature Flag
- Show Quota Limit Feature Flag
- Get Youtube Index Feature Flag
- Get Workflow Evaluation Feature Flag
- Notifications
- Tools
- Workflows
- Evaluation Datasets
- Evaluation Runs
- Get all WorkflowsGET
- Create a WorkflowPOST
- Get a WorkflowGET
- Stream Workflow Response (SSE)POST
- Update a WorkflowPUT
- Delete a WorkflowDELETE
- Get all Workflow Chat ThreadsGET
- Create a Workflow Chat ThreadPOST
- Create a Workflow Chat ResponsePOST
- Get a Workflow Chat ThreadGET
- Update a Workflow Chat ThreadPUT
- Delete a Workflow Chat ThreadDELETE
- Get all Workflow Chat ResponsesGET
- Delete a Workflow ResponseDELETE
- Create a Workflow FeedbackPOST
- Retrieve a list of reviews for a given workflow responseGET
- Create a Workflow ReviewPOST
- Get all Workflow ResponsesGET
- Citation
- Sitemaps
Create Workflow Evaluation Run
POST
/api/v2/workflows/{workflow_id}/evaluation-runs
Request
Path Params
Header Params
Body Params application/json
Examples
Responses
🟢201Created
application/json
Body
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https:///api/v2/workflows//evaluation-runs' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
"evaluation_name": "string",
"name": "string",
"dataset_public_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metric_names": [
"string"
],
"llm_config": {
"property1": null,
"property2": null
},
"prefix_prompt": "string",
"model_deployment": "string",
"custom_instructions": {
"property1": null,
"property2": null
},
"source_enabled": false,
"workflow_chunk_count": 0,
"metadata": {
"property1": null,
"property2": null
}
}'Response Response Example
201 - Example 1
{
"message": "string",
"success": true,
"data": {
"bridge_id": 0,
"workflow_id": 0,
"id": 0,
"public_id": "eb3ce6c7-ce7e-4638-a072-e5054706f601",
"evaluation_name": "string",
"status": "string",
"created_on": "2019-08-24T14:15:22Z",
"created_by": "string",
"dataset_count": 0,
"total_queries": 0
}
}