curl --request POST \
  --url https://commet.co/api/v1/portal/sessions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "jsmith@example.com"
}
'

import { Commet } from "@commet/node";

const commet = new Commet({ apiKey: "ck_xxx" });

const portalAccess = await commet.portal.getUrl({ email: "user@example.com" });

from commet import Commet

commet = Commet("ck_xxx")

portal_access = commet.portal.get_url(email="user@example.com")

client, err := commet.New("ck_xxx")
if err != nil {
	log.Fatal(err)
}
ctx := context.Background()

portalAccess, err := client.Portal.GetURL(ctx, &commet.RequestPortalAccessParams{
	Email: func(value string) *string { return &value }("user@example.com"),
})
if err != nil {
	log.Fatal(err)
}

import co.commet.Commet;
import co.commet.params.RequestPortalAccessParams;

var commet = Commet.builder().apiKey("ck_xxx").build();

var portalAccess = commet.portal().getUrl(
    RequestPortalAccessParams.builder().email("user@example.com").build()
);

use Commet\Commet;

$commet = new Commet('ck_xxx');

$portalAccess = $commet->portal->getUrl(email: 'user@example.com');

{
  "portalUrl": "https://commet.co/portal/example_portal_token",
  "object": "portal_session",
  "livemode": false
}

{
  "error": {
    "type": "validation_error",
    "code": "validation_error",
    "message": "The request contains an invalid parameter.",
    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md"
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "unauthorized",
    "message": "A valid API key is required.",
    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/unauthorized.md"
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "forbidden",
    "message": "You do not have permission to perform this operation.",
    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/forbidden.md"
  }
}

{
  "error": {
    "type": "not_found_error",
    "code": "not_found",
    "message": "The requested resource was not found.",
    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/not_found.md"
  }
}

{
  "error": {
    "type": "conflict_error",
    "code": "idempotency_in_progress",
    "message": "A request with this idempotency key is still being processed.",
    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_in_progress.md"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Too many requests. Retry after the interval specified in the Retry-After header.",
    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/rate_limited.md"
  }
}

{
  "error": {
    "type": "internal_error",
    "code": "internal_error",
    "message": "An unexpected error occurred while processing the request.",
    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/internal_error.md"
  }
}

{
  "error": {
    "type": "internal_error",
    "code": "idempotency_unavailable",
    "message": "Idempotency storage is temporarily unavailable. Retry with the same idempotency key.",
    "doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_unavailable.md"
  }
}