Create Custom Instructions

POST

/instruction/update

Chat APIs

Allows users to create, update, and assign custom instructions to an agent, tailoring the agent's behavior or responses according to specific requirements.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/instruction/update' \
--header 'Content-Type: application/json' \
--data-raw '{
    "agent": 525,
    "created_by": "user@example.com",
    "custom_instructions": [
        "Provide step by step and detailed answers"
    ]
}'

Response Example

[
    {
        "id": 8708,
        "instruction": "Provide step by step and detailed answers",
        "is_deleted": false,
        "created_by": "user@example.com",
        "created_on": "2024-10-16T19:42:30.233724Z",
        "agent": 525
    }
]

Request

Body Params application/json

agent

integer

optional

Example:

525

created_by

string <email>

optional

Example:

user@example.com

custom_instructions

array[string]

optional

Example:

["Provide step by step and detailed answers"]

Examples

Responses

🟢200OK

application/json

Custom instruction created or updated successfully.

Body

array of:

integer

optional

Example:

8708

instruction

string

optional

Example:

Provide step by step and detailed answers

is_deleted

boolean

optional

Example:

false

created_by

string <email>

optional

Example:

user@example.com

created_on

string <date-time>

optional

Example:

2024-10-16T19:42:30.233724Z

agent

integer

optional

Example:

525

🟠400Bad Request

🟠404Record Not Found

Run Chat

Add Comment Feedback