AWawork-io
agentRuntime

Gets the default agent options for a personal or custom agent.

Changed on

Returns default model, tool access, connector, and skill options for a personal-agent or custom-agent conversation. Set type to 'personal-agent' for the requesting user's defaults, or 'custom-agent' and provide agentId for a custom agent. The response also includes the effective model catalog for the workspace. <Check title="Required Permissions" icon="key">The user must have read access to the selected custom agent.</Check>

get/agents/defaults

Request

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

Query parameters

typestring required

The agent type to resolve defaults for ('personal-agent' or 'custom-agent').

agentIdstring uuid

The id of the custom agent when is 'custom-agent'.

Response

OK

typestring nullable

The matching agent thread type.

modelProviderstring nullable

The default model provider.

modelNamestring nullable

The default model name.

presetKeystring nullable

The stored preset identity for preset-based agents.

reasoningLevelstring nullable

The default reasoning level.

connectorIdsstring[] nullable

The default connector ids.

skillIdsstring[] nullable

The default skill ids.

Changes

  • eadefd26df12Revision changes
    • info

      added the optional property / to the response with the status

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API