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

# Hydrate Agent Conversation



## OpenAPI

````yaml /api-reference/openapi.json get /agent/conversations/{conversation_id}
openapi: 3.1.0
info:
  title: Aspect Platform API
  description: A FastAPI application for Aspect Platform functionality
  version: 0.0.0
servers:
  - url: https://api.aspect.inc
security:
  - BearerAuth: []
  - ApiKeyAuth: []
paths:
  /agent/conversations/{conversation_id}:
    get:
      tags:
        - Agent
      summary: Hydrate Agent Conversation
      operationId: get_Agent_agent_conversations_conversation_id
      parameters:
        - name: conversation_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Conversation Id
            description: Conversation ID
          description: Conversation ID
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentConversationHydrationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AgentConversationHydrationResponse:
      properties:
        conversation:
          $ref: '#/components/schemas/AgentConversationResponse'
          description: Conversation metadata
        messages:
          items:
            $ref: '#/components/schemas/AgentMessageResponse'
          type: array
          title: Messages
          description: Transcript messages
        runs:
          items:
            $ref: '#/components/schemas/AgentRunResponse'
          type: array
          title: Runs
          description: Runs in the conversation
        tool_calls:
          items:
            $ref: '#/components/schemas/AgentToolCallResponse'
          type: array
          title: Tool Calls
          description: Tool calls in the conversation
      type: object
      required:
        - conversation
        - messages
        - runs
        - tool_calls
      title: AgentConversationHydrationResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AgentConversationResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Conversation ID
        workspace_id:
          type: string
          format: uuid
          title: Workspace Id
          description: Workspace that scopes the conversation
        project_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Project Id
          description: Project that scopes the conversation
        share_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Share Id
          description: Share link that scopes the conversation
        user_id:
          type: string
          format: uuid
          title: User Id
          description: User that owns the conversation
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
          description: Conversation title
        status:
          $ref: '#/components/schemas/AgentConversationStatus'
          description: Conversation status
        has_active_run:
          type: boolean
          title: Has Active Run
          description: Whether the conversation has a non-terminal agent run
          default: false
        last_activity_at:
          type: string
          format: date-time
          title: Last Activity At
          description: Last timestamp for activity inside the conversation
        created:
          type: string
          format: date-time
          title: Created
          description: Creation timestamp
        updated:
          type: string
          format: date-time
          title: Updated
          description: Last update timestamp
      type: object
      required:
        - id
        - workspace_id
        - user_id
        - status
        - last_activity_at
        - created
        - updated
      title: AgentConversationResponse
    AgentMessageResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Message ID
        conversation_id:
          type: string
          format: uuid
          title: Conversation Id
          description: Conversation ID
        run_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Run Id
          description: Run that produced or consumed the message
        actor_user_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Actor User Id
          description: User that authored the message
        role:
          $ref: '#/components/schemas/AgentMessageRole'
          description: Transcript role
        content:
          type: string
          title: Content
          description: Message text content
        content_parts:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Content Parts
          description: Structured message content
        mentions:
          items:
            $ref: '#/components/schemas/AgentMention'
          type: array
          title: Mentions
          description: Structured mentions included in the message
        page_context:
          anyOf:
            - $ref: '#/components/schemas/AgentPageContext'
            - type: 'null'
          description: Page context snapshot attached to the turn
        provider_message_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Provider Message Id
          description: Runtime provider message ID
        created:
          type: string
          format: date-time
          title: Created
          description: Creation timestamp
        updated:
          type: string
          format: date-time
          title: Updated
          description: Last update timestamp
      type: object
      required:
        - id
        - conversation_id
        - role
        - content
        - content_parts
        - mentions
        - created
        - updated
      title: AgentMessageResponse
    AgentRunResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Run ID
        conversation_id:
          type: string
          format: uuid
          title: Conversation Id
          description: Conversation ID
        user_message_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: User Message Id
          description: User message that started the run
        created_by_user_id:
          type: string
          format: uuid
          title: Created By User Id
          description: User that started the run
        status:
          $ref: '#/components/schemas/AgentRunStatus'
          description: Run status
        model:
          anyOf:
            - type: string
            - type: 'null'
          title: Model
          description: Model selected for the run
        provider_run_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Provider Run Id
          description: Runtime provider run ID
        error:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Error
          description: Structured error data
        cancel_requested_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Cancel Requested At
          description: Cancellation request timestamp
        cancelled_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Cancelled At
          description: Cancellation completion timestamp
        completed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Completed At
          description: Completion timestamp
        created:
          type: string
          format: date-time
          title: Created
          description: Creation timestamp
        updated:
          type: string
          format: date-time
          title: Updated
          description: Last update timestamp
      type: object
      required:
        - id
        - conversation_id
        - created_by_user_id
        - status
        - created
        - updated
      title: AgentRunResponse
    AgentToolCallResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Tool call ID
        conversation_id:
          type: string
          format: uuid
          title: Conversation Id
          description: Conversation ID
        run_id:
          type: string
          format: uuid
          title: Run Id
          description: Run ID
        provider_tool_call_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Provider Tool Call Id
          description: Runtime provider tool call ID
        tool_name:
          type: string
          title: Tool Name
          description: Tool name
        arguments:
          additionalProperties: true
          type: object
          title: Arguments
          description: Tool arguments
        result:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Result
          description: Tool result
        status:
          $ref: '#/components/schemas/AgentToolCallStatus'
          description: Tool call status
        approval_status:
          $ref: '#/components/schemas/AgentToolApprovalStatus'
          description: Approval status
        approval_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Approval Id
          description: Approval ID
        approved_by_user_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Approved By User Id
          description: User that approved or rejected
        approved_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Approved At
          description: Approval decision timestamp
        ui_metadata:
          additionalProperties: true
          type: object
          title: Ui Metadata
          description: Renderer metadata
        started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
          description: Tool start timestamp
        completed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Completed At
          description: Tool completion timestamp
        created:
          type: string
          format: date-time
          title: Created
          description: Creation timestamp
        updated:
          type: string
          format: date-time
          title: Updated
          description: Last update timestamp
      type: object
      required:
        - id
        - conversation_id
        - run_id
        - tool_name
        - arguments
        - status
        - approval_status
        - ui_metadata
        - created
        - updated
      title: AgentToolCallResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    AgentConversationStatus:
      type: string
      enum:
        - active
        - archived
      title: AgentConversationStatus
    AgentMessageRole:
      type: string
      enum:
        - user
        - assistant
        - system
        - tool
      title: AgentMessageRole
    AgentMention:
      properties:
        reference_type:
          $ref: '#/components/schemas/AgentMentionReferenceType'
          description: Mentioned reference type
        reference_id:
          type: string
          format: uuid
          title: Reference Id
          description: Mentioned reference ID
        display_label:
          type: string
          title: Display Label
          description: Label shown to the user for the mention
        workspace_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Workspace Id
          description: Workspace scope for the mention
        project_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Project Id
          description: Project scope for the mention
        resolution_status:
          $ref: '#/components/schemas/AgentMentionResolutionStatus'
          description: Resolution state for the mention
          default: unresolved
        start_index:
          anyOf:
            - type: integer
            - type: 'null'
          title: Start Index
          description: Start index of this mention in the message text
        end_index:
          anyOf:
            - type: integer
            - type: 'null'
          title: End Index
          description: End index of this mention in the message text
      type: object
      required:
        - reference_type
        - reference_id
        - display_label
      title: AgentMention
    AgentPageContext:
      properties:
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
          description: Current client URL
        workspace_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Workspace Id
          description: Workspace visible in the current UI
        project_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Project Id
          description: Project visible in the current UI
        current_resource:
          anyOf:
            - $ref: '#/components/schemas/AgentContextResource'
            - type: 'null'
          description: Primary resource visible in the current UI
        selection:
          anyOf:
            - $ref: '#/components/schemas/AgentSelectionContext'
            - type: 'null'
          description: Selection state at send time
        view:
          anyOf:
            - $ref: '#/components/schemas/AgentViewContext'
            - type: 'null'
          description: View state at send time
        intent:
          anyOf:
            - $ref: '#/components/schemas/AgentUserIntentContext'
            - type: 'null'
          description: User intent hints at send time
      type: object
      title: AgentPageContext
    AgentRunStatus:
      type: string
      enum:
        - pending
        - running
        - requires_approval
        - paused
        - completed
        - failed
        - cancel_requested
        - cancelled
      title: AgentRunStatus
    AgentToolCallStatus:
      type: string
      enum:
        - pending
        - running
        - requires_approval
        - completed
        - failed
        - cancelled
      title: AgentToolCallStatus
    AgentToolApprovalStatus:
      type: string
      enum:
        - not_required
        - pending
        - approved
        - rejected
      title: AgentToolApprovalStatus
    AgentMentionReferenceType:
      type: string
      enum:
        - workspace
        - project
        - collection
        - directory
        - asset
        - entity
        - share_link
      title: AgentMentionReferenceType
    AgentMentionResolutionStatus:
      type: string
      enum:
        - unresolved
        - resolved
        - stale
        - unauthorized
        - type_mismatch
      title: AgentMentionResolutionStatus
    AgentContextResource:
      properties:
        resource_type:
          $ref: '#/components/schemas/AgentMentionReferenceType'
          description: Current resource type
        resource_id:
          type: string
          format: uuid
          title: Resource Id
          description: Current resource ID
      type: object
      required:
        - resource_type
        - resource_id
      title: AgentContextResource
    AgentSelectionContext:
      properties:
        asset_ids:
          items:
            type: string
            format: uuid
          type: array
          title: Asset Ids
          description: Selected asset IDs
        directory_ids:
          items:
            type: string
            format: uuid
          type: array
          title: Directory Ids
          description: Selected directory IDs
        collection_ids:
          items:
            type: string
            format: uuid
          type: array
          title: Collection Ids
          description: Selected collection IDs
        entity_ids:
          items:
            type: string
            format: uuid
          type: array
          title: Entity Ids
          description: Selected entity IDs
        timeline_ranges:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Timeline Ranges
          description: Selected timeline ranges
      type: object
      title: AgentSelectionContext
    AgentViewContext:
      properties:
        filters:
          additionalProperties: true
          type: object
          title: Filters
          description: Active filter state
        sort:
          additionalProperties: true
          type: object
          title: Sort
          description: Active sort state
        display_settings:
          additionalProperties: true
          type: object
          title: Display Settings
          description: Active display settings state
        search_query:
          anyOf:
            - type: string
            - type: 'null'
          title: Search Query
          description: Active search query
        active_tab:
          anyOf:
            - type: string
            - type: 'null'
          title: Active Tab
          description: Active tab or panel
        pagination:
          additionalProperties: true
          type: object
          title: Pagination
          description: Pagination or windowing state
      type: object
      title: AgentViewContext
    AgentUserIntentContext:
      properties:
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: UI entry point that opened the composer
        selected_text:
          anyOf:
            - type: string
            - type: 'null'
          title: Selected Text
          description: Text selected by the user
        action_label:
          anyOf:
            - type: string
            - type: 'null'
          title: Action Label
          description: User-facing action label that initiated the turn
        resource_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Resource Id
          description: Resource associated with the initiating action
      type: object
      title: AgentUserIntentContext
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT in Authorization header. 'Bearer ' prefix optional.
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Aspect API key (sk_...) in Authorization header. 'Bearer ' optional.

````