> ## 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. # Get Summarize Sale Prompt > Return the prompt used to get a short summary of the activities on a sale. Does not call the chatbot for a response. Used for transfering a summary to a chat session. NsApiSlow threshold: 2000 ms. ## Experimental: ## The AI agent is experimental, subject to change, and not intended for partners. ## OpenAPI ````yaml /openapi/agent/openapi-v3-AIAgent.json post /api/v1/Agents/AI/GetSummarizeSalePrompt openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - AIAgent 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/Agents/AI/GetSummarizeSalePrompt: post: tags: - AI_Agent summary: Get Summarize Sale Prompt description: "Return the prompt used to get a short summary of the activities on a sale.\n\nDoes not call the chatbot for a response. Used for transfering a summary to a chat session.\r\nNsApiSlow threshold: 2000 ms.\r\n## Experimental: ## The AI agent is experimental, subject to change, and not intended for partners." operationId: v1AIAgent_GetSummarizeSalePrompt 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: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetSummarizeSalePromptRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetSummarizeSalePromptRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetSummarizeSalePromptRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetSummarizeSalePromptRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetSummarizeSalePromptRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetSummarizeSalePromptRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetSummarizeSalePromptRequest description: SaleId, NumSentences, Summary, IsoLangCode required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatbotTurn' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatbotTurn' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatbotTurn' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatbotTurn' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatbotTurn' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatbotTurn' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.AICarriers.GetSummarizeSalePromptRequest: description: >- GetSummarizeSalePrompt: Return the prompt used to get a short summary of the activities on a sale. Does not call the chatbot for a response. Used for transfering a summary to a chat session. type: object properties: SaleId: format: int32 type: integer NumSentences: format: int32 type: integer Summary: type: string IsoLangCode: type: string SuperOffice.CRM.Services.ChatbotTurn: description: "Chat turn contains one user question, an optional display value for the user prompt, and one chatbot response.\r\n\r\nCarrier object for ChatbotTurn.\r\nServices for the ChatbotTurn Carrier is available from the AI Agent." type: object properties: Timestamp: format: date-time description: UTC timestamp for turn - when response was generated. type: string UserPrompt: description: Text from the user type: string UserDisplayText: description: Optional display value to use instead of the the UserPrompt type: string BotResponse: description: Text from the chatbot type: string BotActions: description: >- optional dictionary of action buttons. Key = Display text, Value = Prompt text type: object additionalProperties: type: string Attachments: description: optional array of attachments - can be URL or Base64 encoded data type: array items: type: string ```` ## Related topics - [SuperOffice.WebApi.Data.AI GetSummarizeSalePromptRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.AI_GetSummarizeSalePromptRequest.md) - [SuperOffice.WebApi.Agents.AIAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.AIAgent.md) - [SuperOffice.WebApi.Agents.IAIAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IAIAgent.md) - [Get Summarize Contact Prompt](/en/api/reference/restful/agent/ai_agent/get-summarize-contact-prompt.md) - [Get Summarize Ticket Prompt](/en/api/reference/restful/agent/ai_agent/get-summarize-ticket-prompt.md) - [SuperOffice.WebApi.Data.AI GetSummarizeContactPromptRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.AI_GetSummarizeContactPromptRequest.md)