> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Post Copilot Data Source Entity

> Creates a new CopilotDataSourceEntity

Calls the AI agent service SaveCopilotDataSourceEntity.
NsApiSlow threshold: 1000 ms.
<para />## Experimental: ## The AI agent is experimental, subject to change, and not intended for partners.



## OpenAPI

````yaml /openapi/rest/openapi-v3-CopilotDataSource.json post /api/v1/CopilotDataSource
openapi: 3.0.0
info:
  version: v1-REST
  title: SuperOffice REST API v1
  description: SuperOffice REST API - CopilotDataSource
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/CopilotDataSource:
    post:
      tags:
        - CopilotDataSource
      summary: Post Copilot Data Source Entity
      description: "Creates a new CopilotDataSourceEntity\n\nCalls the AI agent service SaveCopilotDataSourceEntity.\r\nNsApiSlow threshold: 1000 ms.\r\n<para />## Experimental: ## The AI agent is experimental, subject to change, and not intended for partners."
      operationId: v1CopilotDataSourceEntity_PostCopilotDataSourceEntity
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category" Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        $ref: >-
          #/components/requestBodies/SuperOffice.CRM.Services.CopilotDataSourceEntity
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.CopilotDataSourceEntityWithLinks
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.CopilotDataSourceEntityWithLinks
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.CopilotDataSourceEntityWithLinks
            text/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.CopilotDataSourceEntityWithLinks
            application/json-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.CopilotDataSourceEntityWithLinks
            application/merge-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.CopilotDataSourceEntityWithLinks
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  requestBodies:
    SuperOffice.CRM.Services.CopilotDataSourceEntity:
      content:
        application/json:
          schema:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.CopilotDataSourceEntity
        text/json:
          schema:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.CopilotDataSourceEntity
        application/xml:
          schema:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.CopilotDataSourceEntity
        text/xml:
          schema:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.CopilotDataSourceEntity
        application/x-www-form-urlencoded:
          schema:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.CopilotDataSourceEntity
        application/json-patch+json:
          schema:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.CopilotDataSourceEntity
        application/merge-patch+json:
          schema:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.CopilotDataSourceEntity
      description: The CopilotDataSourceEntity to be saved.
      required: true
  schemas:
    SuperOffice.WebApi.v1.Carriers.AICarriers.CopilotDataSourceEntityWithLinks:
      description: "Copilot data source - contains a list of settings for this source\r\n<para />\r\nCopilotDataSourceEntity entity with API _Links added."
      type: object
      properties:
        CopilotDataSourceId:
          format: int32
          description: Primary key
          type: integer
        CopilotDataSourceType:
          description: Type of copilot data source
          enum:
            - Requests
            - FAQs
            - ReplyTemplates
            - Documents
            - Products
            - WebContent
          type: string
        CopilotId:
          format: int32
          description: The associated copilot
          type: integer
        Description:
          description: Description of data source
          type: string
        Name:
          description: Name of data source
          type: string
        Settings:
          description: Collection of data source settings - each setting has key + value
          type: array
          items:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.CopilotDataSourceSetting
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
        _Links:
          type: object
          additionalProperties:
            type: string
    SuperOffice.CRM.Services.CopilotDataSourceEntity:
      description: "Copilot data source - contains a list of settings for this source\r\n<para />\r\nCarrier object for CopilotDataSourceEntity.\r\nServices for the CopilotDataSourceEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IAIAgent\">AI Agent</see>."
      type: object
      properties:
        CopilotDataSourceId:
          format: int32
          description: Primary key
          type: integer
        CopilotDataSourceType:
          description: Type of copilot data source
          enum:
            - Requests
            - FAQs
            - ReplyTemplates
            - Documents
            - Products
            - WebContent
          type: string
        CopilotId:
          format: int32
          description: The associated copilot
          type: integer
        Description:
          description: Description of data source
          type: string
        Name:
          description: Name of data source
          type: string
        Settings:
          description: Collection of data source settings - each setting has key + value
          type: array
          items:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.CopilotDataSourceSetting
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.CopilotDataSourceSetting:
      description: "Setting for a Copilot data source (key + value)\r\n<para />\r\nCarrier object for CopilotDataSourceSetting.\r\nServices for the CopilotDataSourceSetting Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IAIAgent\">AI Agent</see>."
      type: object
      properties:
        CopilotDataSourceSettingId:
          format: int32
          description: Primary key
          type: integer
        CopilotDataSourceId:
          format: int32
          description: The associated copilot data source
          type: integer
        Key:
          description: The key of data source setting
          type: string
        Value:
          description: The value of data source setting
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [Post Copilot Entity](/en/api/reference/restful/rest/copilot/post-copilot-entity.md)
- [Delete Copilot Data Source Entity](/en/api/reference/restful/agent/ai_agent/delete-copilot-data-source-entity.md)
- [Get Copilot Data Source Entity](/en/api/reference/restful/rest/copilotdatasource/get-copilot-data-source-entity.md)
- [Default Copilot Data Source Entity](/en/api/reference/restful/rest/copilotdatasource/default-copilot-data-source-entity.md)
- [Put Copilot Data Source Entity](/en/api/reference/restful/rest/copilotdatasource/put-copilot-data-source-entity.md)