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

# Turn off a share link

> Turns the link off for good and ends any call running through it. Anyone who opens it after this is told it has been turned off. Turning off a link twice changes nothing.



## OpenAPI

````yaml /api-reference/openapi.json delete /agent/{agent_id}/share-link/{link_id}
openapi: 3.0.0
info:
  contact: {}
  description: >-
    Public REST API for Brilo. Authenticate by sending your API key as a Bearer
    token in the `Authorization` header.
  title: Brilo API
  version: '2025-03-02'
servers:
  - description: Production
    url: https://api.brilo.ai/v1
security: []
tags: []
paths:
  /agent/{agent_id}/share-link/{link_id}:
    delete:
      tags:
        - Share Links
      summary: Turn off a share link
      description: >-
        Turns the link off for good and ends any call running through it. Anyone
        who opens it after this is told it has been turned off. Turning off a
        link twice changes nothing.
      operationId: AgentShareLinkController_revoke
      parameters:
        - description: The agent the link opens a call with.
          in: path
          name: agent_id
          required: true
          schema:
            type: string
        - description: The id of the link.
          in: path
          name: link_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevokeShareLinkResponseDto'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponseDto'
          description: >-
            share_links_not_enabled: share links are not turned on for this
            workspace yet.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponseDto'
          description: >-
            agent_not_found: no agent with this ID in your workspace.
            share_link_not_found: no link with this ID on this agent.
      security:
        - bearerAuth: []
components:
  schemas:
    RevokeShareLinkResponseDto:
      properties:
        id:
          example: 6d1f2a3b-4c5d-4e6f-8a9b-0c1d2e3f4a5b
          type: string
        revoked:
          description: Always true.
          example: true
          type: boolean
      required:
        - id
        - revoked
      type: object
    ApiErrorResponseDto:
      properties:
        details:
          description: Structured extras, such as the field and allowed conditions.
          example:
            allowed:
              - is
              - gt
            field: age
            op: has
          type: object
        error_code:
          description: Stable machine-readable code. Branch on this, not on `message`.
          example: validation_failed
          type: string
        message:
          description: What went wrong, in plain words, and how to fix it.
          example: >-
            Filter 1: "Age" is a number field, so the condition must be one of:
            is, gt, gte, lt, lte, between, empty, not_empty.
          type: string
        status:
          description: HTTP status code.
          example: 400
          type: number
      required:
        - status
        - error_code
        - message
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: Enter your API key (Bearer token)
      scheme: bearer
      type: http

````

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