{"removeAttribution":false,"l10n":{"translations":{"default_locale":{"translation":{}}},"defaultLocale":"default_locale","locales":[{"code":"default_locale","name":"default_locale"}]},"navbar":{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Getting started","link":"/","routeSlug":"/"},{"type":"link","fsPath":"docs/recipes/index.md","metadata":{"type":"markdown"},"label":"Recipes","link":"/docs/recipes","routeSlug":"/docs/recipes"},{"type":"link","fsPath":"docs/api/@v96/openapi.yaml","metadata":{"type":"openapi","title":"Franklin API","version":"96","description":"The Franklin API allows you to programmatically access and manage genomic analyses\nin your Franklin account.\n\n## Getting Started\n\nTo use this API, you'll need:\n1. A Franklin account with API access enabled\n2. Your organization's API endpoint URL\n\nContact your Franklin representative to enable API access for your account.\n\n## Authentication\n\n### Step 1: Obtain an API Token\n\nBefore making any API requests, you must first authenticate using the `/v1/auth/login` endpoint\nto obtain a Bearer token. This token is required for all subsequent API calls.\n\n```bash\ncurl -X GET \"https://api.genoox.com/v1/auth/login?email=your@email.com\" \\\n  -H \"Authorization: your_password\"\n```\n\nThe response will include a token and its expiration time:\n```json\n{\n  \"token\": \"eyJhbGciOiJIUzI1NiIs...\",\n  \"duration\": 86400,\n  \"expires_at\": 1704067200\n}\n```\n\n### Step 2: Use the Token for API Requests\n\nInclude the token in the Authorization header for all subsequent requests:\n\n```\nAuthorization: Bearer YOUR_API_TOKEN\n```\n\n**Note:** Tokens expire after the duration specified in the login response.\nYou should re-authenticate before the token expires to maintain uninterrupted access.\n"},"label":"API reference","link":"/docs/api/openapi","routeSlug":"/docs/api/openapi","version":"v96","isDefault":true,"versionFolderId":"50d32dbd"}]},"footer":{"copyrightText":"Copyright © Genoox. All rights reserved.","items":[{"type":"group","label":"Franklin","items":[{"type":"link","link":"https://franklin.genoox.com","label":"Franklin"},{"type":"link","link":"mailto:support@genoox.com","label":"Support"}]}]},"markdown":{"partialsFolders":["**/_partials/**"]},"openapi":{"jsonSamplesExpandLevel":2,"generatedSamplesMaxDepth":8,"codeSamples":{"languages":[{"lang":"curl"},{"lang":"Python"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Java"},{"lang":"C#"}]}},"breadcrumbs":{"prefixItems":[]},"userMenu":{"hide":true},"logo":{},"auth":{"idpsInfo":[]},"search":{},"entitiesCatalog":{},"apiProducts":{},"mcpData":{"docs":{"enabled":true,"name":"Docs MCP server","publicEndpoint":false}},"searchFeatures":{"advanced":{"enabled":false},"ai":{"enabled":true}},"analytics":{"ga":{"trackingId":"","exclude":[],"trackers":{}}}}