Balladic

Balladic Chat API

The chat API from Balladic — 10 operation(s) for chat.

GitHub OpenAPI

Operations 11

GET /chat/conversations List Conversations #
POST /chat/conversations/dm Get Or Create Dm #
GET /chat/conversations/project/{project_id} Get Or Create Project Room #
POST /chat/conversations/{conversation_id}/read Mark Read #
GET /chat/conversations/{conversation_id}/messages List Messages #
POST /chat/conversations/{conversation_id}/messages Send Message #
GET /chat/conversations/{conversation_id}/messages/by-number/{number} Get Chat Message By Number #
DELETE /chat/conversations/{conversation_id}/messages/{message_id} Delete Message #
POST /chat/conversations/{conversation_id}/presign Presign Chat Attachment #
GET /chat/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id} Download Chat Attachment #
GET /chat/events Stream Chat Events #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/balladic-com/openapi/balladic-com-chat-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/balladic-com/json-schema/balladic-com-project-list-item-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/balladic-com/json-schema/balladic-com-project-detail-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/balladic-com/json-schema/balladic-com-org-billing-status-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/balladic-com/json-schema/balladic-com-task-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/balladic-com/json-schema/balladic-com-notification-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/balladic-com/json-schema/balladic-com-user-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/balladic-com:balladic-com-chat-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

balladic-com-chat-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Balladic Chat API
  description: Balladestreger
  version: 0.11.10
tags:
- name: Chat
paths:
  /chat/conversations:
    get:
      tags:
      - Chat
      summary: List Conversations
      operationId: list_conversations_chat_conversations_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversationListResponse'
      security:
      - HTTPBearer: []
  /chat/conversations/dm:
    post:
      tags:
      - Chat
      summary: Get Or Create Dm
      operationId: get_or_create_dm_chat_conversations_dm_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDmRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /chat/conversations/project/{project_id}:
    get:
      tags:
      - Chat
      summary: Get Or Create Project Room
      operationId: get_or_create_project_room_chat_conversations_project__project_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Project Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /chat/conversations/{conversation_id}/read:
    post:
      tags:
      - Chat
      summary: Mark Read
      operationId: mark_read_chat_conversations__conversation_id__read_post
      security:
      - HTTPBearer: []
      parameters:
      - name: conversation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Conversation Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /chat/conversations/{conversation_id}/messages:
    get:
      tags:
      - Chat
      summary: List Messages
      operationId: list_messages_chat_conversations__conversation_id__messages_get
      security:
      - HTTPBearer: []
      parameters:
      - name: conversation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Conversation Id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 50
          minimum: 1
          default: 30
          title: Limit
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedChatMessagesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Chat
      summary: Send Message
      operationId: send_message_chat_conversations__conversation_id__messages_post
      security:
      - HTTPBearer: []
      parameters:
      - name: conversation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Conversation Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateChatMessageRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatMessageResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /chat/conversations/{conversation_id}/messages/by-number/{number}:
    get:
      tags:
      - Chat
      summary: Get Chat Message By Number
      operationId: get_chat_message_by_number_chat_conversations__conversation_id__messages_by_number__number__get
      security:
      - HTTPBearer: []
      parameters:
      - name: conversation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Conversation Id
      - name: number
        in: path
        required: true
        schema:
          type: integer
          title: Number
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatMessageResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /chat/conversations/{conversation_id}/messages/{message_id}:
    delete:
      tags:
      - Chat
      summary: Delete Message
      operationId: delete_message_chat_conversations__conversation_id__messages__message_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: conversation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Conversation Id
      - name: message_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Message Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /chat/conversations/{conversation_id}/presign:
    post:
      tags:
      - Chat
      summary: Presign Chat Attachment
      operationId: presign_chat_attachment_chat_conversations__conversation_id__presign_post
      security:
      - HTTPBearer: []
      parameters:
      - name: conversation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Conversation Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PresignAttachmentRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PresignAttachmentResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /chat/conversations/{conversation_id}/messages/{message_id}/attachments/{attachment_id}:
    get:
      tags:
      - Chat
      summary: Download Chat Attachment
      operationId: download_chat_attachment_chat_conversations__conversation_id__messages__message_id__attachments__attachment_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: conversation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Conversation Id
      - name: message_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Message Id
      - name: attachment_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Attachment Id
      - name: url_only
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Url Only
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /chat/events:
    get:
      tags:
      - Chat
      summary: Stream Chat Events
      operationId: stream_chat_events_chat_events_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    AttachmentMeta:
      properties:
        s3_key:
          type: string
          maxLength: 512
          minLength: 1
          title: S3 Key
        filename:
          type: string
          maxLength: 255
          minLength: 1
          title: Filename
        content_type:
          type: string
          maxLength: 127
          minLength: 1
          title: Content Type
        size_bytes:
          type: integer
          maximum: 52428800.0
          exclusiveMinimum: 0.0
          title: Size Bytes
      type: object
      required:
      - s3_key
      - filename
      - content_type
      - size_bytes
      title: AttachmentMeta
    ChatAttachmentResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        number:
          type: integer
          title: Number
        filename:
          type: string
          title: Filename
        content_type:
          type: string
          title: Content Type
        size_bytes:
          type: integer
          title: Size Bytes
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
      - id
      - number
      - filename
      - content_type
      - size_bytes
      - created_at
      title: ChatAttachmentResponse
    ChatMessageResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        number:
          type: integer
          title: Number
        conversation_id:
          type: string
          format: uuid
          title: Conversation Id
        user_id:
          type: string
          format: uuid
          title: User Id
        user_name:
          type: string
          title: User Name
        user_avatar_key:
          anyOf:
          - type: string
          - type: 'null'
          title: User Avatar Key
        body:
          additionalProperties: true
          type: object
          title: Body
        reply_to_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Reply To Id
        created_at:
          type: string
          format: date-time
          title: Created At
        attachments:
          items:
            $ref: '#/components/schemas/ChatAttachmentResponse'
          type: array
          title: Attachments
      type: object
      required:
      - id
      - number
      - conversation_id
      - user_id
      - user_name
      - user_avatar_key
      - body
      - reply_to_id
      - created_at
      - attachments
      title: ChatMessageResponse
    CreateChatMessageRequest:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/AttachmentMeta'
          type: array
          maxItems: 10
          title: Attachments
          default: []
        body:
          additionalProperties: true
          type: object
          title: Body
        reply_to_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Reply To Id
      type: object
      required:
      - body
      title: CreateChatMessageRequest
    ConversationListResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ConversationResponse'
          type: array
          title: Items
      type: object
      required:
      - items
      title: ConversationListResponse
    ParticipantSummary:
      properties:
        user_id:
          type: string
          format: uuid
          title: User Id
        name:
          type: string
          title: Name
        avatar_key:
          anyOf:
          - type: string
          - type: 'null'
          title: Avatar Key
      type: object
      required:
      - user_id
      - name
      - avatar_key
      title: ParticipantSummary
    ConversationType:
      type: string
      enum:
      - dm
      - project_room
      title: ConversationType
    PresignAttachmentResponse:
      properties:
        upload_url:
          type: string
          title: Upload Url
        s3_key:
          type: string
          title: S3 Key
      type: object
      required:
      - upload_url
      - s3_key
      title: PresignAttachmentResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CreateDmRequest:
      properties:
        user_id:
          type: string
          format: uuid
          title: User Id
      type: object
      required:
      - user_id
      title: CreateDmRequest
    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
    ConversationResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        type:
          $ref: '#/components/schemas/ConversationType'
        project_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Project Id
        project_title:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Title
        project_color:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Color
        project_slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Slug
        participants:
          items:
            $ref: '#/components/schemas/ParticipantSummary'
          type: array
          title: Participants
        last_message:
          anyOf:
          - $ref: '#/components/schemas/ChatMessageResponse'
          - type: 'null'
        unread_count:
          type: integer
          title: Unread Count
          default: 0
      type: object
      required:
      - id
      - type
      - project_id
      - participants
      title: ConversationResponse
    PaginatedChatMessagesResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ChatMessageResponse'
          type: array
          title: Items
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      type: object
      required:
      - items
      - next_cursor
      title: PaginatedChatMessagesResponse
    PresignAttachmentRequest:
      properties:
        filename:
          type: string
          maxLength: 255
          minLength: 1
          title: Filename
        content_type:
          type: string
          maxLength: 127
          minLength: 1
          title: Content Type
        size_bytes:
          type: integer
          maximum: 52428800.0
          exclusiveMinimum: 0.0
          title: Size Bytes
      type: object
      required:
      - filename
      - content_type
      - size_bytes
      title: PresignAttachmentRequest
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer