- Overview
- Changelog
- Versioning
- Quick-Start Template for Building an App
- FAQs
- Guides
- Authentication
- Getting Started with Authentication
- Authentication and Token Refresh Guide
- SSO
- Feature Flags
- Authenticate User
- Request Passwordless Exchange Token
- Exchange Passwordless Token for Access Tokens
- Register User
- Refresh Access Token
- Update Own Password
- Validate Magic Link Token
- Passwordless Authentication (Email Magic Link)
- Verify Email OTP
- Request Password Recovery Email
- Reset Password
- Agents
- Agent Access
- Agent Alias
- Agent Tags
- Agent Chat Threads
- Agent Comment
- Agent Rating
- Agent Review
- Agent Tools
- Agent Vote
- Agent Type
- Evaluation Datasets
- Evaluation Runs
- Agent Permissions
- Agent Skills
- Get all Agents
- Create a new Agent
- Get an Agent
- Update an Agent
- Delete an Agent
- Activate an Agent
- Get Agent-Corpus Connections
- Create Multiple 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
- Get a single agent history record by history ID
- Create Custom Instructions for an Agent
- Update Custom Instructions for an Agent
- Delete a Custom Instruction 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 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 workflows for an agent
- Get all Starred Agents of the Authenticated User
- Get Staging Diff
- Get publish history for an agent
- Get rollback diff preview for a publish record
- Roll back staging agent to a previous publish
- Publish staging agent to main
- Clone an Agent
- Get diff detail for a publish record
- Agent Response
- Stream Agent Response (SSE)
- Generate Agent Response (Non-Streaming)
- Generate Token for Voice Call
- Get an Agent Response
- 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
- Stop an in-flight streaming response
- Resume a Streamed Response (SSE)
- 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 Workflow Summary Statistics
- Get Query Count Data
- Get Token Data
- Chat Thread
- Chat Logs
- Corpora
- Corpus Permissions
- Get all Permissions for a Corpus
- Grant permission on a corpus
- Update a permission on a corpus
- Revoke permission on a corpus
- Batch grant permissions on a corpus
- Batch revoke permissions on a corpus
- Get calling user's permissions on a corpus
- Get a user's permissions on a corpus
- Get a user's permissions across multiple 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
- Trigger a Refresh (Reindex) of a Corpus
- Get Sitemaps for a Corpus
- Get Corpora with Refresh (Reindex) Enabled
- Corpus Permissions
- Conversation Starters
- Citation
- Configurations
- Documents
- Feature Flags
- Get All Feature Flags
- Get Agent Alias Feature Flag
- Get Agent Evaluation 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 Flush Cache Feature Flag
- Get Google Drive Connector Feature Flag
- Get Guardrail Feature Flag
- Permission Sets Feature Flag
- Get PII Redaction Feature Flag
- Get Share Agent Feature Flag
- Get Sharepoint Legacy Feature Flag
- Show Quota Limit Feature Flag
- Get Skills Feature Flag
- Get Staging Agent Feature Flag
- Get Workflow Evaluation Feature Flag
- Get Youtube Index Feature Flag
- Guardrails
- Google Drive
- Metering
- Get Spend Limits
- Spend Enforcement Check
- Set Org Spend Limit
- Set Default User Spend Limit
- Set Per-User Spend Limit Override
- Remove Per-User Spend Limit Override
- Get Per-User Spend Limit Override
- Get Governance Settings
- Update Governance Settings
- Request Spend Limit Increase
- List Spend Limit Increase Requests
- Approve Spend Limit Increase Request
- Deny Spend Limit Increase Request
- Get Spend Overview
- Get Spend Trends Summary
- Get Daily Spend Trend
- Get Spend By Model
- Get Spend By Assistant
- Get Spend Users Table
- Get Spend User Detail
- Get My Spend
- Notifications
- Organizations
- Organization Permissions
- Get all ConfigurationsGET
- Get active configuration for an OrganizationGET
- Get the Model Deployment for an OrganizationGET
- Get all Tools in an OrganizationGET
- Disable a Tool for all Agents in an OrganizationDELETE
- Enable a Tool for all Agents in an OrganizationPOST
- Get all API Tool TemplatesGET
- Create a new API Tool TemplatePOST
- Create a new API toolPOST
- Create an attachment toolPOST
- Create a new RAG tool in an OrganizationPOST
- Create a Web Search Tool in an OrganizationPOST
- Get all Users in an OrganizationGET
- Create a User in an OrganizationPOST
- Get all Configurations of user's OrganizationGET
- Register LLM ConfigurationPOST
- Update LLM ConfigurationPUT
- Toggle LLM Configuration AvailabilityPATCH
- Delete LLM ConfigurationDELETE
- Get a specific LLM configuration by ID (admin only)GET
- Projects
- Project Permissions
- 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
- Permission Sets
- Skills
- List all Skills in an Organization
- Create a new Skill
- Retrieve a Skill in an Organization
- Update a Skill
- Disable a Skill for all Agents in an Organization
- Update Skill Metadata
- Enable a Skill for all Agents in an Organization
- Delete a Skill
- Get a Skill with Content
- Get a File from a Skill
- Download a Skill as a Zip Archive
- Sitemaps
- Tools
- Teams
- Team Permissions
- Get all Teams
- Create a Team
- Get a Team
- Update a Team
- Delete a Team
- Get a team's permission sets and effective permissions
- Preview a team's permissions after assigning/removing permission sets
- Get all Projects of a Team
- Create a Recent Team
- Get all Users in a Team
- Add Users to a Team
- Remove User from Team
- Get Recent Teams
- Get all Teams of the Authenticated User
- Users
- Get a User
- Update a User
- Delete a User
- Get Agent Responses of a User
- Assign a user to multiple permission sets
- Get all User Permissions
- Preview a user's permissions after assigning/removing permission sets
- 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
- Workflows
- Evaluation Datasets
- Evaluation Runs
- Workflow Permissions
- Get all Workflows
- Stream Workflow Response (SSE)
- Create a Workflow
- Get a Workflow
- Update a Workflow
- Delete a Workflow
- Get all Workflow Chat Threads
- Create a Workflow Chat Thread
- Get all Workflow Responses
- Create a Workflow Chat Response
- Get a Workflow Chat Thread
- Update a Workflow Chat Thread
- Delete a Workflow Chat Thread
- Get all Workflow Chat Responses
- Delete a Workflow Response
- Create a Workflow Feedback
- Retrieve a list of reviews for a given workflow response
- Create a Workflow Review
- Get Workflow Responses based on filters
Create a Web Search Tool in an Organization
POST
/api/v2/organizations/{organization_id}/tools/web-search-tools
Request
Path Params
Header Params
Body Params Required
application/json
Examples
Responses
🟢201Created
application/json
Bodyapplication/json
🟠400Bad Request
🟠403Record Not Found
🟠404Server Error
🔴500
🔴503
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff 'https:///api/v2/organizations//tools/web-search-tools' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
"name": "string",
"description": "string",
"search_engine": "string",
"search_engine_url": "string",
"search_engine_key": "string",
"top_k": 0,
"include_domains": [
null
]
}'Response Response Example
201 - Example 1
{
"success": true,
"message": "string",
"data": {
"id": 0,
"name": "string",
"description": "string",
"org": 0,
"tool_type": "rag",
"is_enabled": true,
"is_default": true,
"connection": true,
"created_by": "",
"search_engine": "duckduckgo",
"search_engine_url": "string",
"search_engine_key": "string",
"top_k": -2147483648,
"include_domains": {
"property1": "string",
"property2": "string"
}
}
}