Path parameters

• id string Required

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • account_sid string Required

    The SID of the Account that created the Assistant resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

  • customer_ai object Required

    The Personalization and Perception Engine settings.

  • id string Required

    The Assistant ID.

    Format should match the following pattern: ^aia_asst_.+$.

  • model string Required

    The default model used by the assistant.

  • name string Required

    The name of the assistant.

  • owner string Required

    The owner/company of the assistant.

  • url string

    The url of the assistant resource.

  • personality_prompt string Required

    The personality prompt to be used for assistant.

  • date_created string(date-time) Required

    The date and time in GMT when the Assistant was created specified in ISO 8601 format.

  • date_updated string(date-time) Required

    The date and time in GMT when the Assistant was last updated specified in ISO 8601 format.

  • knowledge array[object] Required

    The list of knowledge sources associated with the assistant.

    Hide knowledge attributes Show knowledge attributes object

    • description string

      The type of knowledge source.

    • id string Required

      The description of knowledge.

      Format should match the following pattern: ^aia_know_.+$.

    • account_sid string

      The SID of the Account that created the Knowledge resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • knowledge_source_details object

      The details of the knowledge source based on the type.

    • name string Required

      The name of the knowledge source.

    • status string

      The status of processing the knowledge source ('QUEUED', 'PROCESSING', 'COMPLETED', 'FAILED')

    • type string Required

      The type of knowledge source ('Web', 'Database', 'Text', 'File')

    • url string

      The url of the knowledge resource.

    • embedding_model string

      The embedding model to be used for the knowledge source.

    • date_created string(date-time) Required

      The date and time in GMT when the Knowledge was created specified in ISO 8601 format.

    • date_updated string(date-time) Required

      The date and time in GMT when the Knowledge was last updated specified in ISO 8601 format.

  • tools array[object] Required

    The list of tools associated with the assistant.

    Hide tools attributes Show tools attributes object

    • account_sid string

      The SID of the Account that created the Tool resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • description string Required

      The description of the tool.

    • enabled boolean Required

      True if the tool is enabled.

    • id string Required

      The tool ID.

      Format should match the following pattern: ^aia_tool_.+$.

    • meta object Required

      The metadata related to method, url, input_schema to used with the Tool.

    • name string Required

      The name of the tool.

    • requires_auth boolean Required

      The authentication requirement for the tool.

    • type string Required

      The type of the tool. ('WEBHOOK')

    • url string

      The url of the tool resource.

    • date_created string(date-time) Required

      The date and time in GMT when the Tool was created specified in ISO 8601 format.

    • date_updated string(date-time) Required

      The date and time in GMT when the Tool was last updated specified in ISO 8601 format.