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

# Manage a Slack migration

> Discover channels after Slack consent, prepare exact mappings, apply an immutable plan, and inspect or retry durable results. Requires a human owner/admin API key with slack_migration:read; begin_connection, plan, apply and retry additionally require slack_migration:write. Independently gated discovery/write rollout. Initial mapping pilot supports internal public channels only.



## OpenAPI

````yaml /openapi.json post /slack/migration
openapi: 3.0.3
info:
  description: >-
    Generated from Ando's accepted public API v1 contract metadata. Current
    routes preserve legacy /api/v1 response envelopes while converging on the
    public https://api.ando.so/v1 shape.
  title: Ando Public API
  version: v1
servers:
  - description: Canonical public API host.
    url: https://api.ando.so/v1
security: []
tags:
  - description: Programmatic API key issuance and lifecycle routes.
    name: API Keys
  - description: Workspace agent lifecycle routes.
    name: Agents
  - description: Call detail and transcript routes.
    name: Calls
  - description: Membership-scoped conversation routes.
    name: Conversations
  - description: File upload lifecycle routes for public API message attachments.
    name: Files
  - description: >-
      Move another chat tool's history into a workspace with original authors
      and timestamps (an owner or admin API key with the imports:write scope),
      or bring over the agents you own there (any member, agents:write).
    name: Imports
  - description: >-
      Workspace member detail routes. Existing v1 paths keep member
      compatibility spellings.
    name: Members
  - description: Message and conversation message routes.
    name: Messages
  - description: Public realtime connection and protocol routes.
    name: Realtime
  - description: Search routes.
    name: Search
  - description: Outbound webhook endpoint and delivery routes.
    name: Webhooks
paths:
  /slack/migration:
    post:
      tags:
        - Imports
      summary: Manage a Slack migration
      description: >-
        Discover channels after Slack consent, prepare exact mappings, apply an
        immutable plan, and inspect or retry durable results. Requires a human
        owner/admin API key with slack_migration:read; begin_connection, plan,
        apply and retry additionally require slack_migration:write.
        Independently gated discovery/write rollout. Initial mapping pilot
        supports internal public channels only.
      operationId: manageSlackMigration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SlackMigrationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlackMigrationResponse'
          description: Migration operation result.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - AndoApiKey: []
        - BearerApiKey: []
components:
  schemas:
    SlackMigrationRequest:
      additionalProperties: false
      description: >-
        Human-authorized native Slack migration. Read connection and directory
        before submitting exact selections. Apply requires plan_id, plan_version
        and idempotency_key. Retry requires operation_id, item_ids and
        idempotency_key.
      properties:
        action:
          description: Operation to perform.
          enum:
            - connection
            - begin_connection
            - get_connection_attempt
            - list_channels
            - plan
            - get_plan
            - apply
            - get_operation
            - retry
          type: string
        expected_slack_team_id:
          description: Verified Slack team ID. Required for planning.
          type: string
        connection_attempt_id:
          description: Resumable connection reference.
          type: string
        plan_id:
          description: Immutable plan reference.
          type: string
        plan_version:
          type: integer
          enum:
            - 1
        operation_id:
          description: Durable operation reference.
          type: string
        idempotency_key:
          type: string
          minLength: 8
          maxLength: 128
        cursor:
          type: string
          maxLength: 200
        limit:
          type: integer
          minimum: 1
          maximum: 100
        item_ids:
          type: array
          minItems: 1
          maxItems: 50
          items:
            type: string
        selections:
          type: array
          minItems: 1
          maxItems: 50
          items:
            additionalProperties: false
            description: Exact source, destination, and requested effects.
            properties:
              slack_channel_id:
                type: string
                minLength: 1
                maxLength: 100
              target:
                oneOf:
                  - additionalProperties: false
                    description: Create a new channel; an existing name is a blocker.
                    properties:
                      kind:
                        type: string
                        enum:
                          - create_channel
                      name:
                        type: string
                        minLength: 1
                        maxLength: 80
                    required:
                      - kind
                      - name
                    type: object
                  - additionalProperties: false
                    description: >-
                      Reuse this exact public channel without retargeting an
                      existing mapping.
                    properties:
                      kind:
                        type: string
                        enum:
                          - existing_channel
                      conversation_id:
                        type: string
                        minLength: 1
                    required:
                      - kind
                      - conversation_id
                    type: object
              live_sync:
                type: boolean
              backfill_history:
                type: boolean
            required:
              - slack_channel_id
              - target
              - live_sync
              - backfill_history
            type: object
      required:
        - action
      type: object
    SlackMigrationResponse:
      additionalProperties: false
      description: >-
        Operation-specific result. Setup completion does not prove historical
        completeness. Private and Slack Connect sources are discoverable but
        blocked in this initial pilot.
      properties:
        data:
          type: object
          additionalProperties: true
          description: >-
            Connection identity/attempt, paginated directory, immutable plan
            with per-item blockers, operation reference, or per-item
            mapping/sync/history readback. Directory completeness is explicit.
      required:
        - data
      type: object
    LegacyErrorResponse:
      additionalProperties: false
      description: Current compatibility error envelope used by legacy /api/v1 routes.
      properties:
        error:
          description: Error message.
          type: string
        error_code:
          description: Optional machine-readable error code.
          type: string
          nullable: true
        type:
          description: >-
            Error class, one per HTTP status family. rate_limit_error,
            api_error, overloaded_error and timeout_error are worth retrying;
            the others need a different request. Retry a write only with the
            same Idempotency-Key: an api_error can mean it committed.
          enum:
            - invalid_request_error
            - authentication_error
            - permission_error
            - not_found_error
            - conflict_error
            - request_too_large
            - rate_limit_error
            - api_error
            - overloaded_error
            - timeout_error
          type: string
        request_id:
          description: >-
            The request id, also sent as the x-request-id header. Quote it when
            reporting a problem.
          type: string
        missing_scopes:
          description: Missing scopes.
          items:
            description: Scope.
            type: string
          type: array
      required:
        - error
      type: object
    PublicApiErrorResponse:
      additionalProperties: false
      description: Target public API error envelope.
      properties:
        error:
          additionalProperties: false
          description: Error details.
          properties:
            code:
              description: Machine-readable error code.
              type: string
            message:
              description: Human-readable error message.
              type: string
            request_id:
              description: Request identifier.
              type: string
              nullable: true
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
  responses:
    BadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Bad request.
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Missing or invalid API key.
    Forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Forbidden.
    NotFound:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Not found.
    Conflict:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Conflict.
    RateLimited:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiErrorResponse'
      description: Rate limit or quota exceeded.
    InternalError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LegacyErrorResponse'
      description: Internal server error.
  securitySchemes:
    AndoApiKey:
      description: Workspace API key. Current accepted keys use the ando_sk_ prefix.
      in: header
      name: x-api-key
      type: apiKey
    BearerApiKey:
      bearerFormat: ando_sk
      description: Compatibility transport for workspace API keys.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.