AWawork-io
customAgents

Returns the custom agent's configuration.

Changed on

Returns the agent's shared settings, including the requesting user's access level. Use this response to inspect the agent's model, prompt, and linked capabilities. Read GET /agents/{agentId}/configuration for the current user's selected accounts and connection status. <Check title="Required Permissions" icon="key">The user must have read access to the agent.</Check>

get/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.

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

  • 84f37b3c4cbcRevision changes
    • info

      added the optional property to the response with the status

  • 5332322ffca3Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status