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

# Upload company attachment

> Upload additional documents/attachments to a company
(financials, legal docs, etc.).




## OpenAPI

````yaml openapi.json post /companies/{id}/attachments
openapi: 3.1.0
info:
  title: Roulette API
  version: 1.0.0
  description: >
    The Roulette API provides programmatic access to manage your VC deal flow,

    companies, contacts, and related data.


    ## Authentication


    All API requests require authentication using a Bearer token. Include your
    API key

    in the `Authorization` header:


    ```

    Authorization: Bearer YOUR_API_KEY

    ```


    You can generate API keys from your account settings in the Roulette
    dashboard.


    ## Rate Limiting


    API requests are rate limited to ensure fair usage. Current limits:

    - 1000 requests per minute per API key

    - 100 requests per second per API key


    Rate limit headers are included in all responses:

    - `X-RateLimit-Limit`: Maximum requests per window

    - `X-RateLimit-Remaining`: Requests remaining in current window

    - `X-RateLimit-Reset`: Unix timestamp when the window resets


    ## Pagination


    List endpoints support cursor-based pagination using the following query
    parameters:

    - `page`: Page number (default: 1)

    - `limit`: Items per page (default: 25, max: 100)


    Paginated responses include pagination metadata:

    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "limit": 25,
        "has_next": true,
        "has_prev": false
      }
    }

    ```


    **Note**: For performance reasons, total counts (`total`, `total_pages`) are
    not included.

    Use `has_next` and `has_prev` to determine if more pages exist.


    ## Errors


    The API uses standard HTTP status codes and returns errors in a consistent
    format:


    ```json

    {
      "success": false,
      "error": "Human readable error message",
      "data": null
    }

    ```


    Common status codes:

    - `400` Bad Request - Invalid parameters or request body

    - `401` Unauthorized - Missing or invalid API key

    - `403` Forbidden - Valid API key but insufficient permissions

    - `404` Not Found - Resource not found

    - `429` Too Many Requests - Rate limit exceeded

    - `500` Internal Server Error - Server-side error
  termsOfService: https://www.useroulette.com/terms
  contact:
    name: Roulette API Support
    email: support@useroulette.com
    url: https://www.useroulette.com/support
  license:
    name: Proprietary
    url: https://www.useroulette.com/license
servers:
  - url: https://www.useroulette.com/api/v1
    description: Production server
  - url: http://localhost:3000/api/v1
    description: Local development server
security:
  - BearerAuth: []
tags:
  - name: Companies
    description: >
      Manage companies in your deal flow pipeline. Companies represent potential

      investment opportunities with associated pitch decks, contacts, and
      metadata.
  - name: Company Statuses
    description: |
      Manage deal flow stages/statuses for organizing companies through your
      investment pipeline (e.g., "Initial Review", "Due Diligence", "Closed").
  - name: Company Settings
    description: |
      Configure custom fields and settings for company tracking.
  - name: Contacts
    description: |
      Manage contacts associated with companies, including founders, executives,
      and other key personnel.
  - name: Form Submissions
    description: |
      Access form submissions from integrated platforms like Tally.
  - name: Emails
    description: |
      Manage emails linked to companies and contacts.
  - name: Meeting Minutes
    description: |
      Store and retrieve meeting notes and minutes related to companies.
  - name: Shared Links
    description: |
      Create and manage secure shareable links for company portfolios.
  - name: Integrations
    description: |
      Configure third-party integrations (Tally, Specter, etc.).
  - name: Investor Dashboard
    description: |
      Configure and manage investor-facing portfolio dashboards.
  - name: Dashboard
    description: |
      Access aggregated dashboard data and analytics.
  - name: Team Members
    description: |
      View team members and their roles within your account.
  - name: Short URLs
    description: |
      Create shortened URLs with optional password protection.
paths:
  /companies/{id}/attachments:
    post:
      tags:
        - Companies
      summary: Upload company attachment
      description: |
        Upload additional documents/attachments to a company
        (financials, legal docs, etc.).
      operationId: uploadCompanyAttachment
      parameters:
        - $ref: '#/components/parameters/CompanyIdParam'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - file
                - title
                - account_id
              properties:
                file:
                  type: string
                  format: binary
                  description: File to upload
                title:
                  type: string
                  description: Attachment title
                description:
                  type: string
                  description: Optional description
                account_id:
                  type: string
                  format: uuid
      responses:
        '200':
          description: Attachment uploaded
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      attachment:
                        $ref: '#/components/schemas/CompanyAttachment'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    CompanyIdParam:
      name: id
      in: path
      required: true
      description: The unique identifier of the company
      schema:
        type: string
        format: uuid
      example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
  schemas:
    CompanyAttachment:
      type: object
      description: File or link attachment associated with a company
      required:
        - id
        - company_id
        - account_id
        - attachment_type
        - title
      properties:
        id:
          type: string
          format: uuid
        company_id:
          type: string
          format: uuid
        account_id:
          type: string
          format: uuid
        attachment_type:
          type: string
          enum:
            - file
            - link
          description: Type of attachment (file stored in storage, or external link)
        title:
          type: string
          maxLength: 500
          example: Financial Projections
        description:
          type: string
          nullable: true
          example: Q4 2024 financial projections spreadsheet
        file_path:
          type: string
          nullable: true
          description: Storage path for file attachments (null for links)
          example: company-uuid/attachment-uuid/document.pdf
        link_url:
          type: string
          format: uri
          nullable: true
          description: External URL for link attachments (null for files)
        file_size_bytes:
          type: integer
          nullable: true
          description: File size in bytes (files only)
        file_mime_type:
          type: string
          nullable: true
          description: MIME type of the file (files only)
          example: application/pdf
        original_filename:
          type: string
          nullable: true
          description: Original filename when uploaded (files only)
          example: Q4 Projections.xlsx
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: Human-readable error message
          example: Invalid request body
        data:
          type: 'null'
          example: null
        authType:
          type: string
          enum:
            - api_key
            - session
          example: api_key
  responses:
    BadRequestError:
      description: Bad request - invalid parameters or request body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error: Invalid request body
            data: null
    UnauthorizedError:
      description: Unauthorized - missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error: Invalid or expired API key
            data: null
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error: Internal server error
            data: null
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: |
        API key authentication. Generate keys from your account settings.

        Include in header: `Authorization: Bearer YOUR_API_KEY`

````