{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-v1/index.yaml","sidebar":"sidebar-sidebars.yaml"},"props":{"definitionId":"v1/index.yaml","dynamicMarkdocComponents":[],"baseSlug":"/v1","seo":{"title":"HoxtonAi API","llmstxt":{"hide":true}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"HoxtonAi API","description":"# Authentication\n\nAll API requests are authenticated with a Hoxton **API key**, passed as a\nBearer token in the `Authorization` header of every request:\n\n```\nAuthorization: Bearer hxt_live_<prefix>.<secret>\n```\n\n## Creating an API key\n\nCreate and manage API keys for your organisation from your dashboard settings\nat [https://nexus.hoxton.ai/my-org/api-keys](https://nexus.hoxton.ai/my-org/api-keys), or\nprogrammatically via the `/api-keys` endpoints documented below.\n\nThe secret is shown **once**, at creation time — store it securely, as it\ncannot be retrieved afterwards. Each key belongs to a single organisation and\nis scoped to that organisation's data.\n\n## Using an API key\n\n```shell\ncurl https://nexus.hoxton.ai/api/v1/organisations \\\n  -H 'Authorization: Bearer hxt_live_<prefix>.<secret>'\n```\n\n## Expiry and revocation\n\nA key may be created with an optional expiry. Keys can be revoked at any time\nfrom the dashboard or via `DELETE /api-keys/{apiKeyId}`; a revoked or expired\nkey is rejected immediately on subsequent requests.\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"coreapi.hoxton.ai","port":4000,"ipAddress":"216.73.217.36"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/v1","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}