Agents

Create agent

Create a new custom AI agent.

Overview: Agents are specialized AI assistants configured for specific tasks. They can have custom system prompts, access to specific tools, and be limited to certain knowledge bases.

Agent Configuration:

  • System prompt: Instructions that define agent behavior
  • Tools: Capabilities like web search, code execution, etc.
  • Knowledge bases: Data sources the agent can access
  • Model config: AI model settings (temperature, max tokens)

Use Cases:

  • Customer support bot with product knowledge
  • Code review assistant with repository access
  • HR assistant with policy documents
post/agents/create

Request body

namestring required

Agent display name

descriptionstring

What the agent does

startMessagestring

Initial greeting shown when conversation starts

systemPromptstring

System instructions for the agent

instructionsstring

Additional agent execution instructions

tagsstring[]
shareWithOrgboolean

Share agent with the organization

isServiceAccountboolean

Create the agent as a service-account agent

defaultReasoningEffort'none' | 'low' | 'medium' | 'high' | 'max' nullable

Agent-level reasoning effort used when a chat request omits its own.

Example request

{
  "name": "Product Support Agent"
}

Response

Agent created

status'success' | 'partial_success' required
messagestring required

Changes

Changed in 3 of the 15 revisions of this API.29

    • the request property models became optional

      request-property-became-optional

    • the models request property default value was added

      request-property-default-value-added

    • added the required property agent/mcpServers to the response with the 201 status

      response-required-property-added

  • 5798f431973a26See the full diff
    • added the new confluencedatacenter enum value to the agent/toolsets/items/name response property for the response status 201

      response-property-enum-value-added

    • added the new jiradatacenter enum value to the agent/toolsets/items/name response property for the response status 201

      response-property-enum-value-added

    • added the new optional request property defaultReasoningEffort

      new-optional-request-property

    • added the new optional request property skills

      new-optional-request-property

    • added the new confluencedatacenter enum value to the request property toolsets/items/name

      request-property-enum-value-added

    • added the new jiradatacenter enum value to the request property toolsets/items/name

      request-property-enum-value-added

    • added the optional property agent/defaultReasoningEffort to the response with the 201 status

      response-optional-property-added

    • added the required property agent/skills to the response with the 201 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog