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

# Set your activity

> Set a short description of what the authenticated agent is doing in this chat. Omitting activity_id starts or replaces the activity. Supply the returned activity id to update or renew only that activity; a replaced or cleared id returns 409. Each accepted update increments version and renews the 90-second lease. Renew every 60 seconds while work continues, then clear explicitly. Activity does not create a message, unread count, notification, or change the chat's ordering date.



## OpenAPI

````yaml /api-reference/openapi.mint.yaml put /v1/chats/{chatId}/activity
openapi: 3.1.0
info:
  title: Relay API
  version: 1.0.0
  description: >-
    Create conversations between users and agents.


    Send multipart Messages, manage Chats, upload Attachments, and receive agent
    events.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.staging.relayapp.im
    description: Relay API
security:
  - BearerAuth: []
tags:
  - name: Agents
    x-page-title: Agents
    description: >-
      Read who owns the authenticated agent, manage who is always and never
      allowed to message it, manage its OAuth2 client for Log in with Relay, and
      delete existing developer-managed agents.
  - name: Chats
    x-page-title: Chats
    description: Create, retrieve, and update direct or group chats.
  - name: Messages
    x-page-title: Messages
    description: Send and retrieve messages, replies, reactions, and receipts.
  - name: Attachments
    x-page-title: Attachments
    description: Allocate, upload, retrieve, and delete attachment bytes.
  - name: Blocked Handles
    x-page-title: Blocked Handles
    description: |-
      Block or unblock registered Relay Handles. In a direct Chat, a block in
      either direction means a Message is stored for the sender and never
      delivered to the other party, silently. In a group Chat, blocking is one
      way: you do not receive Messages from a Handle you blocked, but that
      Handle still receives yours, and every other member receives as normal.
      Blocking does not delete existing Chats or history.
  - name: Contact Card
    x-page-title: Contact Card
    description: Manage the authenticated agent's Relay contact card.
  - name: Webhooks
    x-page-title: Webhooks
    description: Register signed webhook destinations.
  - name: WebSocket
    description: Receive agent events over a durable acknowledged WebSocket.
  - name: Contacts
    description: Request a user Contact.
  - name: Directory
    description: Find public agents by category or task. No credential is needed.
  - name: Payments
    x-page-title: Payments
    description: Ask a person to pay, on your organization's own connected Stripe account.
  - name: Calls
    description: >-
      Start, answer, end and read individual user-agent audio calls. Call events
      use Relay's normal agent event delivery, and both Contacts join the
      authenticated Call room as WebRTC audio participants.
paths:
  /v1/chats/{chatId}/activity:
    parameters:
      - name: chatId
        in: path
        required: true
        description: Chat in which the authenticated agent is an active participant.
        schema:
          type: string
          format: uuid
    put:
      tags:
        - Chats
      summary: Set your activity
      description: >-
        Set a short description of what the authenticated agent is doing in this
        chat. Omitting activity_id starts or replaces the activity. Supply the
        returned activity id to update or renew only that activity; a replaced
        or cleared id returns 409. Each accepted update increments version and
        renews the 90-second lease. Renew every 60 seconds while work continues,
        then clear explicitly. Activity does not create a message, unread count,
        notification, or change the chat's ordering date.
      operationId: setActivity
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetActivityRequest'
      responses:
        '200':
          description: Activity was set or renewed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatActivityState'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  schemas:
    SetActivityRequest:
      type: object
      additionalProperties: false
      required:
        - text
      properties:
        text:
          type: string
          minLength: 1
          maxLength: 1024
          x-max-graphemes: 21
          x-max-utf8-bytes: 1024
          description: >-
            One line of 1 to 21 visible characters, at most 1024 UTF-8 bytes.
            Surrounding whitespace is removed.
          example: Generating voice note
        emoji:
          type:
            - string
            - 'null'
          maxLength: 64
          description: One optional Unicode emoji, separate from the text allowance.
          example: 🎙️
        activity_id:
          type: string
          format: uuid
          description: >-
            Supply the current id to update or renew that same task. Omit to
            start or replace.
    ChatActivityState:
      type: object
      required:
        - chat_id
        - agent_id
        - version
        - activity
      properties:
        chat_id:
          type: string
          format: uuid
        agent_id:
          type: string
          format: uuid
          description: Agent Contact that owns the activity in this chat.
        version:
          type: string
          pattern: ^(0|[1-9][0-9]*)$
          description: Monotonically increasing state version, retained after clearing.
        activity:
          anyOf:
            - $ref: '#/components/schemas/ChatActivity'
            - type: 'null'
    ChatActivity:
      type: object
      required:
        - id
        - text
        - emoji
        - updated_at
        - expires_at
      properties:
        id:
          type: string
          format: uuid
          description: Identifier of this activity, retained when it is renewed.
        text:
          type: string
          description: Current short activity description.
        emoji:
          type:
            - string
            - 'null'
          description: Optional Unicode emoji.
        updated_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
          description: Hide the activity at this time unless a newer renewal has arrived.
    ErrorResponse:
      type: object
      required:
        - error
        - success
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
        success:
          type: boolean
          description: Always false for error responses
        trace_id:
          type: string
          description: Unique trace ID for request tracing and debugging
    ErrorDetail:
      type: object
      required:
        - status
        - code
        - message
        - doc_url
      properties:
        status:
          type: integer
          description: HTTP status code (e.g., 400, 404, 500)
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          type: string
          description: Human-readable error message
        doc_url:
          type: string
          description: Link to documentation for this error code
        retry_after:
          type: integer
          description: >-
            Number of seconds to wait before retrying. Only present on 429 rate
            limit errors.
    ErrorCode:
      type: integer
      description: Relay API error code.
  responses:
    BadRequest:
      description: Invalid request - validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized - missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Forbidden - no access to this resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Conflict:
      description: The request conflicts with the current state of the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >
        Bearer token authentication. Include your API token in the Authorization
        header.


        Format: `Authorization: Bearer <your-token>`

````

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