---
title: "Post Agent entities"
method: POST
path: "/api/v1/entities/agents"
tags: ["Agents"]
---

# Post Agent entities

`POST /api/v1/entities/agents`

## Request

- Base URL: `https://www.gooddata.ai`
- URL: `https://www.gooddata.ai/api/v1/entities/agents`
- Auth: none declared

AI Agent - behavior configuration for AI assistants

## Query parameters

- `include` string[]

## Request body

- JsonApiAgentInDocument
  - `data` JsonApiAgentIn, required: JSON:API representation of agent entity.
    - `attributes` object
      - `aiKnowledge` boolean
      - `availableToAll` boolean
      - `customSkills` string[], nullable
      - `description` string, nullable
      - `enabled` boolean
      - `instructions` object[], nullable: Rules this agent follows when answering.
        - `content` string, required: The rule the agent follows when answering
        - `isDisabled` boolean, nullable: Whether the instruction is disabled
        - `strategy` 'ALWAYS' | 'AUTO', required: When an instruction is applied to a request
        - `title` string, nullable: Short name shown in the agent builder.
      - `isPreview` boolean
      - `name` string, nullable
      - `personality` string, nullable
      - `skillsMode` 'all' | 'custom'
    - `id` string, required: API identifier of an object
    - `relationships` object
      - `userGroups` object
        - `data` JsonApiUserGroupLinkage[], required: References to other resource objects in a to-many (\"relationship\"). Relationships can be specified by including a member in a resource's links object.
          - `id` string, required
          - `type` 'userGroup', required
    - `type` 'agent', required: Object type

## Response `201`

Request successfully processed

- JsonApiAgentOutDocument
  - `data` JsonApiAgentOut, required: JSON:API representation of agent entity.
    - `attributes` object
      - `aiKnowledge` boolean
      - `availableToAll` boolean
      - `createdAt` string, date-time
      - `customSkills` string[], nullable
      - `description` string, nullable
      - `enabled` boolean
      - `instructions` object[], nullable: Rules this agent follows when answering.
        - `content` string, required: The rule the agent follows when answering
        - `isDisabled` boolean, nullable: Whether the instruction is disabled
        - `strategy` 'ALWAYS' | 'AUTO', required: When an instruction is applied to a request
        - `title` string, nullable: Short name shown in the agent builder.
      - `isPreview` boolean
      - `modifiedAt` string, date-time
      - `name` string, nullable
      - `personality` string, nullable
      - `skillsMode` 'all' | 'custom'
    - `id` string, required: API identifier of an object
    - `relationships` object
      - `createdBy` object
        - `data` JsonApiUserIdentifierToOneLinkage, required: The \"type\" and \"id\" to non-empty members.
          - `id` string, required
          - `type` 'userIdentifier', required
      - `modifiedBy` object
        - `data` JsonApiUserIdentifierToOneLinkage, required: The \"type\" and \"id\" to non-empty members.
          - `id` string, required
          - `type` 'userIdentifier', required
      - `userGroups` object
        - `data` JsonApiUserGroupLinkage[], required: References to other resource objects in a to-many (\"relationship\"). Relationships can be specified by including a member in a resource's links object.
          - `id` string, required
          - `type` 'userGroup', required
    - `type` 'agent', required: Object type
  - `included` JsonApiAgentOutIncludes[]: Included resources
    - union
      - JsonApiUserGroupOutWithLinks: JSON:API representation of userGroup entity.
        - `attributes` object
          - `name` string
        - `id` string, required: API identifier of an object
        - `relationships` object
          - `parents` object
            - `data` JsonApiUserGroupLinkage[], required: References to other resource objects in a to-many (\"relationship\"). Relationships can be specified by including a member in a resource's links object.
              - …
        - `type` 'userGroup', required: Object type
        - `links` ObjectLinks
          - `self` string, uri, required: A string containing the link's URL.
      - JsonApiUserIdentifierOutWithLinks: JSON:API representation of userIdentifier entity.
        - `attributes` object
          - `email` string
          - `firstname` string
          - `lastname` string
        - `id` string, required: API identifier of an object
        - `type` 'userIdentifier', required: Object type
        - `links` ObjectLinks
          - `self` string, uri, required: A string containing the link's URL.
  - `links` ObjectLinks
    - `self` string, uri, required: A string containing the link's URL.
  - `meta` object
    - `restricted` RestrictedObject[]: References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.
      - `id` string, required: Object identifier, unique within one workspace hierarchy.
      - `type` 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'computedAttribute' | 'fact' | 'label' | 'metric' | 'userDataFilter' | 'visualizationObject', required: JSON:API type of the restricted object. Matches the `type` of its entry in the resource's `relationships`.

---

[API](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/revisions/c728ef303bfb?raw)