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

# Send Instruction

> Tell the agent something while the call is in progress, from your own system: new information ("the caller's order shipped today"), a change of direction ("offer the Thursday slot instead"), or something to say right away. With `speak: false` (default) the instruction shapes the agent's next reply. With `speak: true` the agent says it now, in its own words; if the agent is mid-sentence it says it as soon as it finishes. Instructions are recorded in the call transcript as `instruction` items.



## OpenAPI

````yaml POST /calls/{id}/instructions
openapi: 3.1.0
info:
  title: RevRing Voice AI API
  description: >-
    RevRing Voice AI platform API for managing AI voice agents, phone calls, SIP
    trunks, and analytics. Build intelligent voice applications that can handle
    inbound and outbound phone calls with AI-powered conversational agents.
  version: 1.0.0
  contact:
    name: RevRing Support
    url: https://revring.ai
servers:
  - url: https://api.revring.ai/v1
    description: Production API
security:
  - apiKeyAuth: []
tags:
  - name: Messaging Connections
    description: Connect messaging providers so agents can send text messages
  - name: Messages
    description: Send text messages and read your message log
  - name: Conversations
    description: List and clear managed conversation threads
  - name: SIP Trunks
    description: Manage SIP trunks for connecting agents to the phone network
  - name: Agents
    description: Manage AI voice agents and their configuration
  - name: Agent Folders
    description: Organize agents into folders for dashboard navigation
  - name: Calls
    description: Manage and query phone calls
  - name: Analytics
    description: Get analytics and metrics about your calls
  - name: Knowledge Bases
    description: >-
      Manage knowledge bases and sources for agent retrieval-augmented
      generation
  - name: Test Suites
    description: Manage test suites, test cases, and test runs for agent evaluation
  - name: Voices
    description: Browse the voices available to your organization for agent speech
  - name: Webhooks
    description: Webhook delivery settings for your organization
  - name: Alerts
    description: Alert rules on call metrics, delivered to a webhook or Slack
  - name: Contacts
    description: What your agents remember about people
  - name: Integrations
    description: Calendars your agents book on
paths:
  /calls/{id}/instructions:
    post:
      tags:
        - Calls
      summary: Send Instruction
      description: >-
        Tell the agent something while the call is in progress, from your own
        system: new information ("the caller's order shipped today"), a change
        of direction ("offer the Thursday slot instead"), or something to say
        right away. With `speak: false` (default) the instruction shapes the
        agent's next reply. With `speak: true` the agent says it now, in its own
        words; if the agent is mid-sentence it says it as soon as it finishes.
        Instructions are recorded in the call transcript as `instruction` items.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - instruction
              properties:
                instruction:
                  type: string
                  minLength: 1
                  maxLength: 2000
                  description: >-
                    What the agent should know or say, in plain language,
                    written for the agent
                  example: >-
                    The caller's refund was approved a minute ago. Let them know
                    it should arrive in 3 to 5 days.
                speak:
                  type: boolean
                  default: false
                  description: >-
                    true: the agent says it now. false: it shapes the next
                    reply.
      responses:
        '202':
          description: Delivered to the live call
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      callId:
                        type: string
                      delivered:
                        type: boolean
                      speak:
                        type: boolean
        '400':
          description: invalid_body
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
        '404':
          description: not_found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
        '409':
          description: >-
            call_not_active (the call is not in progress) or
            call_not_addressable (this call cannot receive instructions)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. Generate API keys from the RevRing
        dashboard.

````

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