> ## Documentation Index
> Fetch the complete documentation index at: https://raise-gate.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a tracked company

> Saves the company immediately and returns in about 2-3 seconds. Missing LinkedIn/X profiles are found in the background and the first tracker run starts automatically. Send `Idempotency-Key` so retries are safe. Re-adding an already tracked company updates it (`existingEntity: true`) instead of duplicating.



## OpenAPI

````yaml /openapi.json post /api/v1/tracker
openapi: 3.1.0
info:
  title: RaiseGate Partner API
  version: 1.0.0
  description: >-
    Organisation-scoped API for managing tracker entities, reading signals and
    alerts, and reviewing generated leads. Every key belongs to one
    organisation. Send `Authorization: Bearer rg_live_...` on every request.
servers:
  - url: https://app.raisegate.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Tracker
    description: Companies and founders the organisation monitors.
  - name: Signals
    description: Analysed result of each tracker run.
  - name: Alerts
    description: Whether a run emailed the VC, and why.
  - name: Leads
    description: Founders discovered around tracked companies.
paths:
  /api/v1/tracker:
    post:
      tags:
        - Tracker
      summary: Create a tracked company
      description: >-
        Saves the company immediately and returns in about 2-3 seconds. Missing
        LinkedIn/X profiles are found in the background and the first tracker
        run starts automatically. Send `Idempotency-Key` so retries are safe.
        Re-adding an already tracked company updates it (`existingEntity: true`)
        instead of duplicating.
      operationId: createTrackedEntity
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrackerCreate'
            example:
              companyName: Example Bio
              companyWebsite: https://example.bio
              founders:
                - name: Jane Founder
                - name: John Cofounder
              thingsToTrack: >-
                Fundraising, partnerships with food or pet-care companies,
                scale-up milestones.
              alertEmails:
                - partners@fund.example
              cadenceDays: 7
              confirmed: true
      responses:
        '200':
          description: >-
            Idempotent replay (`idempotencyReplayed: true`) or the company was
            already tracked and updated (`existingEntity: true`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackerEntityEnvelope'
        '201':
          $ref: '#/components/responses/TrackerEntity'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: 8-200 printable ASCII characters, no spaces. Remembered for 24 hours.
      schema:
        type: string
        minLength: 8
        maxLength: 200
  schemas:
    TrackerCreate:
      allOf:
        - $ref: '#/components/schemas/TrackerDraft'
        - type: object
          required:
            - confirmed
          properties:
            confirmed:
              type: boolean
              const: true
              description: >-
                Must be `true`. Explicit confirmation that this company should
                be tracked.
    TrackerEntityEnvelope:
      type: object
      properties:
        data:
          type: object
        operation:
          $ref: '#/components/schemas/Operation'
        idempotencyReplayed:
          type: boolean
        existingEntity:
          type: boolean
    TrackerDraft:
      type: object
      required:
        - companyName
        - companyWebsite
        - founders
        - thingsToTrack
        - alertEmails
      properties:
        companyName:
          type: string
          minLength: 1
          maxLength: 200
        companyWebsite:
          type: string
          format: uri
        companyLinkedinUrl:
          type: string
          format: uri
        companyTwitterUrl:
          type: string
          format: uri
        companyGithubUrl:
          type: string
          format: uri
        companySummary:
          type: string
          maxLength: 5000
        founders:
          type: array
          minItems: 1
          maxItems: 10
          items:
            $ref: '#/components/schemas/Founder'
        thingsToTrack:
          type: string
          minLength: 1
          maxLength: 10000
          description: Natural-language alert rules, compiled into a governed policy.
        alertEmails:
          type: array
          minItems: 1
          maxItems: 20
          items:
            type: string
            format: email
        emailAlertsEnabled:
          type: boolean
          default: true
        cadenceDays:
          type: integer
          enum:
            - 3
            - 7
            - 30
          default: 7
    Operation:
      type: object
      properties:
        entityId:
          type: string
          format: uuid
        pollUrl:
          type: string
        enrichmentStatus:
          type: string
          enum:
            - queued
            - running
            - ready
            - partial
            - failed
        enrichmentComplete:
          type: boolean
        suggestedPollIntervalSeconds:
          type:
            - integer
            - 'null'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
    Founder:
      type: object
      required:
        - name
      properties:
        id:
          type: string
          description: 'PATCH only: stored founder id to update in place.'
        name:
          type: string
        linkedinUrl:
          type: string
          format: uri
        twitterUrl:
          type: string
          format: uri
        githubUrl:
          type: string
          format: uri
  responses:
    TrackerEntity:
      description: Tracked company plus enrichment operation.
      headers:
        Location:
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TrackerEntityEnvelope'
    BadRequest:
      description: '`validation_error`, `invalid_json`, or `invalid_cursor`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing, malformed, unknown, revoked or expired key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Key lacks the required scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Conflict:
      description: >-
        `idempotency_conflict`, `idempotency_in_progress`,
        `refresh_in_progress`, or `entity_paused`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Per-key rate limit exceeded. Wait `Retry-After` seconds.
      headers:
        Retry-After:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: RaiseGate API key
      description: 'API key issued with `npm run partner-api:key`. Format: `rg_live_...`.'

````