The API reference is in English.

Current source preview reference

POST /v1/auth/ide/browser-invitations

Create ide browser invitation. Permissions, parameters, responses and examples.

0.1.0 · source bccff29 · Immutable snapshot · Download OpenAPI specification

Create ide browser invitation

Create ide browser invitation through POST /v1/auth/ide/browser-invitations. The parameters and declared response shapes below come from this exact source snapshot.

Source preview; no stable third-party integration promise. This page makes no request to a local installation.

Authority

Exact active IDE capability with browser:invite. Handler requires IDE authority; a browser session alone is insufficient.

Inspect the authority source · Authentication guide

Parameters and headers

No explicit path, query or header parameters are declared here. The authority boundary still applies.

Request body

JSON body · required · IdeBrowserInvitationRequest

FieldTypePresence
purposestringRequired
Complete declared request schema
{
  "additionalProperties": false,
  "properties": {
    "purpose": {
      "enum": [
        "integrated_dashboard",
        "extra_browser"
      ],
      "title": "Purpose",
      "type": "string"
    }
  },
  "required": [
    "purpose"
  ],
  "title": "IdeBrowserInvitationRequest",
  "type": "object"
}

Responses

StatusMeaning and declared shape
200

Successful Response

application/json · IdeBrowserInvitationResponse
{
  "additionalProperties": false,
  "properties": {
    "bootstrap_token": {
      "pattern": "^kbi1\\.[A-Za-z0-9_-]{24}\\.[A-Za-z0-9_-]{43}$",
      "title": "Bootstrap Token",
      "type": "string"
    },
    "expires_at": {
      "format": "date-time",
      "title": "Expires At",
      "type": "string"
    },
    "expires_in": {
      "const": 600,
      "default": 600,
      "title": "Expires In",
      "type": "integer"
    },
    "invitation_id": {
      "pattern": "^[A-Za-z0-9_-]{24}$",
      "title": "Invitation Id",
      "type": "string"
    },
    "issued_at": {
      "format": "date-time",
      "title": "Issued At",
      "type": "string"
    },
    "purpose": {
      "enum": [
        "integrated_dashboard",
        "extra_browser"
      ],
      "title": "Purpose",
      "type": "string"
    }
  },
  "required": [
    "bootstrap_token",
    "invitation_id",
    "purpose",
    "issued_at",
    "expires_at"
  ],
  "title": "IdeBrowserInvitationResponse",
  "type": "object"
}
400

Exact host, malformed request or URL credential refusal

application/json · object
{
  "properties": {
    "detail": {
      "type": "string"
    }
  },
  "required": [
    "detail"
  ],
  "type": "object"
}
401

Missing or invalid membership

application/json · object
{
  "properties": {
    "detail": {
      "type": "string"
    }
  },
  "required": [
    "detail"
  ],
  "type": "object"
}
403

Exact origin, CSRF or route authority refusal

application/json · object
{
  "properties": {
    "detail": {
      "type": "string"
    }
  },
  "required": [
    "detail"
  ],
  "type": "object"
}
422

Validation Error

application/json · HTTPValidationError
{
  "properties": {
    "detail": {
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      },
      "title": "Detail",
      "type": "array"
    }
  },
  "title": "HTTPValidationError",
  "type": "object"
}
429

Authentication rate or connection limit

application/json · object
{
  "properties": {
    "detail": {
      "type": "string"
    }
  },
  "required": [
    "detail"
  ],
  "type": "object"
}

An empty or broad schema preserves the source contract. It is not a promise of an empty response.

Source-linked errors

Literal HTTP errors in this handler and same-file helper call graph, plus control middleware. Dynamic and cross-module failures may add other errors; source links are authoritative.

2 source error observations
StatusSource detailRecovery
403 ↗active IDE capability requiredReview exact origin, CSRF, IDE scope and owner approval. Do not broaden authority.
401 ↗active IDE capability requiredReconcile the exact browser or IDE membership through the normal owner workflow.

Read the recovery guide

Synthetic examples

These examples validate declared JSON shapes and formats. They contain no real installation data and do not prove runtime admission, cross-field validation, authority or successful work.

Request JSON
{
  "purpose": "integrated_dashboard"
}
Response 200 JSON
{
  "bootstrap_token": "kbi1.AAAAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  "expires_at": "2026-01-01T00:00:00Z",
  "invitation_id": "AAAAAAAAAAAAAAAAAAAAAAAA",
  "issued_at": "2026-01-01T00:00:00Z",
  "purpose": "integrated_dashboard"
}
Download this service's complete OpenAPI

All referenced models remain in its components section. Browse control model definitions.