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

# Read a workspace-agent conversation

> Requires the workspace-agent deployment, rollout and feature flag plus a current Tali/Aida access permission. Conversation resources require an active human participant in the same tenant; inaccessible resources are concealed. Includes active participants, active/latest run and up to sixteen open interrupts for the current participant. Returns ETag for conditional updates.



## OpenAPI

````yaml get /admin/workspace-agent/conversations/{conversation}
openapi: 3.0.0
info:
  title: Gratona API
  description: >-
    REST API for the Gratona fundraising platform, including donor, donation,
    sponsorship, program, event, and integration workflows. Endpoints are
    organized by tag. Most endpoints require either a Passport bearer token or
    an issued API key — see the Security Schemes section.
  contact:
    name: Gratona Engineering
    url: https://gratona.com
    email: devs@gratona.com
  version: 1.0.0
servers:
  - url: https://api.gratona.com/v1
    description: Server Version 1.0.0
security: []
tags:
  - name: Auth
    description: >-
      Login, signup, logout, password reset, and email verification for admin
      users and donors.
  - name: Donors
    description: >-
      Donor records: CRUD, profile fields, household linkage, search, filters,
      merge, and duplicate detection.
  - name: Donations
    description: >-
      Individual donation records, recurring commitments, soft credits, refunds,
      designations, and exports.
  - name: Sponsorships
    description: >-
      Donor-to-entity commitment relationships, lifecycle transitions, and
      commitment-specific filters.
  - name: Entities
    description: >-
      Recipient records (children, families, projects, animals, etc.), their
      status, and entity-level fields.
  - name: Programs
    description: >-
      Program / campaign configuration: hierarchy, settings, and program-level
      metadata.
  - name: Forms
    description: >-
      Custom form builder (HysForm), form fields, standardized donor fields, and
      field migrations.
  - name: Trips
    description: >-
      Mission-trip management: trips, participants, budgets, tasks,
      e-signatures, fundraising milestones, and background checks.
  - name: Communications
    description: >-
      Email templates, SMS, newsletters, donor email manager, and per-donor
      notes.
  - name: Payments
    description: >-
      Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks).
      Excludes inbound webhooks — see the Webhooks tag.
  - name: Reports
    description: Dashboards, analytics, scheduled reports, and exports.
  - name: Admin
    description: >-
      Client-account administration: users, groups/permissions, settings,
      integrations, and account lifecycle.
  - name: Donor Portal
    description: >-
      Endpoints consumed by the donor-facing portal (donor login, dashboard,
      donation history, messages).
  - name: Recipient Portal
    description: Endpoints consumed by the recipient-facing portal.
  - name: Public
    description: >-
      Unauthenticated public endpoints: donor signup, public trip pages,
      peer-to-peer campaigns, public checkout.
  - name: Webhooks
    description: >-
      Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr,
      DropboxSign). Annotated minimally for reference; payload shapes are owned
      by the upstream provider.
  - name: Events
    description: >-
      Event setup, invitations, registration, ticketing, attendance and event
      reporting.
  - name: Journeys
    description: >-
      Journey graphs, activation, enrollment, message templates and event
      follow-up automations.
  - name: Tasks
    description: Workspace tasks, assignments, saved task views and record collaboration.
  - name: Fundraising
    description: >-
      Fundraising portfolios, stewardship plans, giving anniversaries and
      personal donor follow-up.
  - name: Impact Stories
    description: Story intake, review, assets, consent and publication workflows.
  - name: Integrations
    description: Workspace integration connections, mappings, synchronization and recovery.
  - name: Email Calendar
    description: Connected email/calendar accounts and donor interactions.
  - name: Spaces
    description: Workspace Spaces and collaborative Pages.
  - name: Library
    description: Workspace documents, source connections, files and analysis.
  - name: Intelligence
    description: Donor intelligence and Tali workspace workflows.
  - name: Automation
    description: >-
      V3 automation primitive discovery, input validation, invocation and Zapier
      contracts.
  - name: Schema
    description: V3 model, enum, capability and scope discovery.
  - name: Zapier
    description: Zapier automation connections, polling feeds and actions.
  - name: Files
    description: Files
  - name: Client
    description: Client
  - name: Payment Gateways
    description: Payment Gateways
  - name: Email Settings
    description: Email Settings
  - name: Admin Dashboard
    description: Admin Dashboard
  - name: Recipients
    description: Recipients
  - name: Historical Archived Updates
    description: Historical Archived Updates
  - name: Team & access
    description: Team & access
  - name: Settings
    description: Settings
  - name: Notifications
    description: Notifications
  - name: Participation
    description: Participation
  - name: Users
    description: Users
  - name: Wrapped
    description: Wrapped
  - name: Donor SignUp
    description: Donor SignUp
  - name: Frontend
    description: Frontend
  - name: User
    description: User
  - name: Workspace
    description: Workspace
paths:
  /admin/workspace-agent/conversations/{conversation}:
    get:
      tags:
        - Intelligence
      summary: Read a workspace-agent conversation
      description: >-
        Requires the workspace-agent deployment, rollout and feature flag plus a
        current Tali/Aida access permission. Conversation resources require an
        active human participant in the same tenant; inaccessible resources are
        concealed. Includes active participants, active/latest run and up to
        sixteen open interrupts for the current participant. Returns ETag for
        conditional updates.
      operationId: docWorkspaceAgentConversationShowGET
      parameters:
        - name: conversation
          in: path
          description: Conversation.
          required: true
          schema:
            type: string
            format: uuid
          example: 018fd5a0-1331-7000-8000-000000000123
      responses:
        '200':
          description: Read a workspace-agent conversation response.
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      id:
                        type: string
                      title:
                        type: string
                        nullable: true
                      scope:
                        type: string
                      status:
                        type: string
                      revision:
                        type: integer
                      last_message_sequence:
                        type: integer
                      last_run_sequence:
                        type: integer
                      last_activity_at:
                        type: string
                        format: date-time
                        nullable: true
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      participants:
                        type: array
                        items:
                          properties:
                            id:
                              type: string
                            principal_type:
                              type: string
                            role:
                              type: string
                            status:
                              type: string
                            user_id:
                              type: integer
                              nullable: true
                            agent_id:
                              type: string
                              nullable: true
                            joined_at:
                              type: string
                              format: date-time
                          type: object
                      active_run:
                        oneOf:
                          - $ref: >-
                              #/components/schemas/IntelligenceConversationRunDoc
                          - type: string
                            enum:
                              - null
                            nullable: true
                      latest_run:
                        oneOf:
                          - $ref: >-
                              #/components/schemas/IntelligenceConversationRunDoc
                          - type: string
                            enum:
                              - null
                            nullable: true
                      open_interrupts:
                        type: array
                        items:
                          $ref: >-
                            #/components/schemas/IntelligenceConversationInterruptDoc
                    type: object
                type: object
        '401':
          description: Missing or invalid bearer token or API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '403':
          description: >-
            The caller lacks the required permission, resource access or feature
            availability.
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        description: >-
                          Protocol-specific details such as current_revision or
                          current_version.
                        type: object
                        additionalProperties: true
                    type: object
                type: object
        '404':
          description: >-
            The organization-owned resource or parent was not found or is not
            available for this operation.
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        description: >-
                          Protocol-specific details such as current_revision or
                          current_version.
                        type: object
                        additionalProperties: true
                    type: object
                type: object
        '503':
          description: >-
            The provider or background processing service is temporarily
            unavailable.
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        description: >-
                          Protocol-specific details such as current_revision or
                          current_version.
                        type: object
                        additionalProperties: true
                    type: object
                type: object
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    IntelligenceConversationRunDoc:
      properties:
        id:
          type: string
        conversation_id:
          type: string
        audience_id:
          type: string
          nullable: true
        audience_revision:
          type: integer
          nullable: true
        sequence:
          type: integer
        next_event_sequence:
          type: integer
        input_message_id:
          type: string
        ingress_receipt_id:
          type: string
          nullable: true
        initiating_channel_binding_id:
          type: string
          nullable: true
        initiating_channel_binding_generation:
          type: integer
          nullable: true
        agent_id:
          type: string
        agent_release_id:
          type: string
        root_run_id:
          type: string
        parent_run_id:
          type: string
          nullable: true
        status:
          type: string
        dispatch_state:
          type: string
        workflow_id:
          type: string
          nullable: true
        provider:
          type: string
          nullable: true
        model:
          type: string
          nullable: true
        terminal_outcome:
          type: string
          nullable: true
        workflow_version:
          type: string
          nullable: true
        workflow_build_id:
          type: string
          nullable: true
        execution_policy_sha256:
          type: string
          nullable: true
        provider_response_id:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        grounding:
          type: object
          nullable: true
          additionalProperties: true
        safety:
          type: object
          nullable: true
          additionalProperties: true
        usage:
          properties:
            latency_ms:
              type: integer
            input_tokens:
              type: integer
            cached_input_tokens:
              type: integer
            output_tokens:
              type: integer
            search_calls:
              type: integer
            estimated_cost_micros:
              type: integer
            reserved_cost_micros:
              type: integer
            accounted_cost_micros:
              type: integer
            provider_attempts:
              type: integer
            unknown_usage_attempts:
              type: integer
            fallback_count:
              type: integer
            model_breakdown:
              description: Accounting totals keyed by model identity.
              type: object
              additionalProperties: true
          type: object
      type: object
    IntelligenceConversationInterruptDoc:
      properties:
        id:
          type: string
        conversation_id:
          type: string
        run_id:
          type: string
        audience_id:
          type: string
          nullable: true
        audience_revision:
          type: integer
          nullable: true
        requesting_event_id:
          type: string
        kind:
          type: string
        status:
          type: string
        version:
          type: integer
        intended_participant_id:
          type: string
          nullable: true
        audience:
          type: string
        expires_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
        resolved_at:
          type: string
          format: date-time
          nullable: true
        cancelled_at:
          type: string
          format: date-time
          nullable: true
        expired_at:
          type: string
          format: date-time
          nullable: true
        resolution_event_id:
          type: string
          nullable: true
        request:
          type: object
          additionalProperties: true
        response_schema:
          description: JSON Schema defining the resolution body for this interrupt.
          type: object
          additionalProperties: true
        resolution:
          type: object
          nullable: true
          additionalProperties: true
      type: object
    UnauthorizedResponse:
      title: UnauthorizedResponse
      description: >-
        Returned with HTTP 401 when the request lacks a valid Passport bearer
        token, a valid `X-HYS-API-Key`, or a valid session. The body is the
        simple `{message, status}` envelope emitted by `AuthenticateApiOrKey`.
      required:
        - message
        - status
      properties:
        message:
          description: >-
            Always the literal string `Unauthorized` from the `auth.api_or_key`
            middleware. Login endpoints return `Invalid Credentials` instead.
          type: string
          example: Unauthorized
        status:
          type: string
          example: error
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      description: Passport bearer token authentication for legacy admin sessions.
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      description: Gratona API key sent with the compatibility header X-HYS-API-Key.
      name: X-HYS-API-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.