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

# Create a reader

> Creates a new reader account and sends an invitation email to the specified address. The `invited_by` field is required when authenticating with an M2M (machine-to-machine) token, as the system cannot infer the inviting user from the token.
SSO readers can be created by setting `is_sso_user` to `true` and providing a `scheme_name`. Requires the `UpdateRolesAccountsAndGroups` permission.
Related endpoints: `GET /v3/projects/{projectId}/readers` to list readers, `PUT /v3/projects/{projectId}/readers/{readerId}` to update a reader.

## OpenAPI

````json POST /v3/projects/{project_id}/readers
{
  "openapi": "3.0.1",
  "info": {
    "title": "Document360 Customer API",
    "description": "> **⚠️ Beta:** Version 3 of the Document360 Customer API is currently in **Beta**. The contract (routes, request/response field names, status codes) may change without notice prior to GA. Pin to a specific revision and review release notes before upgrading.\n\nDocument360 RESTful APIs let you integrate your documentation with your software — onboard readers, manage articles, automate publishing, and more.\n\nFull reference: [API Documentation](https://apidocs.document360.io/docs).\n\n## Authentication\nV3 authenticates with an **API key** — not the `api_token` used by V1/V2. Create one in the Document360 portal under **Settings → Knowledge base portal → API keys**, then click **Create API key**. (Projects that still have the older screen show two tabs; choose **Enhanced keys (v3)**, or pick **API v3** from the Create menu.)\n\nSend it in the `X-API-Key` header:\n\n```\nX-API-Key: d360_sk_...\n```\n\nThe plaintext key is shown **once**, at creation — only its hash is stored, so a lost key must be replaced rather than recovered. Each key carries a fixed portal role, content role and content-access scope, supports an optional expiry, and can be disabled or deleted at any time from the same screen. Treat it as an opaque string: it is a pre-shared secret, not an OAuth 2.0 access token, and must not be parsed.\n\nFor flows that act on behalf of a specific person, V3 also accepts an OAuth 2.0 bearer token carrying the `customerApi` scope.\n\nAPI access is part of your subscription plan. If your plan does not include it, every endpoint returns `403` with the error code `FEATURE_NOT_IN_LICENSE` — including for keys created while an earlier plan was active. Contact your Customer Success Manager or `support@document360.com` to enable it.\n\n> **Note on terminology:** V1/V2 call these *API tokens* and manage them under **Settings → Knowledge base portal → API tokens**. V3 keys are a separate credential with their own screen, roles and scope — a V1/V2 token will not authenticate a V3 request.\n\n## Rate Limits\nAll endpoints are rate-limited per API key per project. Default limits vary by plan. When rate-limited, responses include `Retry-After`, `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers. Use exponential backoff with jitter for optimal retry behavior.",
    "termsOfService": "https://document360.com/terms",
    "contact": {
      "name": "Document360 Support",
      "url": "https://document360.io/contact-us/",
      "email": "support@document360.com"
    },
    "license": {
      "name": "Document360 API Terms of Use",
      "url": "https://document360.com/terms"
    },
    "version": "3.0.0"
  },
  "servers": [
    {
      "url": "https://apihub.document360.io",
      "description": "Document 360 API Hub"
    },
    {
      "url": "https://apihub.us.document360.io",
      "description": "Document360 API Hub - US data center"
    },
    {
      "url": "https://apihub.{private_hosting}.document360.io",
      "description": "Private hosting - Please provide the subdomain name.",
      "variables": {
        "private_hosting": {
          "default": "domain",
          "description": "Sub domain for private hosting"
        }
      }
    }
  ],
  "security": [
    {
      "ApiKey": []
    },
    {
      "Bearer": [
        "customerApi"
      ]
    }
  ],
  "tags": [
    {
      "name": "Projects",
      "description": "List and manage knowledge base projects. Export and import project documentation, and manage project-level site customization such as custom CSS and JavaScript."
    },
    {
      "name": "Projects > Import & export",
      "description": "Start a project export or import and poll the resulting background operation for completion."
    },
    {
      "name": "Workspaces",
      "description": "Manage workspaces and access workspace-scoped categories and articles."
    },
    {
      "name": "Workspaces > AI",
      "description": "Query the workspace with Eddy AI and submit feedback on AI answers."
    },
    {
      "name": "Articles",
      "description": "Create, read, update, and delete knowledge base articles and their settings, including bulk operations."
    },
    {
      "name": "Articles > Publishing & workflow",
      "description": "Publish and unpublish articles (single and bulk) and update the article workflow status."
    },
    {
      "name": "Articles > Versions",
      "description": "List, fork, and delete article versions."
    },
    {
      "name": "Articles > Attachments",
      "description": "Manage the files attached to an article — list, upload, and delete article attachments."
    },
    {
      "name": "Articles > Content drafts",
      "description": "(Internal) Stage AI-generated article content with an Accept/Reject review lifecycle — used by Eddy Copilot to preview content before committing to the live article body."
    },
    {
      "name": "Articles > Labels",
      "description": "Read and set the labels associated with an article."
    },
    {
      "name": "Categories",
      "description": "Manage the category hierarchy that organizes articles. Create, update, and delete categories and their settings, including bulk operations."
    },
    {
      "name": "Categories > Page category",
      "description": "Read and update the content body of page-type categories, including bulk content updates."
    },
    {
      "name": "Categories > Publishing & workflow",
      "description": "Publish and unpublish categories (single and bulk) and update the category workflow status."
    },
    {
      "name": "Categories > Versions",
      "description": "List, fork, and delete category versions."
    },
    {
      "name": "Categories > Labels",
      "description": "Read and set the labels associated with a category."
    },
    {
      "name": "ArticleTemplates",
      "description": "Manage reusable article templates — per-language article skeletons that authors and AI tools (such as Eddy Copilot) can apply when starting a new article.",
      "x-displayName": "Article templates"
    },
    {
      "name": "Content reuse > Glossaries",
      "description": "Manage glossary entries — terminology definitions referenced inside articles via merge codes (`{{glossary.name}}`) and rendered as tooltips on the public KB."
    },
    {
      "name": "Content reuse > Snippets",
      "description": "Manage reusable snippets — markdown or WYSIWYG content fragments referenced across articles via merge codes (`{{snippet.name}}`)."
    },
    {
      "name": "Content reuse > Variables",
      "description": "Manage reusable variables — short text values referenced across articles via merge codes (`{{variable.name}}`)."
    },
    {
      "name": "AiWriterStyleGuides",
      "description": "Retrieve AI writer style guides configured for the project — voice / tone instructions Eddy Copilot follows when generating article content. Used to let users pick a style before kicking off generation.",
      "x-displayName": "AI writer style guides"
    },
    {
      "name": "RedirectRules",
      "description": "Manage article-redirection rules — 301/302 redirects from old article URLs to new locations after renames or restructures.",
      "x-displayName": "Redirect rules"
    },
    {
      "name": "Tags",
      "description": "Manage tags — labels used to classify articles, categories, and files for filtering and discovery."
    },
    {
      "name": "Labels",
      "description": "Manage labels shown on the article list and category tree. (Associating labels with a specific article or category lives under Articles and Categories.)"
    },
    {
      "name": "CustomFields",
      "description": "Retrieve the custom field definitions configured for the project. Custom field values are read and written through the article and category settings endpoints.",
      "x-displayName": "Custom fields"
    },
    {
      "name": "ApiReferences",
      "description": "Import, resync, and publish OpenAPI/Swagger specifications for API reference documentation.",
      "x-displayName": "API references"
    },
    {
      "name": "ApiReferences > Logs",
      "description": "Monitor API reference import logs and inspect individual log entries."
    },
    {
      "name": "Drive",
      "description": "Search Drive and retrieve files associated with an article, and track Drive background tasks."
    },
    {
      "name": "Drive > Folders",
      "description": "Create, read, update, and delete Drive folders."
    },
    {
      "name": "Drive > Files",
      "description": "Upload, copy, move, delete, and tag Drive files."
    },
    {
      "name": "Drive > Image drafts",
      "description": "(Internal) Stage uploaded or AI-generated images (committed to Drive and associated with a staged article draft) — used by Eddy Copilot."
    },
    {
      "name": "Readers",
      "description": "Manage reader accounts, invitations, and access scopes for private documentation."
    },
    {
      "name": "Readers > Groups",
      "description": "Create, read, update, and delete reader groups."
    },
    {
      "name": "Users",
      "description": "Manage users, their portal and content roles, and consolidated (effective) permissions within a project."
    },
    {
      "name": "Users > Groups",
      "description": "Manage user groups, their portal role, and consolidated (effective) group permissions."
    },
    {
      "name": "Roles",
      "description": "Create, read, update, and delete portal and content roles, list the users assigned to a role, and retrieve the permission dependency matrix."
    },
    {
      "name": "ContentAccess",
      "description": "Manage per-node content-access permissions — grant, allow, deny, and inheritance overrides for users and groups against specific versions, languages, categories, or articles, plus version/language site protection.",
      "x-displayName": "Content access"
    },
    {
      "name": "ContentAccess > Eligibility",
      "description": "List the readers and groups eligible to be granted content access."
    },
    {
      "name": "Languages",
      "description": "Retrieve configured languages for a workspace."
    },
    {
      "name": "Translations",
      "description": "Query translation status of articles across languages."
    },
    {
      "name": "Operations",
      "description": "Track asynchronous operations — long-running tasks (bulk updates, merges, exports) accepted with `202 Accepted` and an `Operation-Location` header. Poll until the operation reaches a terminal status, honouring the `Retry-After` header."
    },
    {
      "name": "Analytics > Articles",
      "description": "View article performance metrics including views, top articles, reader locations, and category breakdowns."
    },
    {
      "name": "Analytics > Search",
      "description": "View search usage metrics including top keywords, no-result queries, and bounced searches."
    },
    {
      "name": "Analytics > AI search",
      "description": "View AI-powered search metrics including usage trends, most-referenced articles, and trending topics."
    },
    {
      "name": "Analytics > Feedback",
      "description": "View reader feedback trends across articles, including top-performing articles and feedback keywords."
    }
  ],
  "externalDocs": {
    "description": "Document360 API Documentation",
    "url": "https://apidocs.document360.io/docs"
  },
  "x-tagGroups": [
    {
      "name": "Workspace",
      "tags": [
        "Projects",
        "Projects > Import & export",
        "Workspaces",
        "Workspaces > AI"
      ]
    },
    {
      "name": "Content",
      "tags": [
        "Articles",
        "Articles > Publishing & workflow",
        "Articles > Versions",
        "Articles > Attachments",
        "Articles > Content drafts",
        "Articles > Labels",
        "Categories",
        "Categories > Page category",
        "Categories > Publishing & workflow",
        "Categories > Versions",
        "Categories > Labels",
        "ArticleTemplates",
        "AiWriterStyleGuides",
        "RedirectRules",
        "Tags",
        "Labels",
        "ApiReferences",
        "ApiReferences > Logs"
      ]
    },
    {
      "name": "Content reuse",
      "tags": [
        "Content reuse > Glossaries",
        "Content reuse > Snippets",
        "Content reuse > Variables"
      ]
    },
    {
      "name": "Media",
      "tags": [
        "Drive",
        "Drive > Folders",
        "Drive > Files",
        "Drive > Image drafts"
      ]
    },
    {
      "name": "Access",
      "tags": [
        "Readers",
        "Readers > Groups",
        "Users",
        "Users > Groups",
        "Roles",
        "ContentAccess",
        "ContentAccess > Eligibility"
      ]
    },
    {
      "name": "Localization",
      "tags": [
        "Languages",
        "Translations"
      ]
    },
    {
      "name": "Operations",
      "tags": [
        "Operations"
      ]
    },
    {
      "name": "Analytics",
      "tags": [
        "Analytics > Articles",
        "Analytics > Search",
        "Analytics > AI search",
        "Analytics > Feedback"
      ]
    }
  ],
  "paths": {
    "/v3/projects/{project_id}/readers": {
      "post": {
        "tags": [
          "Readers"
        ],
        "summary": "Create a reader.",
        "description": "Creates a new reader account and sends an invitation email to the specified address. The `invited_by` field is required when authenticating with an M2M (machine-to-machine) token, as the system cannot infer the inviting user from the token.\r\nSSO readers can be created by setting `is_sso_user` to `true` and providing a `scheme_name`. Requires the `UpdateRolesAccountsAndGroups` permission.\r\nRelated endpoints: `GET /v3/projects/{projectId}/readers` to list readers, `PUT /v3/projects/{projectId}/readers/{readerId}` to update a reader.",
        "operationId": "createReader",
        "parameters": [
          {
            "$ref": "#/components/parameters/ProjectId"
          }
        ],
        "requestBody": {
          "description": "Reader creation details.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateReaderRequest"
              },
              "examples": {
                "Invite a reader with project-wide access": {
                  "summary": "Invites a new reader with access to the entire project.",
                  "value": {
                    "first_name": "John",
                    "last_name": "Smith",
                    "email": "john.smith@example.com",
                    "associated_reader_groups": null,
                    "access_scope": {
                      "access_level": "project",
                      "categories": null,
                      "workspaces": null,
                      "languages": null
                    },
                    "is_sso_user": false,
                    "scheme_name": null,
                    "skip_sso_invitation_email": false,
                    "invited_by": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d"
                  }
                },
                "Invite a reader with category-scoped access": {
                  "summary": "Invites a new reader with access restricted to specific categories.",
                  "value": {
                    "first_name": "Sarah",
                    "last_name": "Connor",
                    "email": "sarah.connor@example.com",
                    "associated_reader_groups": [
                      "b2c3d4e5-f6a7-8b9c-0d1e-2f3a4b5c6d7e"
                    ],
                    "access_scope": {
                      "access_level": "category",
                      "categories": [
                        {
                          "workspace_id": "1c2d3e4f-5a6b-7c8d-9e0f-a1b2c3d4e5f6",
                          "category_id": "9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d",
                          "lang_code": "en"
                        }
                      ],
                      "workspaces": null,
                      "languages": null
                    },
                    "is_sso_user": false,
                    "scheme_name": null,
                    "skip_sso_invitation_email": false,
                    "invited_by": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Reader created successfully.",
            "headers": {
              "Location": {
                "description": "URL of the newly created resource.",
                "schema": {
                  "type": "string",
                  "format": "uri"
                }
              },
              "X-RateLimit-Limit": {
                "description": "The maximum number of requests allowed in the current time window for this request's bucket. Read requests (GET/HEAD) and write requests (POST/PUT/PATCH/DELETE) have independent limits, applied per caller (API key or user) per project.",
                "schema": {
                  "type": "integer",
                  "format": "int32"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "The number of requests remaining in the current time window. When this reaches 0, subsequent requests receive a 429 response.",
                "schema": {
                  "type": "integer",
                  "format": "int32"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReaderResponseApiResponse"
                },
                "examples": {
                  "Newly created reader": {
                    "summary": "Returns the reader that was just created",
                    "value": {
                      "data": {
                        "id": "a3b4c5d6-e7f8-4a9b-c0d1-e2f3a4b5c6d7",
                        "first_name": "Carol",
                        "last_name": "Smith",
                        "email": "carol.smith@example.com",
                        "access_scope": {
                          "access_level": "project",
                          "categories": [],
                          "workspaces": [],
                          "languages": []
                        },
                        "associated_reader_groups": [
                          "b2c3d4e5-f6a7-4b8c-9d0e-a1b2c3d4e5f6"
                        ],
                        "is_invite_sso_user": false,
                        "last_login_at": null
                      },
                      "success": true,
                      "request_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
                      "errors": [],
                      "warnings": []
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Authentication token is missing or invalid.",
            "headers": {
              "WWW-Authenticate": {
                "description": "Indicates the authentication scheme required. Returns `Bearer` with optional `error` and `error_description` parameters per RFC 6750.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/V3ProblemDetails"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "type": {
                          "enum": [
                            "https://apidocs.document360.io/apidocs/errors/unauthorized"
                          ],
                          "type": "string",
                          "description": "RFC 7807 error type URI. Always `https://apidocs.document360.io/apidocs/errors/unauthorized` for 401 responses."
                        },
                        "status": {
                          "enum": [
                            401
                          ],
                          "type": "integer",
                          "description": "HTTP status code. Always `401` for this response.",
                          "format": "int32"
                        }
                      }
                    }
                  ]
                },
                "examples": {
                  "Missing or invalid token": {
                    "summary": "Authentication token is missing or invalid.",
                    "value": {
                      "type": "https://apidocs.document360.io/apidocs/errors/unauthorized",
                      "title": "Unauthorized.",
                      "status": 401,
                      "detail": "The authentication token is missing or has expired.",
                      "instance": null,
                      "trace_id": "req_abc123def456",
                      "errors": [
                        {
                          "code": "UNAUTHORIZED",
                          "message": "Bearer token is missing or invalid.",
                          "field": null,
                          "details": null
                        }
                      ],
                      "warnings": null
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Token lacks the required scope or content permission. Can also mean the premium API add-on is not enabled for this project (error code `PREMIUM_FEATURE_NOT_IN_LICENSE`).",
            "content": {
              "application/problem+json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/V3ProblemDetails"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "type": {
                          "enum": [
                            "https://apidocs.document360.io/apidocs/errors/forbidden"
                          ],
                          "type": "string",
                          "description": "RFC 7807 error type URI. Always `https://apidocs.document360.io/apidocs/errors/forbidden` for 403 responses."
                        },
                        "status": {
                          "enum": [
                            403
                          ],
                          "type": "integer",
                          "description": "HTTP status code. Always `403` for this response.",
                          "format": "int32"
                        }
                      }
                    }
                  ]
                },
                "examples": {
                  "Insufficient permissions": {
                    "summary": "Insufficient permissions for this resource.",
                    "value": {
                      "type": "https://apidocs.document360.io/apidocs/errors/forbidden",
                      "title": "Forbidden.",
                      "status": 403,
                      "detail": "You do not have permission to perform this action.",
                      "instance": null,
                      "trace_id": "req_abc123def456",
                      "errors": [
                        {
                          "code": "FORBIDDEN",
                          "message": "Insufficient permissions for this project.",
                          "field": null,
                          "details": null
                        }
                      ],
                      "warnings": null
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation failed.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/V3ProblemDetails"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "type": {
                          "enum": [
                            "https://apidocs.document360.io/apidocs/errors/validation-error"
                          ],
                          "type": "string",
                          "description": "RFC 7807 error type URI. Always `https://apidocs.document360.io/apidocs/errors/validation-error` for 422 responses."
                        },
                        "status": {
                          "enum": [
                            422
                          ],
                          "type": "integer",
                          "description": "HTTP status code. Always `422` for this response.",
                          "format": "int32"
                        }
                      }
                    }
                  ]
                },
                "examples": {
                  "Validation failed": {
                    "summary": "The request body contains invalid data.",
                    "value": {
                      "type": "https://apidocs.document360.io/apidocs/errors/validation-error",
                      "title": "Unprocessable Entity.",
                      "status": 422,
                      "detail": "One or more fields failed validation.",
                      "instance": null,
                      "trace_id": "req_abc123def456",
                      "errors": [
                        {
                          "code": "VALIDATION_ERROR",
                          "message": "This field is required.",
                          "field": "title",
                          "details": null
                        }
                      ],
                      "warnings": null
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request body is malformed or contains invalid JSON.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/V3ProblemDetails"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "type": {
                          "enum": [
                            "https://apidocs.document360.io/apidocs/errors/bad-request"
                          ],
                          "type": "string",
                          "description": "RFC 7807 error type URI. Always `https://apidocs.document360.io/apidocs/errors/bad-request` for 400 responses."
                        },
                        "status": {
                          "enum": [
                            400
                          ],
                          "type": "integer",
                          "description": "HTTP status code. Always `400` for this response.",
                          "format": "int32"
                        }
                      }
                    }
                  ]
                },
                "examples": {
                  "Malformed request body": {
                    "summary": "The request body could not be parsed.",
                    "value": {
                      "type": "https://apidocs.document360.io/apidocs/errors/bad-request",
                      "title": "Bad Request.",
                      "status": 400,
                      "detail": "The request body is malformed or contains invalid JSON.",
                      "instance": null,
                      "trace_id": "req_abc123def456",
                      "errors": [
                        {
                          "code": "BAD_REQUEST",
                          "message": "Could not parse the request body. Ensure it is valid JSON.",
                          "field": null,
                          "details": null
                        }
                      ],
                      "warnings": null
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Rate limit exceeded. Retry after the duration specified in the Retry-After header.",
            "headers": {
              "Retry-After": {
                "description": "Number of seconds to wait before retrying the request. Use exponential backoff with jitter for optimal retry behavior.",
                "schema": {
                  "type": "integer",
                  "format": "int32"
                }
              },
              "X-RateLimit-Limit": {
                "description": "The maximum number of requests allowed in the current time window for this request's bucket. Read requests (GET/HEAD) and write requests (POST/PUT/PATCH/DELETE) have independent limits, applied per caller (API key or user) per project. Read limits are typically higher than write limits.",
                "schema": {
                  "type": "integer",
                  "format": "int32"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "The number of requests remaining in the current time window. When this reaches 0, subsequent requests will receive a 429 response.",
                "schema": {
                  "type": "integer",
                  "format": "int32"
                }
              },
              "X-RateLimit-Reset": {
                "description": "The UTC epoch timestamp (in seconds) when the current rate limit window resets.",
                "schema": {
                  "type": "integer",
                  "format": "int64"
                }
              }
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/V3ProblemDetails"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "type": {
                          "enum": [
                            "https://apidocs.document360.io/apidocs/errors/too-many-requests"
                          ],
                          "type": "string",
                          "description": "RFC 7807 error type URI. Always `https://apidocs.document360.io/apidocs/errors/too-many-requests` for 429 responses."
                        },
                        "status": {
                          "enum": [
                            429
                          ],
                          "type": "integer",
                          "description": "HTTP status code. Always `429` for this response.",
                          "format": "int32"
                        }
                      }
                    }
                  ]
                },
                "examples": {
                  "Rate limit exceeded": {
                    "summary": "Rate limit exceeded.",
                    "value": {
                      "type": "https://apidocs.document360.io/apidocs/errors/too-many-requests",
                      "title": "Too Many Requests.",
                      "status": 429,
                      "detail": "Rate limit exceeded. Retry after the duration specified in the Retry-After header.",
                      "instance": null,
                      "trace_id": "req_abc123def456",
                      "errors": [
                        {
                          "code": "TOO_MANY_REQUESTS",
                          "message": "Rate limit exceeded. Retry after the duration specified in the Retry-After header.",
                          "field": null,
                          "details": null
                        }
                      ],
                      "warnings": null
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "An unexpected server error occurred.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/V3ProblemDetails"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "type": {
                          "enum": [
                            "https://apidocs.document360.io/apidocs/errors/internal-server-error"
                          ],
                          "type": "string",
                          "description": "RFC 7807 error type URI. Always `https://apidocs.document360.io/apidocs/errors/internal-server-error` for 500 responses."
                        },
                        "status": {
                          "enum": [
                            500
                          ],
                          "type": "integer",
                          "description": "HTTP status code. Always `500` for this response.",
                          "format": "int32"
                        }
                      }
                    }
                  ]
                },
                "examples": {
                  "Unexpected server error": {
                    "summary": "Unexpected server error.",
                    "value": {
                      "type": "https://apidocs.document360.io/apidocs/errors/internal-server-error",
                      "title": "Internal Server Error.",
                      "status": 500,
                      "detail": "An unexpected error occurred. Please try again or contact support.",
                      "instance": null,
                      "trace_id": "req_abc123def456",
                      "errors": [
                        {
                          "code": "INTERNAL_SERVER_ERROR",
                          "message": "An unexpected error occurred.",
                          "field": null,
                          "details": null
                        }
                      ],
                      "warnings": null
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "ApiKey": []
          },
          {
            "Bearer": [
              "customerApi"
            ]
          }
        ],
        "x-premium": true,
        "x-premium-endpoint-key": "readers.post"
      }
    }
  },
  "components": {
    "parameters": {
      "ProjectId": {
        "name": "project_id",
        "in": "path",
        "description": "The unique identifier of the project. Retrieve project IDs from `GET /v3/projects`.",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uuid",
          "example": "9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d"
        }
      }
    },
    "schemas": {
      "CreateReaderRequest": {
        "required": [
          "access_scope",
          "email"
        ],
        "type": "object",
        "properties": {
          "first_name": {
            "maxLength": 256,
            "minLength": 0,
            "type": "string",
            "description": "First name of the reader.",
            "nullable": true
          },
          "last_name": {
            "maxLength": 256,
            "minLength": 0,
            "type": "string",
            "description": "Last name of the reader.",
            "nullable": true
          },
          "email": {
            "maxLength": 256,
            "minLength": 0,
            "type": "string",
            "description": "Email address of the reader to invite. Must be unique.",
            "format": "email",
            "example": "reader@example.com"
          },
          "associated_reader_groups": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of reader group IDs to add this reader to. Retrieve group IDs from `GET /v3/projects/{projectId}/readers/groups`.",
            "nullable": true
          },
          "access_scope": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AccessScope"
              }
            ],
            "description": "The access scope defining which content this reader can view."
          },
          "is_sso_user": {
            "type": "boolean",
            "description": "Whether the reader authenticates via SSO instead of email/password. When true, you must also provide SchemeName. Retrieve available SSO schemes from `GET /v3/projects/{projectId}/sso-schemes`."
          },
          "scheme_name": {
            "type": "string",
            "description": "The SSO scheme name to use. Required when IsSsoUser is true. Retrieve available scheme names from `GET /v3/projects/{projectId}/sso-schemes`.",
            "nullable": true
          },
          "skip_sso_invitation_email": {
            "type": "boolean",
            "description": "Whether to skip sending the SSO invitation email to the reader."
          },
          "invited_by": {
            "type": "string",
            "description": "User ID of the user sending the invitation. Required for API key (M2M) authentication. When using a user access token (OAuth), this field is ignored — the user ID is resolved from the token. Retrieve user IDs from `GET /v3/projects/{projectId}/users`.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Request to invite a new reader to the knowledge base."
      },
      "ReaderResponseApiResponse": {
        "required": [
          "data",
          "request_id",
          "success"
        ],
        "type": "object",
        "properties": {
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ReaderResponse"
              }
            ],
            "description": "Response data payload."
          },
          "success": {
            "type": "boolean",
            "description": "Whether the API request was successful.",
            "readOnly": true
          },
          "request_id": {
            "minLength": 1,
            "type": "string",
            "description": "Unique identifier for request tracing and correlation.",
            "readOnly": true
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ApiError"
            },
            "description": "List of errors if the request failed.",
            "nullable": true
          },
          "warnings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ApiWarning"
            },
            "description": "List of non-fatal warnings from the request.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Generic API response wrapper containing typed data."
      },
      "V3ProblemDetails": {
        "required": [
          "status",
          "title",
          "type"
        ],
        "type": "object",
        "properties": {
          "type": {
            "minLength": 1,
            "enum": [
              "https://apidocs.document360.io/apidocs/errors/bad-request",
              "https://apidocs.document360.io/apidocs/errors/unauthorized",
              "https://apidocs.document360.io/apidocs/errors/forbidden",
              "https://apidocs.document360.io/apidocs/errors/resource-not-found",
              "https://apidocs.document360.io/apidocs/errors/conflict",
              "https://apidocs.document360.io/apidocs/errors/validation-error",
              "https://apidocs.document360.io/apidocs/errors/too-many-requests",
              "https://apidocs.document360.io/apidocs/errors/internal-server-error"
            ],
            "type": "string",
            "description": "URI reference identifying the error type (links to documentation)."
          },
          "title": {
            "minLength": 1,
            "type": "string",
            "description": "Short human-readable summary of the error type."
          },
          "status": {
            "enum": [
              400,
              401,
              403,
              404,
              409,
              422,
              429,
              500
            ],
            "type": "integer",
            "description": "HTTP status code.",
            "format": "int32"
          },
          "detail": {
            "type": "string",
            "description": "Human-readable explanation specific to this occurrence.",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "description": "URI of the request that generated the error.",
            "nullable": true
          },
          "trace_id": {
            "type": "string",
            "description": "Request trace identifier for correlation.",
            "nullable": true
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ApiError"
            },
            "description": "Structured list of specific errors (extension field).",
            "nullable": true
          },
          "warnings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ApiWarning"
            },
            "description": "Non-fatal warnings (extension field).",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "RFC 7807 Problem Details response for V3 API errors.\r\nContent-Type: application/problem+json"
      },
      "AccessScope": {
        "type": "object",
        "properties": {
          "access_level": {
            "enum": [
              "none",
              "category",
              "version",
              "project",
              "language",
              "article",
              "workspace"
            ],
            "type": "string",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccessScopeLevel"
              }
            ],
            "description": "The level at which access is scoped.",
            "x-enumNames": [
              "None",
              "Category",
              "Version",
              "Project",
              "Language",
              "Article",
              "Workspace"
            ],
            "x-enum-varnames": [
              "None",
              "Category",
              "Version",
              "Project",
              "Language",
              "Article",
              "Workspace"
            ],
            "x-ms-enum": {
              "name": "AccessScopeLevel",
              "modelAsString": true
            }
          },
          "categories": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CategoryScope"
            },
            "description": "List of specific category scopes when AccessLevel is Category (1). Null or empty for broader access levels.",
            "nullable": true
          },
          "workspaces": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of workspace IDs the reader has access to when AccessLevel is Workspace (2). Retrieve workspace IDs from `GET /v3/projects/{projectId}/workspaces`.",
            "nullable": true
          },
          "languages": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LanguageScope"
            },
            "description": "List of language scopes defining which translations the reader can access. Applicable when AccessLevel is Language (4).",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Defines the content access scope for a reader or reader group, specifying which versions, categories, and languages they can access."
      },
      "ReaderResponse": {
        "required": [
          "email",
          "id",
          "is_invite_sso_user"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier of the reader.",
            "format": "uuid",
            "nullable": true,
            "readOnly": true,
            "example": "9a3b4c5d-6e7f-8a9b-0c1d-2e3f4a5b6c7d"
          },
          "first_name": {
            "type": "string",
            "description": "First name of the reader.",
            "nullable": true
          },
          "last_name": {
            "type": "string",
            "description": "Last name of the reader.",
            "nullable": true
          },
          "email": {
            "type": "string",
            "description": "Email address of the reader.",
            "format": "email",
            "nullable": true,
            "example": "reader@example.com"
          },
          "access_scope": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AccessScope"
              }
            ],
            "description": "The access scope defining which content this reader can view.",
            "nullable": true
          },
          "associated_reader_groups": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of reader group IDs that this reader belongs to. Retrieve group IDs from `GET /v3/projects/{projectId}/readers/groups`.",
            "nullable": true
          },
          "is_invite_sso_user": {
            "type": "boolean",
            "description": "Whether this reader was invited via SSO authentication."
          },
          "last_login_at": {
            "type": "string",
            "description": "Date and time when the reader last logged in. Null if the reader has never logged in.",
            "format": "date-time",
            "nullable": true,
            "readOnly": true
          }
        },
        "additionalProperties": false,
        "description": "Represents a reader (external user) who has access to the knowledge base."
      },
      "ApiError": {
        "required": [
          "code",
          "message"
        ],
        "type": "object",
        "properties": {
          "code": {
            "minLength": 1,
            "enum": [
              "BAD_REQUEST",
              "CONFLICT",
              "FEATURE_NOT_IN_LICENSE",
              "FORBIDDEN",
              "INTERNAL_SERVER_ERROR",
              "LICENSE_LIMIT_EXCEEDED",
              "OPERATION_FAILED",
              "PREMIUM_FEATURE_NOT_IN_LICENSE",
              "RESOURCE_NOT_FOUND",
              "TOO_MANY_REQUESTS",
              "UNAUTHORIZED",
              "UNRECOGNIZED_FIELD",
              "UNRECOGNIZED_FIELDS",
              "VALIDATION_ERROR"
            ],
            "type": "string",
            "description": "Machine-readable error code (e.g. VALIDATION_ERROR, RESOURCE_NOT_FOUND)."
          },
          "message": {
            "minLength": 1,
            "type": "string",
            "description": "Human-readable error message."
          },
          "field": {
            "type": "string",
            "description": "The request field that caused the error, if applicable.",
            "nullable": true
          },
          "details": {
            "type": "string",
            "description": "Additional context about the error.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Represents an error returned by the API."
      },
      "ApiWarning": {
        "required": [
          "code",
          "message"
        ],
        "type": "object",
        "properties": {
          "code": {
            "minLength": 1,
            "type": "string",
            "description": "Machine-readable warning code."
          },
          "message": {
            "minLength": 1,
            "type": "string",
            "description": "Human-readable warning message."
          }
        },
        "additionalProperties": false,
        "description": "Represents a non-fatal warning from the API."
      },
      "AccessScopeLevel": {
        "enum": [
          "none",
          "category",
          "version",
          "project",
          "language",
          "article",
          "workspace"
        ],
        "type": "string",
        "description": "The level at which content access is scoped for readers and reader groups.",
        "x-enumNames": [
          "None",
          "Category",
          "Version",
          "Project",
          "Language",
          "Article",
          "Workspace"
        ],
        "x-enum-varnames": [
          "None",
          "Category",
          "Version",
          "Project",
          "Language",
          "Article",
          "Workspace"
        ],
        "x-ms-enum": {
          "name": "AccessScopeLevel",
          "modelAsString": true
        }
      },
      "CategoryScope": {
        "type": "object",
        "properties": {
          "workspace_id": {
            "type": "string",
            "description": "Unique identifier of the workspace containing the category. Retrieve from `GET /v3/projects/{projectId}/workspaces`.",
            "nullable": true
          },
          "category_id": {
            "type": "string",
            "description": "Unique identifier of the category to grant access to. Retrieve from `GET /v3/projects/{projectId}/categories`.",
            "nullable": true
          },
          "lang_code": {
            "type": "string",
            "description": "Language code for the category translation (e.g., \"en\", \"fr\", \"de\"). Retrieve available languages from `GET /v3/projects/{projectId}/languages`.",
            "nullable": true,
            "example": "en"
          }
        },
        "additionalProperties": false,
        "description": "Specifies access to a specific category within a workspace and language."
      },
      "LanguageScope": {
        "type": "object",
        "properties": {
          "workspace_id": {
            "type": "string",
            "description": "Unique identifier of the workspace. Retrieve from `GET /v3/projects/{projectId}/workspaces`.",
            "nullable": true
          },
          "lang_code": {
            "type": "string",
            "description": "Language code to grant access to (e.g., \"en\", \"fr\", \"de\"). Retrieve available languages from `GET /v3/projects/{projectId}/languages`.",
            "nullable": true,
            "example": "en"
          }
        },
        "additionalProperties": false,
        "description": "Specifies access to a specific language within a workspace."
      }
    },
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "description": "API key for machine-to-machine integrations, webhooks, and CI/CD (recommended). This is a static, pre-shared secret - treat it as an opaque string and do not parse it; it is an API key, not an OAuth 2.0 access token. Create one in the portal under **Settings > Knowledge base portal > API keys** using the **Create API key** button - this is a different credential from the V1/V2 *API token*, which lives on its own screen and will not authenticate a V3 request. The plaintext key (format `d360_sk_...`) is shown only once, at creation. Send it in the `X-API-Key` header: `X-API-Key: d360_sk_...`. Each key carries a fixed portal role, content role, and content-access scope, supports an optional expiry, and can be disabled or deleted at any time from the portal.",
        "name": "X-API-Key",
        "in": "header"
      },
      "Bearer": {
        "type": "oauth2",
        "description": "All V3 endpoints require a Bearer token. Generate tokens in the Document360 portal under **Settings > API Tokens**. Tokens are project-scoped, require the `customerApi` scope, and do not expire by default. Tokens can be revoked at any time from the portal. Include the token in every request: `Authorization: Bearer <your-token>`. Alternatively, use the Authorize button below to sign in via OAuth2 Authorization Code flow with PKCE.",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://identity.document360.io/connect/authorize",
            "tokenUrl": "https://identity.document360.io/connect/token",
            "scopes": {
              "openid": "OpenID Connect",
              "profile": "User profile",
              "email": "User email",
              "customerApi": "Document360 Customer API"
            },
            "x-usePkce": {
              "disableManualConfiguration": true,
              "hideClientSecretInput": true
            }
          }
        },
        "x-d360-clientId": "apiHubWebClient"
      }
    }
  }
}
````