AWawork-io
customAgents

Creates a new custom agent.

Changed on

Creates a custom agent in the current workspace and returns its configuration and id. Provide a name and either PresetKey or both ModelProvider and ModelName. Do not combine these model selection options.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

post/agents

Request

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

Request body

namestring required

The name shown to users.

descriptionstring nullable

A short explanation of what the agent does.

modelProviderstring nullable

The provider that hosts the model.

modelNamestring nullable

The model to run.

presetKeystring nullable

The workspace model preset to use.

reasoningLevelstring nullable

The amount of reasoning the model uses.

systemPromptstring nullable

The instructions that control the agent's behavior.

webSearchEnabledboolean nullable

Whether web search is enabled.

aworkAccessEnabledboolean nullable

Whether the agent can use awork tools.

googleGenAiAccessEnabledboolean nullable

Whether the agent can generate images with Google models.

openAiImageGenerationAccessEnabledboolean nullable

Whether the agent can generate images with OpenAI models.

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