{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Franklin API","description":"Reference, guides and recipes for the Franklin API — create cases, link sample files, retrieve variants and reports."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"franklin-api","__idx":0},"children":["Franklin API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Franklin API lets your systems do programmatically what your team does in Franklin: register cases, link sequencing files, follow analysis progress, pull variants and QC, and retrieve signed reports."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Access"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["API access is enabled per organization. Contact your Franklin representative or ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"mailto:support@genoox.com"},"children":["support@genoox.com"]}," to enable it and to get your organization's API endpoint."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"quick-start","__idx":1},"children":["Quick start"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["1. Get a token."]}," Every call needs a Bearer token from the login endpoint. Tokens are valid for 24 hours."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \"https://api.genoox.com/v1/auth/login\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"email\": \"you@example.com\", \"password\": \"your_password\"}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{ \"token\": \"eyJhbGciOiJIUzI1NiIs...\", \"duration\": 86400, \"expires_at\": 1704153600 }\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["2. Call the API"]}," with the token in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl \"https://api.genoox.com/v1/analysis?analysis_id=12345\" \\\n  -H \"Authorization: Bearer $FRANKLIN_TOKEN\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["3. Handle errors."]}," Failures return an HTTP status and a JSON body with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]},". See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/errors"},"children":["Errors"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"typical-integrations","__idx":2},"children":["Typical integrations"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"You want to…"},"children":["You want to…"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Start here"},"children":["Start here"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a case from your LIMS and attach the VCF/FASTQ files"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/recipes/shell-case-and-link-files"},"children":["Create a shell case and link its files"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Know when a case is ready for review"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/recipes/track-analysis-status"},"children":["Track analysis status"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pull the reviewed variants and the signed report back"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/recipes/workbench-to-signed-report"},"children":["From workbench to signed report"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Look up a variant or your lab's previous classification"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/recipes/variant-lookup"},"children":["Variant lookup"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Download BAM/VCF files, QC metrics or exports"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/recipes/download-case-files"},"children":["Download case files and QC"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-the-api-covers","__idx":3},"children":["What the API covers"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Area"},"children":["Area"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What it does"},"children":["What it does"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api/openapi/authentication"},"children":["Authentication"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Log in and obtain a token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api/openapi/shell-case"},"children":["Shell case"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api/openapi/analysis-creation"},"children":["Analysis creation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create cases, with or without files, and link files later"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api/openapi/analysis"},"children":["Analysis"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api/openapi/analysis-list"},"children":["Analysis list"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api/openapi/samples"},"children":["Samples"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read and update case details, search cases and samples"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api/openapi/analysis-status"},"children":["Analysis status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Processing and workflow status for up to 100 cases per call"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api/openapi/analysis-query"},"children":["Analysis query"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Workbench, SNP and SV variants, somatic workbench, biomarkers"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api/openapi/variant-search"},"children":["Variant search"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Nomenclature, full annotation and your organization's classifications"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api/openapi/reports"},"children":["Reports"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Generate, publish, list and download reports"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api/openapi/file-locations"},"children":["File locations"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api/openapi/qc-metrics"},"children":["QC metrics"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api/openapi/analysis-export"},"children":["Analysis export"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Download links for BAM/VCF, QC values, exports"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api/openapi/case-orders"},"children":["Case orders"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rename case orders and copy them as skeletons"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"versions","__idx":4},"children":["Versions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These docs are published per Franklin release. Use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Version"]}," picker in the API reference to match the release your organization runs. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/versions"},"children":["Versions"]}," for how documentation versions relate to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v1"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v2"]}," in endpoint paths."]}]},"headings":[{"value":"Franklin API","id":"franklin-api","depth":1},{"value":"Quick start","id":"quick-start","depth":2},{"value":"Typical integrations","id":"typical-integrations","depth":2},{"value":"What the API covers","id":"what-the-api-covers","depth":2},{"value":"Versions","id":"versions","depth":2}],"frontmatter":{"seo":{"title":"Franklin API"}},"lastModified":"2026-09-30T21:18:36.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}