AWawork-io
customAgents

Updates the custom agent's configuration.

Changed on

Updates the custom agent's configuration and returns the saved agent. Saves a new system prompt version if the prompt changes. <Check title="Required Permissions" icon="key">The user must have manage access to the agent. Changing workspace sharing also requires permission to contribute to the agent library.</Check>

put/agents/{agentId}

Request

  • Base URL
    https://api.awork.com/api/v1
  • URL
    https://api.awork.com/api/v1/agents/{agentId}
  • Auth
    HTTP bearer

Path parameters

agentIdstring uuid required

The agent id.

Request body

namestring required

The name shown to users.

descriptionstring required

A short explanation of what the agent does.

workspaceAccessLevel'none' | 'read' | 'manage' required

The access level granted to every member of the workspace.

modelProviderstring nullable

The model provider when no preset is selected.

modelNamestring nullable

The model name when no preset is selected.

presetKeystring nullable

The workspace model preset to use.

reasoningLevelstring required

The amount of reasoning the model uses.

systemPromptstring required

The instructions that control the agent's behavior.

webSearchEnabledboolean required

Whether web search is enabled.

aworkAccessEnabledboolean required

Whether awork access is enabled.

googleGenAiAccessEnabledboolean required

Whether Google image generation is enabled.

openAiImageGenerationAccessEnabledboolean required

Whether OpenAI image generation is enabled.

Response

OK

idstring uuid

The id of the entity.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

typestring nullable

The public agent type.

namestring nullable

The name shown to users.

descriptionstring nullable

A short explanation of what the agent does.

currentSystemPromptVersionIdstring uuid nullable

The current system prompt version.

modelProviderstring nullable

The configured model provider when no preset is selected.

modelNamestring nullable

The configured model name when no preset is selected.

presetKeystring nullable

The configured workspace model preset key.

reasoningLevelstring nullable

The configured reasoning level.

systemPromptstring nullable

The current system prompt.

webSearchEnabledboolean

Whether web search is enabled.

aworkAccessEnabledboolean

Whether awork access is enabled.

googleGenAiAccessEnabledboolean

Whether Google image generation is enabled.

openAiImageGenerationAccessEnabledboolean

Whether OpenAI image generation is enabled.

skillIdsstring[] nullable

The skills linked to the agent.

hasImageboolean

Whether the agent has a profile image.

isArchivedboolean

Whether the agent is archived.

workspaceAccessLevel'read' | 'manage'

The workspace-wide access level.

hasAdminAccessOnlyboolean

Whether the agent is visible only through workspace administration access.

accessLevel'read' | 'manage'

The requesting user's access level.

Changes