---
title: "Public non-sensitive invite preview"
method: POST
path: "/api/invites/preview"
tags: ["invites"]
---

# Public non-sensitive invite preview

`POST /api/invites/preview`

## Request

- Base URL: `https://api.hillstar.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.hillstar.ai/api/invites/preview`
- Auth: none declared

## Request body

- InvitePreviewRequest
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `invite_code` string, required: Invite code

## Response `200`

OK

- InviteInfoResponse
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `kind` string, required
  - `role` string
  - `status` string, required
  - `workspace_name` string

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/hillstar/apis/rfpai-api-go.md) - [All operations](https://skmtc.dev/hillstar/apis/rfpai-api-go/llms.txt) - [OpenAPI document](https://skmtc.dev/hillstar/apis/rfpai-api-go/revisions/b2532dc47fc6?raw)