Create Agent By Configure

Creates a new Agent with a specified configuration, associating it with a user and a project.
This endpoint allows users to customize an agent’s behavior, access level, and functionality by defining various parameters in the request body.

Purpose of This Endpoint

Enables users to set up new agents for different tasks and workflows.

Allows fine-tuned configuration, including name, description, and settings.

Associates the agent with a specific project and user ownership.

Ensures agents are properly structured for team collaboration and controlled access.

To retrieve an agent’s current details, use the Get Agent endpoint.

To update an agent, use the Edit Agent endpoint

Step-by-Step Guide to Creating an Agent

To follow a detailed, step-by-step guide on how to create an agent, visit:
Create Agent by Configure

For more detailed information about agent, refer to the Agent Guide.

📝 Note: "Assistant" is another name for "Agent".

Request Body Parameters

Agent Association

user_id (integer): The user ID of the agent's owner.

project_id (integer): The project ID to which the agent belongs.

Agent Identity

name (string): The name of the agent.

description (string): A brief description of the agent.

type (string): The category of the agent (e.g., QnA, Custom).

Behavior Customization

prefix_prompt (string): A predefined prompt to guide the agent’s responses.

custom_instructions (string): Specific instructions to control the agent’s behavior.

Optional Features

create_email_alias (boolean): Whether an email alias should be generated.

access (string): The agent's visibility setting (e.g., "Only me").

Model and Sample Interactions

llm_config_id (string): The LLM config id of LLM model to be used by the agent.

sample_q1 (string): Sample question 1.

sample_q2 (string): Sample question 2.

sample_q3 (string): Sample question 3.

curl --location -g --request POST 'https:///v2/api/agent' \ --header 'Ocp-Apim-Subscription-Key: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'user_id=247' \ --data-urlencode 'project_id=254' \ --data-urlencode 'name=User API testing' \ --data-urlencode 'description=This is an API testing agent' \ --data-urlencode 'type=QnA' \ --data-urlencode 'prefix_prompt=abc' \ --data-urlencode 'custom_instructions=[]' \ --data-urlencode 'create_email_alias=true' \ --data-urlencode 'access=Only me' \ --data-urlencode 'Ilm_config_id=' \ --data-urlencode 'sample_q1=chk' \ --data-urlencode 'sample_q2=chk' \ --data-urlencode 'sample_q3=chk'

{ "success": true, "message": "Agent created successfully", "data": { "id": 1302, "agent_type": { "id": 1, "created_by": "System", "created_on": "2024-04-17T23:10:22.313394Z", "modified_by": "[email protected]", "modified_on": "2024-04-17T23:10:22.313414Z", "name": "QnA", "description": "" }, "instructions": [ {} ], "user": { "id": 122, "email": "[email protected]", "first_name": "Function", "last_name": "App", "organization": 1 }, "connected_tool_names": [ "string" ], "agent_name": "User API testing", "industry_area": "", "domain": "This is an API testing agent", "sample_q1": "chk", "sample_q2": "chk", "sample_q3": "chk", "prefix_prompt": "abc", "alias": null, "is_active": true, "is_deleted": false, "created_by": "[email protected]", "created_on": "2025-01-30T19:34:21.194938Z", "agent_image": null, "access": "Only me", "status": "Live", "caching_enabled": false, "chunk_count": 32, "react_enabled": true, "react_max_iteration_count": 50, "project": 254, "llm_config": null, "cloned_from": null } }

Create Agent By Configure

Purpose of This Endpoint#

Related API Endpoints#

Step-by-Step Guide to Creating an Agent#

Request Body Parameters#

Request

Responses

Purpose of This Endpoint

Related API Endpoints

Step-by-Step Guide to Creating an Agent

Request Body Parameters