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

# Mint a connect link

> Get a hosted connect link to send to your customer.


## OpenAPI

```yaml openapi.json post /v1/connections/{provider}/link
openapi: 3.1.0
info:
  title: Ocean One API
  version: 2.3.1
servers:
  - url: https://api.plungeai.com
paths:
  /v1/connections/{provider}/link:
    post:
      operationId: post-v1-connections-provider-link
      tags:
        - Connections
      summary: Get a hosted connect link to send to your customer
      description: "A signed URL on studio.plungeai.com that works once and for 15 minutes, with no Studio login: the customer signs in at the provider (or pastes a key) and the connection lands under `on_behalf_of`. With `return_url` they come back to your page with `?connected=<provider>`."
      security:
        - ozkBearer: []
      parameters:
        - name: provider
          in: path
          required: true
          schema:
            type: string
          description: Connector id (`google`, `azure` for Microsoft 365, `github`, `slack`, `stripe`, …). The `connect` pointer in a 424 names it.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                on_behalf_of:
                  type: string
                  pattern: ^(?!.*\.\.)[A-Za-z0-9_.-]{1,128}$
                  description: "Your customer’s id (an opaque string you own): the connection is theirs, stored under your key and reachable only through it. Omit it to connect your own account."
                return_url:
                  type: string
                  format: uri
                  description: An https URL to send the customer to afterwards.
                format:
                  type: string
                  enum:
                    - json
                    - yaml
                    - markdown
                    - text
                  description: Response format override (Accept header and the request Content-Type mirror also work). Default json.
              required: []
      responses:
        "201":
          description: The link Response format negotiates via the `format` field, an Accept header (application/json, text/yaml, text/markdown, text/plain), or the request Content-Type mirror; default JSON.
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    format: uri
                  expires_at:
                    type: string
                    format: date-time
                required:
                  - url
                  - expires_at
            text/yaml:
              schema:
                type: string
            text/markdown:
              schema:
                type: string
            text/plain:
              schema:
                type: string
        "400":
          description: invalid_return_url — return_url must be https; invalid_json / invalid_yaml / invalid_body — unreadable body; invalid_format — format must be one of json, yaml, markdown, text; invalid_on_behalf_of — on_behalf_of must be 1-128 characters of A-Z a-z 0-9 _ . - (no "..")
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "401":
          description: unauthorized — missing, invalid or revoked ozk_ key
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "404":
          description: "unknown_provider — no connector with that provider id; connection_not_found — nothing to disconnect; not_found — no route for this method on this path: every other method answers it"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        "503":
          description: connections_unavailable — connections are not available on this deployment
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
components:
  schemas:
    Error:
      type: object
      description: Standard error envelope. Every error response also carries an `X-Error-Code` response header equal to error.code, so a client branches on the header regardless of the negotiated body format (json | yaml | markdown | text). When the request created an execution, the `X-Execution-Id` response header is also set. Errors follow the negotiated format like success bodies.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            connect:
              type: object
              description: "On a 424 connection_required / credential_required: where the missing connection is made."
              properties:
                provider:
                  type: string
                method:
                  type: string
                  enum:
                    - oauth
                    - api_key
                    - wallet
                link:
                  type: string
                  example: POST /v1/connections/stripe/link
          required:
            - code
            - message
          additionalProperties: true
      required:
        - error
  securitySchemes:
    ozkBearer:
      type: http
      scheme: bearer
      description: "ozk_ platform API key (Authorization: Bearer ozk_…)"
```