ChatAgentResource

  • analysis_prompt
    Type: string
    required
  • analysis_schema
    Type: ResiaJsonObject
    required
    Properties: 1
  • created_at
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • id
    Type: string
    min length:  
    1
    max length:  
    512
    required
  • input_schema
    Type: ResiaJsonObject
    required
    Properties: 1
  • instructions
    Type: string
    required

    The instructions the agent follows for each chat. Use $name or ${name} to insert a top-level input property. Declare every placeholder in input_schema.properties. Supply every referenced value in the chat's inputs, even if the schema does not require it. Use $$ for a literal dollar sign. Nested property paths are not supported.

  • is_active
    Type: boolean
    required
  • name
    Type: string
    min length:  
    1
    required
  • review_status
    Type: CallAgentReviewStatusenum
    required
    values
    pending_reviewapproved
  • submitted_at
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • active_updated_at
    Type: stringFormat: date-timenullable

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • archived_at
    Type: stringFormat: date-timenullable

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • chat_ended_webhook_url
    Type: string
    min length:  
    1    Format: urinullable

    HTTPS URL Resia POSTs a chat.ended event to each time a chat this Chat Agent runs reaches a terminal status. The body is a JSON WebhookEvent: {"type": "chat.ended", "chat": ...}, where chat is the same ChatDetail that GET /v1/chats/{chat_id} returns. Resia makes one immediate attempt when the chat ends and retries a failed delivery on a fixed schedule; any 2xx response is success. The chat's id repeats unchanged across retries, so treat a repeated chat.id as a duplicate. Treat the complete URL as a credential: delivery authenticity is HTTPS plus URL secrecy. Null clears the webhook and stops pending deliveries.

  • description
    Type: string
    min length:  
    1
    max length:  
    280    nullable