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

# Register a deployed SumApp

> Upsert this tenant's registry entry for a deployed SumApp.

Called by the deploy pipeline after a successful deploy (scope ``tables:append``).
Keyed by slug: redeploys refresh title/description/url in place. The Applications
launcher renders exactly this registry, so registered == deployed for the
environment this API serves.



## OpenAPI

````yaml https://api.summation.com/openapi.json post /v1/sum-apps
openapi: 3.1.0
info:
  title: summation-api public API
  version: 0.1.0
servers: []
security: []
tags:
  - name: Auth
    description: Machine authentication for API clients.
  - name: Tenant
    description: Organization and tenant context resolved by summation-api.
  - name: Projects
    description: Project resources.
  - name: Conversations
    description: Conversation and message resources.
  - name: Reports
    description: Report resources and report operations.
  - name: Runs
    description: Project run history and execution status.
  - name: Playbooks
    description: Playbook resources.
  - name: Files
    description: Project file resources.
  - name: Catalog Entries
    description: Project-scoped data asset attachments.
  - name: Data Connectors
    description: Reusable external data source connections.
  - name: App Connectors
    description: External app connectors whose tools the agent can use during chat.
  - name: Tables
    description: Canonical table metadata and catalog.
  - name: Views
    description: Canonical Summation view metadata and catalog.
  - name: Query Executions
    description: Read-only SQL query execution.
  - name: Grid
    description: Materialized grid status, sync, and lineage.
  - name: Schedules
    description: Schedule and schedule run inspection.
paths:
  /v1/sum-apps:
    post:
      tags:
        - SumApps
      summary: Register a deployed SumApp
      description: >-
        Upsert this tenant's registry entry for a deployed SumApp.


        Called by the deploy pipeline after a successful deploy (scope
        ``tables:append``).

        Keyed by slug: redeploys refresh title/description/url in place. The
        Applications

        launcher renders exactly this registry, so registered == deployed for
        the

        environment this API serves.
      operationId: register_sum_app
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SumAppRegistration'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid request or unsupported option.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
        '401':
          description: Missing, invalid, or expired credentials.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
        '403':
          description: Authenticated but missing the required scope.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
        '404':
          description: Resource not found or not accessible.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
        '500':
          description: Internal server error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemError'
      security:
        - SummationMachineAuth:
            - tables:append
components:
  schemas:
    SumAppRegistration:
      properties:
        app:
          type: string
          title: App
          description: The app's manifest id, e.g. self-driving-roi.
        slug:
          type: string
          title: Slug
          description: Mount slug on the tenant app host (unique per tenant), e.g. sdr-roi.
        title:
          type: string
          title: Title
          description: Launcher card title.
          default: ''
        description:
          type: string
          title: Description
          description: Launcher card description.
          default: ''
        path:
          type: string
          title: Path
          description: Mount path, e.g. /p/sdr-roi/.
          default: ''
        url:
          type: string
          title: Url
          description: Full URL on the tenant app host.
          default: ''
      type: object
      required:
        - app
        - slug
      title: SumAppRegistration
      description: Deploy-pipeline registration of a deployed SumApp (POST /v1/sum-apps).
    ProblemError:
      description: >-
        Public error envelope (RFC 7807 ``application/problem+json``).


        Mirrors the body produced by :func:`api_error`. Declaring it in the
        contract

        lets generated clients type error handling instead of guessing.
      properties:
        type:
          description: URI reference identifying the problem type.
          title: Type
          type: string
        title:
          description: Short, human-readable summary of the problem type.
          title: Title
          type: string
        status:
          description: HTTP status code.
          title: Status
          type: integer
        detail:
          description: Human-readable explanation specific to this occurrence.
          title: Detail
          type: string
        code:
          description: Stable, machine-readable error code.
          title: Code
          type: string
        request_id:
          description: Correlation id, echoed in the x-request-id header.
          title: Request Id
          type: string
      required:
        - type
        - title
        - status
        - detail
        - code
        - request_id
      title: ProblemError
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    SummationMachineAuth:
      type: oauth2
      flows:
        clientCredentials:
          scopes:
            agent:read: agent:read
            agent:write: agent:write
          tokenUrl: /v1/auth/m2m/token

````