> ## Documentation Index > Fetch the complete documentation index at: https://docs.ontora.com/llms.txt > Use this file to discover all available pages before exploring further. # Add Shareable Chat Recipients ## OpenAPI ````yaml /openapi.json post /v1/shareable-chats/{chat_id}/recipients openapi: 3.1.0 info: title: Ontora API description: >- Ontora's public API. Covers interview campaigns, transcripts, synthesis reports, graph queries, webhooks, and workspace management. **Authentication**: endpoints accept either a Clerk JWT (`Authorization: Bearer `) or a workspace API key (`X-API-Key: ont_...`). Workspace keys are managed via `/v1/api-keys`. version: 0.1.0 servers: [] security: - ClerkJWT: [] - WorkspaceApiKey: [] tags: - name: interviews description: Campaign CRUD, lifecycle, contacts, question sets. - name: agent-templates description: Curated use-case templates for creating opinionated interview campaigns. - name: campaign-insights description: Synthesis outputs — cartography, roadmap, personas, conversations. - name: interview-query description: Graph RAG query over campaign data. - name: campaign-reports description: Versioned synthesis Reports — manual regenerate, version history. - name: interview-export description: Markdown / ZIP exports of transcripts and reports. - name: api-keys description: Manage workspace-scoped API keys for programmatic access. - name: webhook-endpoints description: Outbound webhook endpoints for automation. - name: booking description: Public self-scheduling endpoints for interview participants. - name: join description: Public QR-code / share-link self-registration for campaign participants. - name: workspaces description: Workspace and membership management. - name: vaults description: Context vault management. paths: /v1/shareable-chats/{chat_id}/recipients: post: tags: - shareable-chats summary: Add Shareable Chat Recipients operationId: >- add_shareable_chat_recipients_v1_shareable_chats__chat_id__recipients_post parameters: - name: chat_id in: path required: true schema: type: string format: uuid title: Chat Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ShareableChatRecipientsAdd' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ShareableChatOut' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] components: schemas: ShareableChatRecipientsAdd: properties: recipients: items: $ref: '#/components/schemas/ShareableChatRecipientInput' type: array maxItems: 100 minItems: 1 title: Recipients type: object required: - recipients title: ShareableChatRecipientsAdd ShareableChatOut: properties: id: type: string format: uuid title: Id workspace_id: type: string format: uuid title: Workspace Id name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description status: type: string enum: - active - revoked title: Status enabled: type: boolean title: Enabled campaign_ids: items: type: string format: uuid type: array title: Campaign Ids campaigns: items: $ref: '#/components/schemas/ShareableChatCampaignOut' type: array title: Campaigns mcp_enabled: type: boolean title: Mcp Enabled delivery_channel: type: string enum: - email - slack - teams title: Delivery Channel recipients: items: $ref: '#/components/schemas/ShareableChatRecipientOut' type: array title: Recipients usage_summary: $ref: '#/components/schemas/ShareableChatUsageSummaryOut' created_by: type: string title: Created By created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At revoked_at: anyOf: - type: string format: date-time - type: 'null' title: Revoked At delivery_summary: anyOf: - $ref: '#/components/schemas/DeliverySummaryOut' - type: 'null' type: object required: - id - workspace_id - name - status - enabled - campaign_ids - campaigns - mcp_enabled - delivery_channel - recipients - usage_summary - created_by - created_at - updated_at title: ShareableChatOut HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ShareableChatRecipientInput: properties: email: anyOf: - type: string - type: 'null' title: Email person_id: anyOf: - type: string format: uuid - type: 'null' title: Person Id type: object title: ShareableChatRecipientInput ShareableChatCampaignOut: properties: id: type: string format: uuid title: Id name: type: string title: Name status: type: string title: Status type: object required: - id - name - status title: ShareableChatCampaignOut ShareableChatRecipientOut: properties: id: type: string format: uuid title: Id email: type: string title: Email person_id: anyOf: - type: string format: uuid - type: 'null' title: Person Id person_name: anyOf: - type: string - type: 'null' title: Person Name status: type: string enum: - invited - revoked title: Status session_id: type: string format: uuid title: Session Id message_count: type: integer title: Message Count invited_at: type: string format: date-time title: Invited At invitation_sent_at: anyOf: - type: string format: date-time - type: 'null' title: Invitation Sent At last_used_at: anyOf: - type: string format: date-time - type: 'null' title: Last Used At invite_url: anyOf: - type: string - type: 'null' title: Invite Url type: object required: - id - email - status - session_id - message_count - invited_at title: ShareableChatRecipientOut ShareableChatUsageSummaryOut: properties: session_count: type: integer title: Session Count default: 0 message_count: type: integer title: Message Count default: 0 unique_user_count: type: integer title: Unique User Count default: 0 last_used_at: anyOf: - type: string format: date-time - type: 'null' title: Last Used At last_used_by: anyOf: - $ref: '#/components/schemas/LastUsedByOut' - type: 'null' type: object title: ShareableChatUsageSummaryOut DeliverySummaryOut: properties: attempted: type: integer title: Attempted default: 0 sent: type: integer title: Sent default: 0 failed: items: $ref: '#/components/schemas/DeliveryFailureOut' type: array title: Failed type: object title: DeliverySummaryOut ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError LastUsedByOut: properties: name: anyOf: - type: string - type: 'null' title: Name email: type: string title: Email type: object required: - email title: LastUsedByOut DeliveryFailureOut: properties: recipient_id: type: string format: uuid title: Recipient Id email: type: string title: Email error: type: string title: Error type: object required: - recipient_id - email - error title: DeliveryFailureOut securitySchemes: ClerkJWT: type: http scheme: bearer bearerFormat: JWT description: Clerk-issued RS256 JWT. WorkspaceApiKey: type: apiKey in: header name: X-API-Key description: 'Workspace-scoped API key (prefix: `ont_`).' HTTPBearer: type: http scheme: bearer ````