> ## Documentation Index > Fetch the complete documentation index at: https://docs.nvisy.com/llms.txt > Use this file to discover all available pages before exploring further. # Generate invite code > Creates a shareable invite code that can be used by anyone to join the workspace. ## OpenAPI ````yaml /api-reference/openapi.json post /workspaces/{workspaceSlug}/invites/code/ openapi: 3.1.0 info: title: Nvisy API summary: Document processing and annotation platform description: >- Nvisy provides intelligent document processing, annotation, and analysis capabilities. This API enables document upload, OCR processing, embedding generation, and semantic search across your document collections. termsOfService: https://nvisy.com/legal/terms-of-service contact: name: Nvisy Support url: https://nvisy.com email: hello@nvisy.com license: name: Proprietary url: https://nvisy.com/license version: 0.1.0 servers: [] security: [] tags: - name: Accounts description: Account management and profile operations - name: Authentication description: Login, signup, and token management - name: Workspaces description: Workspace creation and management - name: Files description: File upload, download, and management - name: Members description: Workspace member management - name: Invites description: Workspace invitation handling - name: API Tokens description: API token management - name: Connections description: External provider connections - name: Pipelines description: Redaction pipeline configuration - name: Pipeline Runs description: Pipeline run execution and review - name: Policies description: Redaction policy configuration - name: Webhooks description: Webhook configuration - name: Notifications description: Account notification management - name: Health description: Service health checks paths: /workspaces/{workspaceSlug}/invites/code/: post: tags: - Invites summary: Generate invite code description: >- Creates a shareable invite code that can be used by anyone to join the workspace. parameters: - in: path name: workspaceSlug description: URL-safe workspace identifier. required: true schema: description: URL-safe workspace identifier. type: string style: simple requestBody: description: Request to generate a shareable invite code for a workspace. content: application/json: schema: $ref: '#/components/schemas/GenerateInviteCode' required: true responses: '201': description: Response containing a generated shareable invite code. content: application/json: schema: $ref: '#/components/schemas/InviteCode' '400': description: >- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: >- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '415': description: 'Expected request with `Content-Type: application/json`' content: text/plain: schema: type: string '422': description: Failed to deserialize the JSON body into the target type content: text/plain: schema: type: string security: - BearerAuth: [] components: schemas: GenerateInviteCode: description: Request to generate a shareable invite code for a workspace. type: object properties: expiresIn: description: When the invite code expires. allOf: - $ref: '#/components/schemas/InviteExpiration' invitedRole: description: Role to assign when someone joins via this invite code. allOf: - $ref: '#/components/schemas/WorkspaceRole' required: - invitedRole - expiresIn InviteCode: description: Response containing a generated shareable invite code. type: object properties: expiresAt: description: When the invite code expires. type: string format: date-time inviteCode: description: The generated invite code that can be shared. type: string role: description: Role assigned when someone joins via this code. allOf: - $ref: '#/components/schemas/WorkspaceRole' workspaceSlug: description: Handle of the workspace this invite code is for. allOf: - $ref: '#/components/schemas/Handle' required: - inviteCode - workspaceSlug - role - expiresAt ErrorResponse: description: |- HTTP error response representation with security-conscious design. This struct contains all the information needed to serialize an error response, including the error name, message, HTTP status code, resource information, and user-friendly messages. type: object properties: message: description: User-friendly error message safe for client display type: string name: description: The error name/type identifier type: string resource: description: The resource that the error relates to (optional, set by handler) type: string suggestion: description: Helpful suggestion for resolving the error (optional) type: string validation: description: Validation error details for field-specific errors type: array items: $ref: '#/components/schemas/ValidationErrorDetail' required: - name - message InviteExpiration: description: Expiration options for invite codes. oneOf: - description: Expires in 24 hours. type: string const: in24Hours - description: Expires in 7 days. type: string const: in7Days - description: Expires in 30 days. type: string const: in30Days WorkspaceRole: description: >- Defines the role and permission level of a workspace member. This enumeration corresponds to the `WORKSPACE_ROLE` PostgreSQL enum and provides hierarchical access control for workspace members with clearly defined capabilities. oneOf: - description: Full workspace ownership and management capabilities type: string const: owner - description: >- Can manage members, integrations, and settings, but cannot delete workspace or transfer ownership type: string const: admin - description: >- Can edit content and manage files, but cannot manage members or workspace settings type: string const: member - description: Read-only access to workspace content type: string const: guest Handle: description: >- Lowercase, dash-separated identifier used in URLs and as account handles. type: string maxLength: 32 minLength: 3 pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$ ValidationErrorDetail: description: Validation error details for field-specific errors. type: object properties: code: description: Error code for the validation failure type: string field: description: Field name that failed validation type: string message: description: Human-readable error message type: string params: description: Additional parameters related to the validation error type: object additionalProperties: true required: - field - code - message ````