Update AI agent

PATCH

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

Updates a single AI agent by ID.

Authorizations

• BearerAuth

Parameters

Path Parameters

workspace_id

required

integer

Workspace ID

id

required

integer

AI agent ID

Request Body

object

name

string

company_name

The company name the AI agent should reference in generated content.

string

Example

Acme Corp

company_overview

A brief overview of the company for the AI agent to use as context.

string

Example

Acme Corp is a SaaS company that provides project management tools.

tone

The desired tone of voice for AI-generated content.

string

Example

Professional but friendly

guidelines

Custom guidelines or rules the AI agent should follow when generating content.

string

Example

Always include a call-to-action. Avoid using jargon.

Responses

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

Unauthorized

object

message

required

string

Example

Record not found

403

Forbidden

object

message

required

string

Example

Record not found

404

Not Found

object

message

required

string

Example

Record not found

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."
    ]
  }
}