Create a note for a workplace

post

Creates a note for a workplace.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer {apikey}

Path parameters

agentIdstringRequired

The ID of the agent.

workplaceIdstringRequired

The ID of the workpace.

Body

application/json

textstringRequired

The text of the note.

Responses

200

Successful Response

application/json

codestringOptionalExample: WORKPLACE_NOTE_CREATED

messagestringOptionalExample: The workplace note was created successfully.

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Validation Error

application/json

post

/v1/agents/{agentId}/workplaces/{workplaceId}/notes

HTTPcURLJavaScriptPython

POST /v1/agents/{agentId}/workplaces/{workplaceId}/notes HTTP/1.1
Host: api.voxity.ai
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "text": "text"
}

{
  "code": "WORKPLACE_NOTE_CREATED",
  "message": "The workplace note was created successfully."
}