Skip to main content
POST
Unpublish an agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

spaceId
required

ID of the space the agent belongs to.

Required string length: 2 - 6
agentId
string<uuid>
required

Unique ID of the agent.

Response

Agent unpublished successfully.

id
string<uuid>
required

Unique ID of the agent. Use it with the Completion API (agentId option) to chat with the agent.

spaceId
required

ID of the space the agent belongs to.

Required string length: 2 - 6
name
string
required
description
string
required
systemInstruction
string | null
required
conversationStarters
object[]
required
welcomeMessage
object | null
required
model
string | null
required
temperature
number | null
required
attachmentIds
string<uuid>[]
required
folderIds
string<uuid>[]
required
contentIds
string<uuid>[]
required
allowUploads
boolean
required
allowUrls
boolean
required
enableFollowUpMessages
boolean
required
categoryId
number | null
required
voiceId
string | null
required
appEnabled
boolean
required
embedEnabled
boolean
required

Whether the agent is published as an external, embeddable chat widget.

embedId
string | null
required

Identifier used to embed the agent as an external widget.

embedOptions
object
required

External embed widget options (draft state).

actions
object[]
required

Actions/tools configured on the agent (draft state).

isSystemAgent
boolean
required

true for built-in nuwacom system agents (cannot be updated or deleted).

published
boolean
required

Whether a published version of the agent exists. Publishing happens in the nuwacom app.

hasUnpublishedChanges
boolean
required

true when the draft differs from the published version (or nothing has been published yet).

createdAt
string
required
updatedAt
string
required