Skip to content
Documentation

Update AI agent

PATCH
/api/v1/workspaces/{workspace_id}/ai_agents/{id}

Updates a single AI agent by ID.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
integer

Workspace ID

id
required
integer

AI agent ID

Request Body

Section titled “Request Body ”
object
name
string
company_name
string
company_overview
string
tone
string
guidelines
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

object
id
required
integer
Example
12345
name
required
string
Example
My AI Agent
company_name
required
string
nullable
Example
My Company
company_overview
required
string
nullable
Example
My Company is a company that makes widgets.
tone
required
string
nullable
Example
My Company is a company that makes widgets.
guidelines
required
string
nullable
Example
My Company is a company that makes widgets.
brand_guidelines_document_name
required
string
nullable
Example
My Company Brand Guidelines
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
updated_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z

401

Section titled “401 ”

Unauthorized

object
message
required
string
Example
Record not found

403

Section titled “403 ”

Forbidden

object
message
required
string
Example
Record not found

404

Section titled “404 ”

Not Found

object
message
required
string
Example
Record not found

422

Section titled “422 ”

Unprocessable Entity

object
message
required
string
Example
Failed to save
errors
required
object
key
additional properties
Array<string>
Example
{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}