Upload brand guidelines document

POST

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

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/ai_agents/1/brand_guidelines_doc';
const form = new FormData();
form.append('file', 'file');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/ai_agents/1/brand_guidelines_doc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file=@file

Uploads a brand guidelines document to the AI agent.

Authorizations

OAuth2
agents:write

Parameters

Path Parameters

workspace_id

required

integer

Workspace ID

required

integer

AI agent ID

Request Body

multipart/form-data

object

file

required

string format: binary

Responses

201

Successful

401

Unauthorized

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

403

Forbidden

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

404

Not Found

application/json

object

message

required

string

Example

{
  "message": "Record not found"
}

422

Unprocessable Entity

application/json

object

message

required

string

errors

required

object

key

additional properties

Array<string>

Example

{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}