Skip to main content
PUT
Update AI agent
Call this endpoint on the AI service: https://ai.pingmee.co.il.
You can update name, description, roles, and vectorStore.required. When a role changes, its OpenAI function tool is regenerated automatically.

Field length limits

These match the Pingmee app. Requests that exceed them return 400.

Authorizations

Personal access token from Pingmee Settings → Developer Tools

x-api-key
string
header
required

Business API key from Pingmee Settings → Developer Tools

Path Parameters

id
string
required

AI agent identifier

Body

application/json

Fields to update on the AI agent

Partial update payload for an AI agent. Length limits: description 5000; role name 40; role description/instructions 1500; role webhook 300.

name
string

New display name

description
string

New description (max 5000 characters)

Maximum string length: 5000
roles
object[]

Full roles list. Changed roles regenerate their tool schemas. Limits: name 40, description 1500, instructions 1500, webhook 300.

vectorStore
object

Only required is updatable

Response

AI agent updated

message
string
required
Example:

"AIAgent '123' updated successfully."