Places a credit hold, creates the session and queues it for processing. Responds immediately with the session in queued state; you are notified through a webhook (session.processed / session.failed) when it finishes, or you can poll GET /v1/sessions/{id}.
Send an Idempotency-Key header to make retries safe: the same key with the same body returns the original response for 24 hours.
Any string up to 255 characters. Replaying the same key with the same body within 24h returns the original response; a different body returns 400 idempotency_key_reused.
Where the video comes from. type is optional — it is derived from the URL (a Veo link is always routed to Veo), and a body with parts is a parts source.
Describes how the video was recorded. Every field is optional. camera_setup, jerseys, session_mode and session_type change how the video is analysed. The others are saved with the session but do not change the results the API returns. Values are case-sensitive; anything outside the listed values is rejected with 400 parameter_invalid, and param names the field.
Your own images on the processed video. Both are optional and work with every source type. A branded video is always encoded at 1920×1080; a portrait recording gets black bars at the sides. The session object's branding field shows which images a session carries.
Each team's players. Hooper matches the players it detects to a side's roster by jersey number, so they come back in players with your name and metadata, and players[].team_id follows your sides (1 = recording, 2 = opponent). Send one side or both; an empty object is refused with 400 and param: rosters. Rosters need jersey numbers: they can't be sent with options.jerseys: "disabled" (400, param: options.jerseys), and with the default auto Hooper decides from the video (and keeps reading numbers if it can't tell); send enabled when you know players wear them. See Rosters.
Show child attributes
Response
Session queued
One submitted game. The same shape everywhere it appears — single read, list item, webhook payload. Highlights, shots and players are embedded (first 100 of each); their url pages the rest.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hooper API","description":"Basketball video analytics: submit a game, get back highlights, shots and box scores.","colors":{"primary":"#5040FF","light":"#7B6FFF","dark":"#3A2DD6"},"logo":{"light":"https://mintcdn.com/hooper/tJj0DWSVCp1VND09/logo/light.svg?fit=max\u0026auto=format\u0026n=tJj0DWSVCp1VND09\u0026q=85\u0026s=c202803e7c4b6fd5c5258ad6ffc3f076","dark":"https://mintcdn.com/hooper/tJj0DWSVCp1VND09/logo/dark.svg?fit=max\u0026auto=format\u0026n=tJj0DWSVCp1VND09\u0026q=85\u0026s=f8301f46230cf531dbf3abe4fbe31573","href":"https://hooper.gg"},"favicon":"https://mintcdn.com/hooper/tJj0DWSVCp1VND09/favicon.svg?fit=max\u0026auto=format\u0026n=tJj0DWSVCp1VND09\u0026q=85\u0026s=e79f65ee8011c10f3ecdca4d13dea1ce","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","python","javascript"]}},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://hooper.gg","label":"Hooper"},{"href":"https://www.hooper.gg/api/pricing","label":"Pricing"},{"href":"mailto:support@hooper.gg","label":"Support"}]},"footer":{"socials":{"website":"https://hooper.gg"}},"fonts":{"family":"Inter"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hooper","hasAudioNarration":false,"actualSubdomain":"hooper","customDomains":["developer.hooper.gg"],"gitSource":{"type":"github","owner":"hooper-ai","repo":"hooper-ai","deployBranch":"main","contentDirectory":"docs/api","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aec181db4a9a5921893f4b5","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":21},{"language":"default","tag":"Guides","count":8},{"language":"default","tag":"Sessions","count":6},{"language":"default","tag":"Webhooks","count":5},{"language":"default","tag":"Core concepts","count":4},{"language":"default","tag":"Getting started","count":3},{"language":"default","tag":"Billing","count":3},{"language":"default","tag":"Events","count":2},{"language":"default","tag":"Integrations","count":1},{"language":"default","tag":"Uploads","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/sessions/submit-a-video","slug":"/api-reference/sessions/submit-a-video","pageMetadata":{"title":"Submit a video","description":"Places a credit hold, creates the session and queues it for processing. Responds immediately with the session in `queued` state; you are notified through a webhook (`session.processed` / `session.failed`) when it finishes, or you can poll `GET /v1/sessions/{id}`.\n\nSend an `Idempotency-Key` header to make retries safe: the same key with the same body returns the original response for 24 hours.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sessions","href":"/api-reference/sessions/submit-a-video","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Places a credit hold, creates the session and queues it for processing. Responds immediately with the session in \", _jsx(_components.code, {\n children: \"queued\"\n }), \" state; you are notified through a webhook (\", _jsx(_components.code, {\n children: \"session.processed\"\n }), \" / \", _jsx(_components.code, {\n children: \"session.failed\"\n }), \") when it finishes, or you can poll \", _jsx(_components.code, {\n children: \"GET /v1/sessions/{id}\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Send an \", _jsx(_components.code, {\n children: \"Idempotency-Key\"\n }), \" header to make retries safe: the same key with the same body returns the original response for 24 hours.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Submit a video","description":"Places a credit hold, creates the session and queues it for processing. Responds immediately with the session in `queued` state; you are notified through a webhook (`session.processed` / `session.failed`) when it finishes, or you can poll `GET /v1/sessions/{id}`.\n\nSend an `Idempotency-Key` header to make retries safe: the same key with the same body returns the original response for 24 hours.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sessions","href":"/api-reference/sessions/submit-a-video","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Sessions"],"operationId":"createSession","summary":"Submit a video","description":"Places a credit hold, creates the session and queues it for processing. Responds immediately with the session in `queued` state; you are notified through a webhook (`session.processed` / `session.failed`) when it finishes, or you can poll `GET /v1/sessions/{id}`.\n\nSend an `Idempotency-Key` header to make retries safe: the same key with the same body returns the original response for 24 hours.","parameters":["eb2a0328-c7e2-4c8f-834e-1056808ef26a"],"requestBody":"f6e1b60b-4e09-4936-b737-47d7bc9ba213","responses":{"201":"f562ee60-0261-42aa-8728-4f6e4a44c4ed","400":"7ef2fc24-f8cf-4f60-a135-641fc79e4dd9","401":"6e13480e-7355-4d66-ace8-f36e7ebae8cc","402":"b6e5a0ea-9fd5-4cfa-9396-395e0d06f4bb","409":"c7ab3db0-bd63-4daa-8710-fce71fe1c0ea","429":"636353c9-ef34-413e-a738-432a5306721f"},"method":"post","type":"path","servers":["0820b8ad-481b-42ce-b930-f545370c7399"],"security":["b92e9908-8824-4d13-95d0-5099f9596508"],"path":"/v1/sessions","baseUrlOptions":["https://api.hooper.gg"],"title":"Submit a video","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"eb2a0328-c7e2-4c8f-834e-1056808ef26a":{"name":"Idempotency-Key","in":"header","required":false,"description":"Any string up to 255 characters. Replaying the same key with the same body within 24h returns the original response; a different body returns 400 `idempotency_key_reused`.","schema":{"type":"string","isRequired":false,"description":"Any string up to 255 characters. Replaying the same key with the same body within 24h returns the original response; a different body returns 400 `idempotency_key_reused`.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["source"],"properties":{"source":{"type":"object","description":"Where the video comes from. `type` is optional — it is derived from the URL (a Veo link is always routed to Veo), and a body with `parts` is a `parts` source.","properties":{"type":{"type":"string","enum":["upload","url","veo","parts"],"uniqueKey":"source.type","typeLabel":"enum\u003cstring>"},"upload_id":{"type":"string","description":"For `upload`: the id from POST /v1/uploads.","example":"up_3f9a1c2b7e5d4a08","uniqueKey":"source.upload_id","typeLabel":"string"},"url":{"type":"string","description":"For `url` (a public https MP4/MOV) or `veo` (a public Veo match page or CDN link).","example":"https://app.veo.co/matches/20260826-acme-vs-north/","uniqueKey":"source.url","typeLabel":"string"},"parts":{"type":"array","minItems":2,"maxItems":10,"items":{"type":"object","additionalProperties":false,"description":"One of several videos: the same fields and rules as a single `source`, and refused with the same errors, with `param` naming the part (`source.parts.1.upload_id`). Unknown fields are refused.","properties":{"type":{"type":"string","enum":["upload","url","veo"],"uniqueKey":"source.parts.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"upload_id":{"type":"string","description":"For `upload`: the id from POST /v1/uploads.","example":"up_3f9a1c2b7e5d4a08","uniqueKey":"source.parts.items.[INDEX].upload_id","typeLabel":"string"},"url":{"type":"string","description":"For `url` (a public https MP4/MOV) or `veo` (a public Veo match page or CDN link).","example":"https://cdn.example.com/games/2026-08-26-second-half.mp4","uniqueKey":"source.parts.items.[INDEX].url","typeLabel":"string"}},"uniqueKey":"source.parts.items.[INDEX]","typeLabel":"object"},"description":"For `parts`: one game recorded as several videos, in play order, joined into one session. Not sent with `upload_id` or `url`. Each part at most 1080p, all parts together at most 10 GB.","uniqueKey":"source.parts","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"source","typeLabel":"object"},"group":{"type":"string","description":"A group under your organization. Omit it and the session lands in your organization's own private group.","example":"grp_412","uniqueKey":"group","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"description":"Up to 20 string key/values (keys ≤ 40 chars, values ≤ 500). Echoed on the session and inside every event — use it to carry your own ids.","example":{"external_match_id":"abc-123"},"uniqueKey":"metadata","typeLabel":"object"},"options":{"type":"object","description":"Describes how the video was recorded. Every field is optional. `camera_setup`, `jerseys`, `session_mode` and `session_type` change how the video is analysed. The others are saved with the session but do not change the results the API returns. Values are case-sensitive; anything outside the listed values is rejected with `400 parameter_invalid`, and `param` names the field.","properties":{"session_type":{"type":"string","enum":["solo","1v1","2v2","3v3","4v4","5v5"],"default":"5v5","description":"The game format.\n\n- `solo`: one player\n- `1v1`, `2v2`, `3v3`, `4v4`, `5v5`: players per side\n\nWhen `session_mode` is `game` or `practice`, it also sets the default `num_players`, and turns on free-throw detection for `3v3`, `4v4` and `5v5`.","uniqueKey":"options.session_type","typeLabel":"enum\u003cstring>"},"session_mode":{"type":"string","enum":["game","practice","shootaround"],"default":"game","description":"What kind of session this is.\n\n- `game`: two teams playing each other. The session is split into two teams, named by `recording_team_name` and `opponent_team_name`.\n- `practice`: a practice session. Same analysis as a game, without the two-team split.\n- `shootaround`: a shooting workout. No teams, no free-throw detection, and no default `num_players`.","uniqueKey":"options.session_mode","typeLabel":"enum\u003cstring>"},"camera_setup":{"type":"string","enum":["stationary","panning"],"default":"stationary","description":"Whether the camera moves during the recording. It decides where Hooper looks for the hoop.\n\n- `stationary`: the camera stays still with the hoop in the upper middle of the frame, as the Hooper app frames it. Hooper looks for the hoop **only** in that area: roughly the middle third of the frame horizontally, and the top half vertically.\n- `panning`: the camera moves to follow the play (handheld, or an auto-tracking camera). Hooper searches the whole frame.\n\nIf the hoop sits anywhere else in the frame, send `panning`. Otherwise no hoop is found and the session fails with `no_hoops`.","uniqueKey":"options.camera_setup","typeLabel":"enum\u003cstring>"},"jerseys":{"type":"string","enum":["auto","enabled","disabled"],"default":"auto","description":"Whether Hooper reads jersey numbers to tell players apart. Reading them fills in `players[].jersey` and lets a `roster` be matched.\n\n- `auto`: Hooper looks at five frames and decides whether the players wear numbered team uniforms. If it can't tell, it doesn't read numbers (unless you sent a `roster`).\n- `enabled`: always read numbers. Use it when you know the players wear them; recommended with a `roster`.\n- `disabled`: never read numbers, and tell players apart by how they look. Use it for pickup games, or bibs without numbers.\n\nWhen numbers are read, an action where the number couldn't be read isn't credited to any player, and a number has to be read on at least two actions to become a player. See [Jerseys](/sessions#jerseys).","uniqueKey":"options.jerseys","typeLabel":"enum\u003cstring>"},"has_jerseys":{"type":"boolean","deprecated":true,"description":"Deprecated: use `jerseys`. `true` means `enabled`, `false` means `disabled`. A request with both is refused with `400` and `param: options`.","uniqueKey":"options.has_jerseys","typeLabel":"boolean"},"court_type":{"type":"string","enum":["high_school","ncaa_women","ncaa_men","fiba","wnba","nba"],"default":"ncaa_men","description":"The court markings the game was played on, which set the 3-point line distance. Saved with the session; it does not change the results the API returns. A shot's `is_three_point` comes from the video analysis.","uniqueKey":"options.court_type","typeLabel":"enum\u003cstring>"},"point_system":{"type":"integer","enum":[1,2,3],"default":1,"description":"How baskets were scored.\n\n- `1`: 2s and 3s (standard)\n- `2`: 1s and 2s (a basket inside the arc is worth 1, beyond it 2)\n- `3`: every basket is worth 1\n\nSaved with the session. The API's shot `points` and `totals` always use standard scoring: 2 or 3 points per basket, 1 per free throw.","uniqueKey":"options.point_system","typeLabel":"enum\u003cinteger>"},"recording_setup":{"type":"string","enum":["tripod","ground"],"default":"tripod","description":"Where the camera was placed.\n\n- `tripod`: on a tripod or another raised mount\n- `ground`: low to the floor, such as a phone propped against a bottle\n\nSaved with the session; it does not change the results the API returns.","uniqueKey":"options.recording_setup","typeLabel":"enum\u003cstring>"},"num_players":{"type":"integer","minimum":1,"maximum":10,"description":"How many players are on the court. When `session_mode` is `game` or `practice` it defaults to the count `session_type` implies (for example `5v5` gives 10), so send it only to override that. `shootaround` has no default. Saved with the session; it does not change the results the API returns.","uniqueKey":"options.num_players","typeLabel":"integer"},"model":{"type":"string","enum":["beta","flash"],"default":"flash","description":"The processing pipeline.\n\n- `flash`: the single-pass pipeline\n- `beta`: the earlier pipeline, with the same results format","uniqueKey":"options.model","typeLabel":"enum\u003cstring>"},"recording_team_name":{"type":"string","default":"Team 1","description":"Name of your team. Used only when `session_mode` is `game`. Echoed as `teams.recording.name`. `rosters.recording.name` names the team too; sending both is refused with `400` and `param: options.recording_team_name`.","example":"Acme Varsity","uniqueKey":"options.recording_team_name","typeLabel":"string"},"opponent_team_name":{"type":"string","default":"Team 2","description":"Name of the opposing team. Used only when `session_mode` is `game`. Echoed as `teams.opponent.name`. `rosters.opponent.name` names the team too; sending both is refused with `400` and `param: options.opponent_team_name`.","example":"North High","uniqueKey":"options.opponent_team_name","typeLabel":"string"}},"uniqueKey":"options","typeLabel":"object"},"branding":{"type":"object","description":"Your own images on the processed video. Both are optional and work with every `source` type. A branded video is always encoded at 1920×1080; a portrait recording gets black bars at the sides. The session object's `branding` field shows which images a session carries.","properties":{"cover":{"type":"object","description":"Shown full-frame for the first 5 seconds of `video`, scaled to fill 1920×1080 and center-cropped, so use a 16:9 image (ideally 1920×1080). The cover is part of the processed video: `video`, every shot's `start_seconds` / `end_seconds` and the measured (billed) `duration_seconds` include those 5 seconds.","properties":{"url":{"type":"string","maxLength":2048,"description":"A public `https://` link to the image. At submit only the address is checked (private and link-local addresses are rejected). Hooper downloads the image when it starts processing the session, before the video: it must answer `200` within 15 seconds, with at most 3 redirects. Hooper keeps its own copy with the session, so the URL only needs to serve the image until the session is processed. If the image can't be used, the session fails with `error.code` `image_unavailable`, `image_invalid` or `image_too_large` and `error.param` naming the image.","example":"https://cdn.example.com/brand/logo.png","uniqueKey":"branding.cover.url","typeLabel":"string"},"upload_id":{"type":"string","description":"An image upload from POST /v1/uploads (created with an image `content_type`). It is not used up: send the same id with every session.","example":"up_7c1e4b2a9d3f6e05","uniqueKey":"branding.cover.upload_id","typeLabel":"string"}},"uniqueKey":"branding.cover","typeLabel":"object"},"logo":{"type":"object","description":"A fixed overlay in the lower-right corner of the game footage (not the cover), on `video` and on every highlight. Use a PNG with a transparent background. A landscape logo between about 1.6:1 and 3.6:1 is drawn at most 260×110 px on the 1920×1080 frame, 48 px from the right and 52 px from the bottom; squarer or wider logos are enlarged past that so they still hide the wordmark Veo burns into its exports. On a Veo source, your logo replaces Veo's.","properties":{"url":{"type":"string","maxLength":2048,"description":"A public `https://` link to the image. At submit only the address is checked (private and link-local addresses are rejected). Hooper downloads the image when it starts processing the session, before the video: it must answer `200` within 15 seconds, with at most 3 redirects. Hooper keeps its own copy with the session, so the URL only needs to serve the image until the session is processed. If the image can't be used, the session fails with `error.code` `image_unavailable`, `image_invalid` or `image_too_large` and `error.param` naming the image.","example":"https://cdn.example.com/brand/logo.png","uniqueKey":"branding.logo.url","typeLabel":"string"},"upload_id":{"type":"string","description":"An image upload from POST /v1/uploads (created with an image `content_type`). It is not used up: send the same id with every session.","example":"up_7c1e4b2a9d3f6e05","uniqueKey":"branding.logo.upload_id","typeLabel":"string"}},"uniqueKey":"branding.logo","typeLabel":"object"}},"uniqueKey":"branding","typeLabel":"object"},"rosters":{"type":"object","description":"Each team's players. Hooper matches the players it detects to a side's roster by jersey number, so they come back in `players` with your `name` and `metadata`, and `players[].team_id` follows your sides (`1` = `recording`, `2` = `opponent`). Send one side or both; an empty object is refused with `400` and `param: rosters`. Rosters need jersey numbers: they can't be sent with `options.jerseys: \"disabled\"` (`400`, `param: options.jerseys`), and with the default `auto` Hooper decides from the video (and keeps reading numbers if it can't tell); send `enabled` when you know players wear them. See [Rosters](/sessions#rosters).","properties":{"recording":{"type":"object","description":"Your team.","required":["players"],"properties":{"players":{"type":"array","minItems":1,"maxItems":200,"items":{"type":"object","required":["jersey"],"properties":{"jersey":{"type":"string","pattern":"^\\d{1,3}$","description":"The number on the player's jersey. Hooper matches players by it; `\"7\"` and `\"07\"` are the same number.","example":"23","isRequired":true,"uniqueKey":"rosters.recording.players.items.[INDEX].jersey","typeLabel":"string"},"name":{"type":"string","maxLength":50,"description":"Returned as `players[].name`.","example":"Ana Silva","uniqueKey":"rosters.recording.players.items.[INDEX].name","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rosters.recording.players.items.[INDEX].metadata.additionalProperties","typeLabel":"string"},"description":"Up to 20 string key/values (keys ≤ 40 chars, values ≤ 500). Returned as `players[].metadata`; put your own player id here.","example":{"player_id":"lg-4821"},"uniqueKey":"rosters.recording.players.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"rosters.recording.players.items.[INDEX]","typeLabel":"object"},"description":"The team's players, each with a different number. Two teammates with the same number are refused with `400` and `param: rosters.\u003cside>.players`.","isRequired":true,"uniqueKey":"rosters.recording.players","typeLabel":"object[]"},"name":{"type":"string","description":"The team's name, the same as the matching `recording_team_name` / `opponent_team_name` option; sending both for one side is refused with `400`. Echoed as `teams.\u003cside>.name`.","example":"Acme Varsity","uniqueKey":"rosters.recording.name","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rosters.recording.metadata.additionalProperties","typeLabel":"string"},"description":"Up to 20 string key/values (keys ≤ 40 chars, values ≤ 500). Echoed as `teams.\u003cside>.metadata`; put your own team id here.","example":{"team_id":"lg-t-12"},"uniqueKey":"rosters.recording.metadata","typeLabel":"object"}},"uniqueKey":"rosters.recording","typeLabel":"object"},"opponent":{"type":"object","description":"The opposing team.","required":["players"],"properties":{"players":{"type":"array","minItems":1,"maxItems":200,"items":{"type":"object","required":["jersey"],"properties":{"jersey":{"type":"string","pattern":"^\\d{1,3}$","description":"The number on the player's jersey. Hooper matches players by it; `\"7\"` and `\"07\"` are the same number.","example":"23","isRequired":true,"uniqueKey":"rosters.opponent.players.items.[INDEX].jersey","typeLabel":"string"},"name":{"type":"string","maxLength":50,"description":"Returned as `players[].name`.","example":"Ana Silva","uniqueKey":"rosters.opponent.players.items.[INDEX].name","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rosters.opponent.players.items.[INDEX].metadata.additionalProperties","typeLabel":"string"},"description":"Up to 20 string key/values (keys ≤ 40 chars, values ≤ 500). Returned as `players[].metadata`; put your own player id here.","example":{"player_id":"lg-4821"},"uniqueKey":"rosters.opponent.players.items.[INDEX].metadata","typeLabel":"object"}},"uniqueKey":"rosters.opponent.players.items.[INDEX]","typeLabel":"object"},"description":"The team's players, each with a different number. Two teammates with the same number are refused with `400` and `param: rosters.\u003cside>.players`.","isRequired":true,"uniqueKey":"rosters.opponent.players","typeLabel":"object[]"},"name":{"type":"string","description":"The team's name, the same as the matching `recording_team_name` / `opponent_team_name` option; sending both for one side is refused with `400`. Echoed as `teams.\u003cside>.name`.","example":"Acme Varsity","uniqueKey":"rosters.opponent.name","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"rosters.opponent.metadata.additionalProperties","typeLabel":"string"},"description":"Up to 20 string key/values (keys ≤ 40 chars, values ≤ 500). Echoed as `teams.\u003cside>.metadata`; put your own team id here.","example":{"team_id":"lg-t-12"},"uniqueKey":"rosters.opponent.metadata","typeLabel":"object"}},"uniqueKey":"rosters.opponent","typeLabel":"object"}},"uniqueKey":"rosters","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"source":{"upload_id":"up_3f9a1c2b7e5d4a08","url":"https://app.veo.co/matches/20260826-acme-vs-north/","parts":[{"upload_id":"up_3f9a1c2b7e5d4a08","url":"https://cdn.example.com/games/2026-08-26-second-half.mp4"}]},"group":"grp_412","metadata":{"external_match_id":"abc-123"},"options":{"session_type":"5v5","session_mode":"game","camera_setup":"stationary","jerseys":"auto","has_jerseys":true,"court_type":"ncaa_men","point_system":1,"recording_setup":"tripod","num_players":5,"model":"flash","recording_team_name":"Acme Varsity","opponent_team_name":"North High"},"branding":{"cover":{"url":"https://cdn.example.com/brand/logo.png","upload_id":"up_7c1e4b2a9d3f6e05"},"logo":{"url":"https://cdn.example.com/brand/logo.png","upload_id":"up_7c1e4b2a9d3f6e05"}},"rosters":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f562ee60-0261-42aa-8728-4f6e4a44c4ed":{"description":"Session queued","headers":{"X-Hooper-Cost-Cents":{"description":"Cents held for this job (estimate; corrected when the job settles).","schema":{"type":"integer"}},"X-Hooper-Balance-Cents":{"description":"Available balance after the hold.","schema":{"type":"integer"}},"Idempotent-Replayed":{"description":"Present and `true` when this is a replay of an earlier request with the same Idempotency-Key.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","description":"One submitted game. The same shape everywhere it appears — single read, list item, webhook payload. Highlights, shots and players are embedded (first 100 of each); their `url` pages the rest.","properties":{"id":{"type":"string","example":"sess_18234","uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","const":"session","uniqueKey":"object","typeLabel":"string"},"created":{"type":"integer","example":1756224000,"uniqueKey":"created","typeLabel":"integer"},"status":{"type":"string","enum":["queued","processing","processed","failed"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"group":{"type":"string","example":"grp_412","uniqueKey":"group","typeLabel":"string"},"source":{"type":"object","description":"What was submitted. Each of `parts` has the same shape as a single-video `source`, without `parts`.","properties":{"type":{"type":"string","enum":["upload","url","veo","parts"],"uniqueKey":"source.type","typeLabel":"enum\u003cstring>"},"upload_id":{"oneOf":[{"type":"string","description":"The upload's id for an `upload`; otherwise null.","example":"up_3f9a1c2b7e5d4a08","uniqueKey":"source.upload_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The upload's id for an `upload`; otherwise null.","example":"up_3f9a1c2b7e5d4a08","uniqueKey":"source.upload_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.upload_id","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"The link submitted (for an `upload`, Hooper's storage path); null for `parts`.","uniqueKey":"source.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The link submitted (for an `upload`, Hooper's storage path); null for `parts`.","uniqueKey":"source.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.url","typeLabel":"string | null"},"parts":{"oneOf":[{"type":"array","description":"For `parts`: each video in play order. Null otherwise.","items":{"type":"object","properties":{"type":{"type":"string","enum":["upload","url","veo"],"uniqueKey":"source.parts.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"upload_id":{"oneOf":[{"type":"string","uniqueKey":"source.parts.oneOf.0.items.[INDEX].upload_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"source.parts.oneOf.0.items.[INDEX].upload_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.parts.oneOf.0.items.[INDEX].upload_id","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","uniqueKey":"source.parts.oneOf.0.items.[INDEX].url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"source.parts.oneOf.0.items.[INDEX].url.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.parts.oneOf.0.items.[INDEX].url","typeLabel":"string | null"}},"uniqueKey":"source.parts.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"source.parts.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"For `parts`: each video in play order. Null otherwise.","items":{"type":"object","properties":{"type":{"type":"string","enum":["upload","url","veo"]},"upload_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"url":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"uniqueKey":"source.parts.oneOf.1","typeLabel":"null"}],"uniqueKey":"source.parts","typeLabel":"object[] | null"}},"uniqueKey":"source","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata","typeLabel":"object"},"branding":{"type":"object","description":"Which branding images this session carries. Set when the session is submitted.","properties":{"cover":{"type":"boolean","uniqueKey":"branding.cover","typeLabel":"boolean"},"logo":{"type":"boolean","uniqueKey":"branding.logo","typeLabel":"boolean"}},"uniqueKey":"branding","typeLabel":"object"},"teams":{"type":"object","description":"The two sides of the session, always present. `players[].team_id` `1` is `recording`, `2` is `opponent`.","properties":{"recording":{"type":"object","properties":{"name":{"type":"string","description":"From `rosters.\u003cside>.name` or the `\u003cside>_team_name` option; `Team 1` / `Team 2` when neither was sent.","example":"Acme Varsity","uniqueKey":"teams.recording.name","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"teams.recording.metadata.additionalProperties","typeLabel":"string"},"description":"From `rosters.\u003cside>.metadata`; `{}` when none was sent.","uniqueKey":"teams.recording.metadata","typeLabel":"object"}},"uniqueKey":"teams.recording","typeLabel":"object"},"opponent":{"type":"object","properties":{"name":{"type":"string","description":"From `rosters.\u003cside>.name` or the `\u003cside>_team_name` option; `Team 1` / `Team 2` when neither was sent.","example":"Acme Varsity","uniqueKey":"teams.opponent.name","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"teams.opponent.metadata.additionalProperties","typeLabel":"string"},"description":"From `rosters.\u003cside>.metadata`; `{}` when none was sent.","uniqueKey":"teams.opponent.metadata","typeLabel":"object"}},"uniqueKey":"teams.opponent","typeLabel":"object"}},"uniqueKey":"teams","typeLabel":"object"},"run_version":{"oneOf":[{"type":"integer","uniqueKey":"run_version.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"run_version.oneOf.1","typeLabel":"null"}],"uniqueKey":"run_version","typeLabel":"integer | null"},"duration_seconds":{"oneOf":[{"type":"integer","example":5412,"uniqueKey":"duration_seconds.oneOf.0","typeLabel":"integer"},{"type":"null","example":5412,"uniqueKey":"duration_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"duration_seconds","typeLabel":"integer | null"},"cost_cents":{"oneOf":[{"type":"integer","example":752,"uniqueKey":"cost_cents.oneOf.0","typeLabel":"integer"},{"type":"null","example":752,"uniqueKey":"cost_cents.oneOf.1","typeLabel":"null"}],"uniqueKey":"cost_cents","typeLabel":"integer | null"},"highlights":{"type":"object","required":["object","data","has_more","total_count"],"properties":{"object":{"type":"string","const":"list","isRequired":true,"uniqueKey":"highlights.object","typeLabel":"string"},"has_more":{"type":"boolean","isRequired":true,"uniqueKey":"highlights.has_more","typeLabel":"boolean"},"total_count":{"type":"integer","isRequired":true,"uniqueKey":"highlights.total_count","typeLabel":"integer"},"data":{"type":"array","items":{"type":"object","description":"A clip cut around one shot, in several renditions.","properties":{"id":{"type":"string","example":"hl_9f2c…","uniqueKey":"highlights.data.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","const":"highlight","uniqueKey":"highlights.data.items.[INDEX].object","typeLabel":"string"},"shot":{"type":"string","description":"The shot this clip is for.","example":"shot_a1b2…","uniqueKey":"highlights.data.items.[INDEX].shot","typeLabel":"string"},"shot_index":{"oneOf":[{"type":"integer","uniqueKey":"highlights.data.items.[INDEX].shot_index.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"highlights.data.items.[INDEX].shot_index.oneOf.1","typeLabel":"null"}],"uniqueKey":"highlights.data.items.[INDEX].shot_index","typeLabel":"integer | null"},"length_seconds":{"type":"number","example":8.5,"uniqueKey":"highlights.data.items.[INDEX].length_seconds","typeLabel":"number"},"is_lowlight":{"type":"boolean","uniqueKey":"highlights.data.items.[INDEX].is_lowlight","typeLabel":"boolean"},"is_manual":{"type":"boolean","uniqueKey":"highlights.data.items.[INDEX].is_manual","typeLabel":"boolean"},"player":{"oneOf":[{"type":"string","description":"The scorer, as a `plr_` id from the session's `players`.","example":"plr_5","uniqueKey":"highlights.data.items.[INDEX].player.oneOf.0","typeLabel":"string"},{"type":"null","description":"The scorer, as a `plr_` id from the session's `players`.","example":"plr_5","uniqueKey":"highlights.data.items.[INDEX].player.oneOf.1","typeLabel":"null"}],"uniqueKey":"highlights.data.items.[INDEX].player","typeLabel":"string | null"},"video":{"type":"object","properties":{"default":{"oneOf":[{"type":"string","uniqueKey":"highlights.data.items.[INDEX].video.default.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"highlights.data.items.[INDEX].video.default.oneOf.1","typeLabel":"null"}],"uniqueKey":"highlights.data.items.[INDEX].video.default","typeLabel":"string | null"},"horizontal":{"oneOf":[{"type":"string","uniqueKey":"highlights.data.items.[INDEX].video.horizontal.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"highlights.data.items.[INDEX].video.horizontal.oneOf.1","typeLabel":"null"}],"uniqueKey":"highlights.data.items.[INDEX].video.horizontal","typeLabel":"string | null"},"1080p":{"oneOf":[{"type":"string","uniqueKey":"highlights.data.items.[INDEX].video.1080p.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"highlights.data.items.[INDEX].video.1080p.oneOf.1","typeLabel":"null"}],"uniqueKey":"highlights.data.items.[INDEX].video.1080p","typeLabel":"string | null"},"720p":{"oneOf":[{"type":"string","uniqueKey":"highlights.data.items.[INDEX].video.720p.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"highlights.data.items.[INDEX].video.720p.oneOf.1","typeLabel":"null"}],"uniqueKey":"highlights.data.items.[INDEX].video.720p","typeLabel":"string | null"},"480p":{"oneOf":[{"type":"string","uniqueKey":"highlights.data.items.[INDEX].video.480p.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"highlights.data.items.[INDEX].video.480p.oneOf.1","typeLabel":"null"}],"uniqueKey":"highlights.data.items.[INDEX].video.480p","typeLabel":"string | null"},"360p":{"oneOf":[{"type":"string","uniqueKey":"highlights.data.items.[INDEX].video.360p.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"highlights.data.items.[INDEX].video.360p.oneOf.1","typeLabel":"null"}],"uniqueKey":"highlights.data.items.[INDEX].video.360p","typeLabel":"string | null"},"240p":{"oneOf":[{"type":"string","uniqueKey":"highlights.data.items.[INDEX].video.240p.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"highlights.data.items.[INDEX].video.240p.oneOf.1","typeLabel":"null"}],"uniqueKey":"highlights.data.items.[INDEX].video.240p","typeLabel":"string | null"},"144p":{"oneOf":[{"type":"string","uniqueKey":"highlights.data.items.[INDEX].video.144p.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"highlights.data.items.[INDEX].video.144p.oneOf.1","typeLabel":"null"}],"uniqueKey":"highlights.data.items.[INDEX].video.144p","typeLabel":"string | null"}},"uniqueKey":"highlights.data.items.[INDEX].video","typeLabel":"object"},"preview":{"type":"object","properties":{"default":{"oneOf":[{"type":"string","uniqueKey":"highlights.data.items.[INDEX].preview.default.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"highlights.data.items.[INDEX].preview.default.oneOf.1","typeLabel":"null"}],"uniqueKey":"highlights.data.items.[INDEX].preview.default","typeLabel":"string | null"},"horizontal":{"oneOf":[{"type":"string","uniqueKey":"highlights.data.items.[INDEX].preview.horizontal.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"highlights.data.items.[INDEX].preview.horizontal.oneOf.1","typeLabel":"null"}],"uniqueKey":"highlights.data.items.[INDEX].preview.horizontal","typeLabel":"string | null"}},"uniqueKey":"highlights.data.items.[INDEX].preview","typeLabel":"object"},"created":{"oneOf":[{"type":"integer","uniqueKey":"highlights.data.items.[INDEX].created.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"highlights.data.items.[INDEX].created.oneOf.1","typeLabel":"null"}],"uniqueKey":"highlights.data.items.[INDEX].created","typeLabel":"integer | null"}},"uniqueKey":"highlights.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"highlights.data","typeLabel":"object[]"},"url":{"type":"string","description":"Embedded lists only: the endpoint that pages the full set.","example":"/v1/sessions/sess_18234/highlights","uniqueKey":"highlights.url","typeLabel":"string"}},"uniqueKey":"highlights","typeLabel":"object"},"shots":{"type":"object","required":["object","data","has_more","total_count"],"properties":{"object":{"type":"string","const":"list","isRequired":true,"uniqueKey":"shots.object","typeLabel":"string"},"has_more":{"type":"boolean","isRequired":true,"uniqueKey":"shots.has_more","typeLabel":"boolean"},"total_count":{"type":"integer","isRequired":true,"uniqueKey":"shots.total_count","typeLabel":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"shot_a1b2…","uniqueKey":"shots.data.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","const":"shot","uniqueKey":"shots.data.items.[INDEX].object","typeLabel":"string"},"index":{"oneOf":[{"type":"integer","uniqueKey":"shots.data.items.[INDEX].index.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"shots.data.items.[INDEX].index.oneOf.1","typeLabel":"null"}],"uniqueKey":"shots.data.items.[INDEX].index","typeLabel":"integer | null"},"start_seconds":{"oneOf":[{"type":"number","uniqueKey":"shots.data.items.[INDEX].start_seconds.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"shots.data.items.[INDEX].start_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"shots.data.items.[INDEX].start_seconds","typeLabel":"number | null"},"end_seconds":{"oneOf":[{"type":"number","uniqueKey":"shots.data.items.[INDEX].end_seconds.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"shots.data.items.[INDEX].end_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"shots.data.items.[INDEX].end_seconds","typeLabel":"number | null"},"made":{"oneOf":[{"type":"boolean","uniqueKey":"shots.data.items.[INDEX].made.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"shots.data.items.[INDEX].made.oneOf.1","typeLabel":"null"}],"uniqueKey":"shots.data.items.[INDEX].made","typeLabel":"boolean | null"},"points":{"oneOf":[{"type":"integer","description":"0 when missed; 1 for a free throw; 2 or 3 otherwise.","uniqueKey":"shots.data.items.[INDEX].points.oneOf.0","typeLabel":"integer"},{"type":"null","description":"0 when missed; 1 for a free throw; 2 or 3 otherwise.","uniqueKey":"shots.data.items.[INDEX].points.oneOf.1","typeLabel":"null"}],"uniqueKey":"shots.data.items.[INDEX].points","typeLabel":"integer | null"},"type":{"type":"string","example":"fieldgoal","uniqueKey":"shots.data.items.[INDEX].type","typeLabel":"string"},"is_three_point":{"oneOf":[{"type":"boolean","uniqueKey":"shots.data.items.[INDEX].is_three_point.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"shots.data.items.[INDEX].is_three_point.oneOf.1","typeLabel":"null"}],"uniqueKey":"shots.data.items.[INDEX].is_three_point","typeLabel":"boolean | null"},"is_free_throw":{"type":"boolean","uniqueKey":"shots.data.items.[INDEX].is_free_throw","typeLabel":"boolean"},"is_fouled":{"type":"boolean","uniqueKey":"shots.data.items.[INDEX].is_fouled","typeLabel":"boolean"},"location":{"type":"object","description":"Normalized (0–1) coordinates.","properties":{"shot_image_normed":{"oneOf":[{"type":"array","items":{"type":"number","uniqueKey":"shots.data.items.[INDEX].location.shot_image_normed.oneOf.0.items.[INDEX]","typeLabel":"number"},"uniqueKey":"shots.data.items.[INDEX].location.shot_image_normed.oneOf.0","typeLabel":"number[]"},{"type":"null","items":{"type":"number"},"uniqueKey":"shots.data.items.[INDEX].location.shot_image_normed.oneOf.1","typeLabel":"null"}],"uniqueKey":"shots.data.items.[INDEX].location.shot_image_normed","typeLabel":"number[] | null"},"shot_world_normed":{"oneOf":[{"type":"array","items":{"type":"number","uniqueKey":"shots.data.items.[INDEX].location.shot_world_normed.oneOf.0.items.[INDEX]","typeLabel":"number"},"uniqueKey":"shots.data.items.[INDEX].location.shot_world_normed.oneOf.0","typeLabel":"number[]"},{"type":"null","items":{"type":"number"},"uniqueKey":"shots.data.items.[INDEX].location.shot_world_normed.oneOf.1","typeLabel":"null"}],"uniqueKey":"shots.data.items.[INDEX].location.shot_world_normed","typeLabel":"number[] | null"},"hoop_image_normed":{"oneOf":[{"type":"array","items":{"type":"number","uniqueKey":"shots.data.items.[INDEX].location.hoop_image_normed.oneOf.0.items.[INDEX]","typeLabel":"number"},"uniqueKey":"shots.data.items.[INDEX].location.hoop_image_normed.oneOf.0","typeLabel":"number[]"},{"type":"null","items":{"type":"number"},"uniqueKey":"shots.data.items.[INDEX].location.hoop_image_normed.oneOf.1","typeLabel":"null"}],"uniqueKey":"shots.data.items.[INDEX].location.hoop_image_normed","typeLabel":"number[] | null"}},"uniqueKey":"shots.data.items.[INDEX].location","typeLabel":"object"},"excitement_score":{"oneOf":[{"type":"number","uniqueKey":"shots.data.items.[INDEX].excitement_score.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"shots.data.items.[INDEX].excitement_score.oneOf.1","typeLabel":"null"}],"uniqueKey":"shots.data.items.[INDEX].excitement_score","typeLabel":"number | null"},"players":{"type":"object","properties":{"scorer":{"oneOf":[{"type":"string","example":"plr_5","uniqueKey":"shots.data.items.[INDEX].players.scorer.oneOf.0","typeLabel":"string"},{"type":"null","example":"plr_5","uniqueKey":"shots.data.items.[INDEX].players.scorer.oneOf.1","typeLabel":"null"}],"uniqueKey":"shots.data.items.[INDEX].players.scorer","typeLabel":"string | null"},"assister":{"oneOf":[{"type":"string","uniqueKey":"shots.data.items.[INDEX].players.assister.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"shots.data.items.[INDEX].players.assister.oneOf.1","typeLabel":"null"}],"uniqueKey":"shots.data.items.[INDEX].players.assister","typeLabel":"string | null"},"rebounder":{"oneOf":[{"type":"string","uniqueKey":"shots.data.items.[INDEX].players.rebounder.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"shots.data.items.[INDEX].players.rebounder.oneOf.1","typeLabel":"null"}],"uniqueKey":"shots.data.items.[INDEX].players.rebounder","typeLabel":"string | null"}},"uniqueKey":"shots.data.items.[INDEX].players","typeLabel":"object"},"highlight":{"oneOf":[{"type":"string","description":"The clip for this shot, when one was cut.","example":"hl_9f2c…","uniqueKey":"shots.data.items.[INDEX].highlight.oneOf.0","typeLabel":"string"},{"type":"null","description":"The clip for this shot, when one was cut.","example":"hl_9f2c…","uniqueKey":"shots.data.items.[INDEX].highlight.oneOf.1","typeLabel":"null"}],"uniqueKey":"shots.data.items.[INDEX].highlight","typeLabel":"string | null"}},"uniqueKey":"shots.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"shots.data","typeLabel":"object[]"},"url":{"type":"string","description":"Embedded lists only: the endpoint that pages the full set.","example":"/v1/sessions/sess_18234/highlights","uniqueKey":"shots.url","typeLabel":"string"}},"uniqueKey":"shots","typeLabel":"object"},"players":{"type":"object","required":["object","data","has_more","total_count"],"properties":{"object":{"type":"string","const":"list","isRequired":true,"uniqueKey":"players.object","typeLabel":"string"},"has_more":{"type":"boolean","isRequired":true,"uniqueKey":"players.has_more","typeLabel":"boolean"},"total_count":{"type":"integer","isRequired":true,"uniqueKey":"players.total_count","typeLabel":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"plr_5","uniqueKey":"players.data.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","const":"player","uniqueKey":"players.data.items.[INDEX].object","typeLabel":"string"},"name":{"oneOf":[{"type":"string","uniqueKey":"players.data.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"players.data.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"players.data.items.[INDEX].name","typeLabel":"string | null"},"jersey":{"oneOf":[{"type":"string","uniqueKey":"players.data.items.[INDEX].jersey.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"players.data.items.[INDEX].jersey.oneOf.1","typeLabel":"null"}],"uniqueKey":"players.data.items.[INDEX].jersey","typeLabel":"string | null"},"user_id":{"oneOf":[{"type":"string","uniqueKey":"players.data.items.[INDEX].user_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"players.data.items.[INDEX].user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"players.data.items.[INDEX].user_id","typeLabel":"string | null"},"team_id":{"oneOf":[{"type":"integer","description":"`1` for `teams.recording`, `2` for `teams.opponent`. Follows your `rosters` when you sent them. `null` when Hooper couldn't place the player on a side.","uniqueKey":"players.data.items.[INDEX].team_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"`1` for `teams.recording`, `2` for `teams.opponent`. Follows your `rosters` when you sent them. `null` when Hooper couldn't place the player on a side.","uniqueKey":"players.data.items.[INDEX].team_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"players.data.items.[INDEX].team_id","typeLabel":"integer | null"},"team_name":{"oneOf":[{"type":"string","description":"The name of the player's side, the same as `teams.\u003cside>.name`. `null` when `team_id` is.","example":"Acme Varsity","uniqueKey":"players.data.items.[INDEX].team_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the player's side, the same as `teams.\u003cside>.name`. `null` when `team_id` is.","example":"Acme Varsity","uniqueKey":"players.data.items.[INDEX].team_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"players.data.items.[INDEX].team_name","typeLabel":"string | null"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"players.data.items.[INDEX].metadata.additionalProperties","typeLabel":"string"},"description":"The `metadata` of the roster player this one matched; `{}` when there was none.","example":{"player_id":"lg-4821"},"uniqueKey":"players.data.items.[INDEX].metadata","typeLabel":"object"},"stats":{"type":"object","properties":{"points":{"type":"integer","uniqueKey":"players.data.items.[INDEX].stats.points","typeLabel":"integer"},"fg_2pt_att":{"type":"integer","uniqueKey":"players.data.items.[INDEX].stats.fg_2pt_att","typeLabel":"integer"},"fg_2pt_make":{"type":"integer","uniqueKey":"players.data.items.[INDEX].stats.fg_2pt_make","typeLabel":"integer"},"fg_3pt_att":{"type":"integer","uniqueKey":"players.data.items.[INDEX].stats.fg_3pt_att","typeLabel":"integer"},"fg_3pt_make":{"type":"integer","uniqueKey":"players.data.items.[INDEX].stats.fg_3pt_make","typeLabel":"integer"},"ft_att":{"type":"integer","uniqueKey":"players.data.items.[INDEX].stats.ft_att","typeLabel":"integer"},"ft_make":{"type":"integer","uniqueKey":"players.data.items.[INDEX].stats.ft_make","typeLabel":"integer"},"assist":{"type":"integer","uniqueKey":"players.data.items.[INDEX].stats.assist","typeLabel":"integer"},"rebound":{"type":"integer","uniqueKey":"players.data.items.[INDEX].stats.rebound","typeLabel":"integer"}},"uniqueKey":"players.data.items.[INDEX].stats","typeLabel":"object"}},"uniqueKey":"players.data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"players.data","typeLabel":"object[]"},"url":{"type":"string","description":"Embedded lists only: the endpoint that pages the full set.","example":"/v1/sessions/sess_18234/highlights","uniqueKey":"players.url","typeLabel":"string"}},"uniqueKey":"players","typeLabel":"object"},"totals":{"type":"object","properties":{"points":{"type":"integer","uniqueKey":"totals.points","typeLabel":"integer"},"fg_2pt_att":{"type":"integer","uniqueKey":"totals.fg_2pt_att","typeLabel":"integer"},"fg_2pt_make":{"type":"integer","uniqueKey":"totals.fg_2pt_make","typeLabel":"integer"},"fg_3pt_att":{"type":"integer","uniqueKey":"totals.fg_3pt_att","typeLabel":"integer"},"fg_3pt_make":{"type":"integer","uniqueKey":"totals.fg_3pt_make","typeLabel":"integer"},"ft_att":{"type":"integer","uniqueKey":"totals.ft_att","typeLabel":"integer"},"ft_make":{"type":"integer","uniqueKey":"totals.ft_make","typeLabel":"integer"},"assist":{"type":"integer","uniqueKey":"totals.assist","typeLabel":"integer"},"rebound":{"type":"integer","uniqueKey":"totals.rebound","typeLabel":"integer"}},"uniqueKey":"totals","typeLabel":"object"},"video":{"type":"object","properties":{"url":{"oneOf":[{"type":"string","uniqueKey":"video.url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"video.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"video.url","typeLabel":"string | null"},"preview_url":{"oneOf":[{"type":"string","uniqueKey":"video.preview_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"video.preview_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"video.preview_url","typeLabel":"string | null"},"1080p":{"oneOf":[{"type":"string","uniqueKey":"video.1080p.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"video.1080p.oneOf.1","typeLabel":"null"}],"uniqueKey":"video.1080p","typeLabel":"string | null"},"720p":{"oneOf":[{"type":"string","uniqueKey":"video.720p.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"video.720p.oneOf.1","typeLabel":"null"}],"uniqueKey":"video.720p","typeLabel":"string | null"},"360p":{"oneOf":[{"type":"string","uniqueKey":"video.360p.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"video.360p.oneOf.1","typeLabel":"null"}],"uniqueKey":"video.360p","typeLabel":"string | null"},"width":{"oneOf":[{"type":"integer","uniqueKey":"video.width.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"video.width.oneOf.1","typeLabel":"null"}],"uniqueKey":"video.width","typeLabel":"integer | null"},"height":{"oneOf":[{"type":"integer","uniqueKey":"video.height.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"video.height.oneOf.1","typeLabel":"null"}],"uniqueKey":"video.height","typeLabel":"integer | null"},"fps":{"oneOf":[{"type":"number","uniqueKey":"video.fps.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"video.fps.oneOf.1","typeLabel":"null"}],"uniqueKey":"video.fps","typeLabel":"number | null"}},"uniqueKey":"video","typeLabel":"object"},"artifacts":{"type":"object","description":"Raw model output (JSONL) behind the shots and highlights.","properties":{"actions":{"oneOf":[{"type":"string","uniqueKey":"artifacts.actions.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"artifacts.actions.oneOf.1","typeLabel":"null"}],"uniqueKey":"artifacts.actions","typeLabel":"string | null"},"balls":{"oneOf":[{"type":"string","uniqueKey":"artifacts.balls.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"artifacts.balls.oneOf.1","typeLabel":"null"}],"uniqueKey":"artifacts.balls","typeLabel":"string | null"},"hoops":{"oneOf":[{"type":"string","uniqueKey":"artifacts.hoops.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"artifacts.hoops.oneOf.1","typeLabel":"null"}],"uniqueKey":"artifacts.hoops","typeLabel":"string | null"},"clusters":{"oneOf":[{"type":"string","uniqueKey":"artifacts.clusters.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"artifacts.clusters.oneOf.1","typeLabel":"null"}],"uniqueKey":"artifacts.clusters","typeLabel":"string | null"}},"uniqueKey":"artifacts","typeLabel":"object"},"error":{"oneOf":[{"type":"object","description":"Set when `status` is `failed`.","properties":{"code":{"type":"string","enum":["no_shots","no_hoops","no_court","video_too_large","source_invalid","source_unavailable","source_too_slow","insufficient_credits","image_unavailable","image_invalid","image_too_large","video_composition_failed","timeout","unknown"],"uniqueKey":"error.oneOf.0.code","typeLabel":"enum\u003cstring>"},"param":{"type":"string","description":"For the `image_*` codes: the branding image that failed.","enum":["branding.cover","branding.logo"],"uniqueKey":"error.oneOf.0.param","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"What went wrong and, for branding images, how to fix it.","uniqueKey":"error.oneOf.0.message","typeLabel":"string"}},"uniqueKey":"error.oneOf.0","typeLabel":"object"},{"type":"null","description":"Set when `status` is `failed`.","properties":{"code":{"type":"string","enum":["no_shots","no_hoops","no_court","video_too_large","source_invalid","source_unavailable","source_too_slow","insufficient_credits","image_unavailable","image_invalid","image_too_large","video_composition_failed","timeout","unknown"]},"param":{"type":"string","description":"For the `image_*` codes: the branding image that failed.","enum":["branding.cover","branding.logo"]},"message":{"type":"string","description":"What went wrong and, for branding images, how to fix it."}},"uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"sess_18234","object":"session","created":1756224000,"status":"queued","group":"grp_412","source":{"type":"upload","upload_id":"up_3f9a1c2b7e5d4a08","url":"\u003cstring>","parts":[{"type":"upload","upload_id":"\u003cstring>","url":"\u003cstring>"}]},"metadata":{},"branding":{"cover":true,"logo":true},"teams":{"recording":{"name":"Acme Varsity","metadata":{}},"opponent":{"name":"Acme Varsity","metadata":{}}},"run_version":123,"duration_seconds":5412,"cost_cents":752,"highlights":{"object":"list","has_more":true,"total_count":123,"data":[{"id":"hl_9f2c…","object":"highlight","shot":"shot_a1b2…","shot_index":123,"length_seconds":8.5,"is_lowlight":true,"is_manual":true,"player":"plr_5","video":{"default":"\u003cstring>","horizontal":"\u003cstring>","1080p":"\u003cstring>","720p":"\u003cstring>","480p":"\u003cstring>","360p":"\u003cstring>","240p":"\u003cstring>","144p":"\u003cstring>"},"preview":{"default":"\u003cstring>","horizontal":"\u003cstring>"},"created":123}],"url":"/v1/sessions/sess_18234/highlights"},"shots":{"object":"list","has_more":true,"total_count":123,"data":[{"id":"shot_a1b2…","object":"shot","index":123,"start_seconds":123,"end_seconds":123,"made":true,"points":123,"type":"fieldgoal","is_three_point":true,"is_free_throw":true,"is_fouled":true,"location":{"shot_image_normed":[123],"shot_world_normed":[123],"hoop_image_normed":[123]},"excitement_score":123,"players":{"scorer":"plr_5","assister":"\u003cstring>","rebounder":"\u003cstring>"},"highlight":"hl_9f2c…"}],"url":"/v1/sessions/sess_18234/highlights"},"players":{"object":"list","has_more":true,"total_count":123,"data":[{"id":"plr_5","object":"player","name":"\u003cstring>","jersey":"\u003cstring>","user_id":"\u003cstring>","team_id":123,"team_name":"Acme Varsity","metadata":{"player_id":"lg-4821"},"stats":{"points":123,"fg_2pt_att":123,"fg_2pt_make":123,"fg_3pt_att":123,"fg_3pt_make":123,"ft_att":123,"ft_make":123,"assist":123,"rebound":123}}],"url":"/v1/sessions/sess_18234/highlights"},"totals":{"points":123,"fg_2pt_att":123,"fg_2pt_make":123,"fg_3pt_att":123,"fg_3pt_make":123,"ft_att":123,"ft_make":123,"assist":123,"rebound":123},"video":{"url":"\u003cstring>","preview_url":"\u003cstring>","1080p":"\u003cstring>","720p":"\u003cstring>","360p":"\u003cstring>","width":123,"height":123,"fps":123},"artifacts":{"actions":"\u003cstring>","balls":"\u003cstring>","hoops":"\u003cstring>","clusters":"\u003cstring>"},"error":{"code":"no_shots","param":"branding.cover","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7ef2fc24-f8cf-4f60-a135-641fc79e4dd9":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message"],"properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","insufficient_credits","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","example":"parameter_invalid","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","description":"The request field the error refers to, when there is one.","example":"source.url","uniqueKey":"error.param","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"parameter_invalid","message":"\u003cstring>","param":"source.url"}}}},"exampleType":"generated"}},"exampleType":"generated"},"6e13480e-7355-4d66-ace8-f36e7ebae8cc":{"description":"Missing, invalid, revoked or wrong-environment API key","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message"],"properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","insufficient_credits","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","example":"parameter_invalid","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","description":"The request field the error refers to, when there is one.","example":"source.url","uniqueKey":"error.param","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"parameter_invalid","message":"\u003cstring>","param":"source.url"}}}},"exampleType":"generated"}},"exampleType":"generated"},"b6e5a0ea-9fd5-4cfa-9396-395e0d06f4bb":{"description":"Insufficient credits","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","const":"insufficient_credits","uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","const":"insufficient_credits","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"needed_cents":{"type":"integer","example":1080,"uniqueKey":"error.needed_cents","typeLabel":"integer"},"available_cents":{"type":"integer","example":0,"uniqueKey":"error.available_cents","typeLabel":"integer"},"held_cents":{"type":"integer","description":"Present when credit is reserved for videos in progress; it frees up as they're measured and processed.","example":1000,"uniqueKey":"error.held_cents","typeLabel":"integer"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"insufficient_credits","code":"insufficient_credits","message":"\u003cstring>","needed_cents":1080,"available_cents":0,"held_cents":1000}}}},"exampleType":"generated"}},"exampleType":"generated"},"c7ab3db0-bd63-4daa-8710-fce71fe1c0ea":{"description":"Upload not finished, or an Idempotency-Key still in progress","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message"],"properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","insufficient_credits","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","example":"parameter_invalid","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","description":"The request field the error refers to, when there is one.","example":"source.url","uniqueKey":"error.param","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"parameter_invalid","message":"\u003cstring>","param":"source.url"}}}},"exampleType":"generated"}},"exampleType":"generated"},"636353c9-ef34-413e-a738-432a5306721f":{"description":"More than 60 requests per minute for this key","headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message"],"properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","insufficient_credits","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","example":"parameter_invalid","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","description":"The request field the error refers to, when there is one.","example":"source.url","uniqueKey":"error.param","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"parameter_invalid","message":"\u003cstring>","param":"source.url"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b92e9908-8824-4d13-95d0-5099f9596508":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"hk_prod_… / hk_stg_…","description":"API key issued by Hooper for your organization. Keys are environment-tagged: `hk_prod_` keys work against production, `hk_stg_` keys against staging.","scopes":[],"schemeName":"apiKey"}}},"servers":{"0820b8ad-481b-42ce-b930-f545370c7399":{"url":"https://api.hooper.gg","description":"Production (accepts hk_prod_ keys)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"hk_prod_… / hk_stg_…","description":"API key issued by Hooper for your organization. Keys are environment-tagged: `hk_prod_` keys work against production, `hk_stg_` keys against staging.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key issued by Hooper for your organization. Keys are environment-tagged: `hk_prod_` keys work against production, `hk_stg_` keys against staging.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"hooper","siteName":"Hooper API","title":"Submit a video - Hooper API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T05:46:09.973Z","originalFileLocation":"api-reference/sessions/submit-a-video.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Places a credit hold, creates the session and queues it for processing. Responds immediately with the session in queued state; you are notified through a webhook (session.processed / session.failed) when it finishes, or you can poll GET /v1/sessions/{id}. Send an Idempotency-Key header to make retries safe: the same key with the same body returns the original response for 24 hours.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hooper API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hooper/4vurUir1Acj-QAx7/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hooper/4vurUir1Acj-QAx7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hooper/4vurUir1Acj-QAx7/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hooper/4vurUir1Acj-QAx7/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hooper/4vurUir1Acj-QAx7/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hooper/4vurUir1Acj-QAx7/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hooper/4vurUir1Acj-QAx7/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hooper/4vurUir1Acj-QAx7/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hooper/4vurUir1Acj-QAx7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Submit a video - Hooper API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Places a credit hold, creates the session and queues it for processing. Responds immediately with the session in queued state; you are notified through a webhook (session.processed / session.failed) when it finishes, or you can poll GET /v1/sessions/{id}. Send an Idempotency-Key header to make retries safe: the same key with the same body returns the original response for 24 hours.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hooper API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.hooper.gg/api-reference/sessions/submit-a-video\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hooper.mintlify.site/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Submit+a+video\u0026amp;description=Places+a+credit+hold%2C+creates+the+session+and+queues+it+for+processing.+Responds+immediately+with+the+session+in+%60queued%60+state%3B+you+are+notified+through+a+webh\u0026amp;theme=b0f8414c46e34473a6f4b727\u0026amp;signature=0f4cb1797fb9dcd0f303e6465bdc6c4f0625bb567bebb87c805d14dfccbbb1dc\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Submit a video - Hooper API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Places a credit hold, creates the session and queues it for processing. Responds immediately with the session in queued state; you are notified through a webhook (session.processed / session.failed) when it finishes, or you can poll GET /v1/sessions/{id}. Send an Idempotency-Key header to make retries safe: the same key with the same body returns the original response for 24 hours.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hooper.mintlify.site/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Submit+a+video\u0026amp;description=Places+a+credit+hold%2C+creates+the+session+and+queues+it+for+processing.+Responds+immediately+with+the+session+in+%60queued%60+state%3B+you+are+notified+through+a+webh\u0026amp;theme=b0f8414c46e34473a6f4b727\u0026amp;signature=0f4cb1797fb9dcd0f303e6465bdc6c4f0625bb567bebb87c805d14dfccbbb1dc\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hooper/4vurUir1Acj-QAx7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hooper API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5040FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.hooper.gg/api-reference/sessions/submit-a-video\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sessions/submit-a-video.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.hooper.gg/#organization\",\"name\":\"Hooper API\",\"url\":\"https://developer.hooper.gg\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hooper/tJj0DWSVCp1VND09/logo/light.svg?fit=max\u0026auto=format\u0026n=tJj0DWSVCp1VND09\u0026q=85\u0026s=c202803e7c4b6fd5c5258ad6ffc3f076\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.hooper.gg#website\",\"name\":\"Hooper API\",\"url\":\"https://developer.hooper.gg\",\"publisher\":{\"@id\":\"https://developer.hooper.gg/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.hooper.gg/api-reference/sessions/submit-a-video#webpage\",\"url\":\"https://developer.hooper.gg/api-reference/sessions/submit-a-video\",\"name\":\"Submit a video\",\"description\":\"Places a credit hold, creates the session and queues it for processing. Responds immediately with the session in queued state; you are notified through a webhook (session.processed / session.failed) when it finishes, or you can poll GET /v1/sessions/{id}. Send an Idempotency-Key header to make retries safe: the same key with the same body returns the original response for 24 hours.\",\"dateModified\":\"2026-11-05T05:46:09.973Z\",\"isPartOf\":{\"@id\":\"https://developer.hooper.gg#website\"},\"breadcrumb\":{\"@id\":\"https://developer.hooper.gg/api-reference/sessions/submit-a-video#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.hooper.gg/api-reference/sessions/submit-a-video#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sessions\",\"item\":\"https://developer.hooper.gg/api-reference/sessions/list-sessions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Submit a video\",\"item\":\"https://developer.hooper.gg/api-reference/sessions/submit-a-video\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.hooper.gg/api-reference/sessions/submit-a-video#apireference\",\"headline\":\"Submit a video\",\"name\":\"Submit a video\",\"description\":\"Places a credit hold, creates the session and queues it for processing. Responds immediately with the session in queued state; you are notified through a webhook (session.processed / session.failed) when it finishes, or you can poll GET /v1/sessions/{id}. Send an Idempotency-Key header to make retries safe: the same key with the same body returns the original response for 24 hours.\",\"url\":\"https://developer.hooper.gg/api-reference/sessions/submit-a-video\",\"mainEntityOfPage\":{\"@id\":\"https://developer.hooper.gg/api-reference/sessions/submit-a-video#webpage\"},\"dateModified\":\"2026-11-05T05:46:09.973Z\",\"publisher\":{\"@id\":\"https://developer.hooper.gg/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.hooper.gg#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hooper API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Hooper API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Uploads","pages":[{"title":"Create an upload","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/uploads","href":"/api-reference/uploads/create-an-upload"}]},{"group":"Sessions","pages":[{"title":"List sessions","description":"Newest first. Each item is the full session object, highlights included.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions","href":"/api-reference/sessions/list-sessions"},{"title":"Submit a video","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sessions","href":"/api-reference/sessions/submit-a-video"},{"title":"Retrieve a session","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{id}","href":"/api-reference/sessions/retrieve-a-session"},{"title":"List a session's highlights","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{id}/highlights","href":"/api-reference/sessions/list-a-sessions-highlights"},{"title":"List a session's shots","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{id}/shots","href":"/api-reference/sessions/list-a-sessions-shots"},{"title":"List a session's players","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sessions/{id}/players","href":"/api-reference/sessions/list-a-sessions-players"}]},{"group":"Billing","pages":[{"title":"Retrieve the public price list","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/pricing","href":"/api-reference/billing/retrieve-the-public-price-list"},{"title":"Retrieve the balance","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/balance","href":"/api-reference/billing/retrieve-the-balance"},{"title":"List usage events","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/usage","href":"/api-reference/billing/list-usage-events"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhook_endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhook_endpoints","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Retrieve a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhook_endpoints/{id}","href":"/api-reference/webhooks/retrieve-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/webhook_endpoints/{id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhook_endpoints/{id}/test","href":"/api-reference/webhooks/send-a-test-event"}]},{"group":"Events","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/events","href":"/api-reference/events/list-events"},{"title":"Retrieve an event","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/events/{id}","href":"/api-reference/events/retrieve-an-event"}]},{"group":"API Reference","pages":[{"title":"Sessionprocessed","version":null,"deprecated":null,"openapi":"/openapi.json webhook session.processed","href":"/api-reference/sessionprocessed"},{"title":"Sessionfailed","version":null,"deprecated":null,"openapi":"/openapi.json webhook session.failed","href":"/api-reference/sessionfailed"}]}]}]},"basePath":"","title":"Submit a video - Hooper API","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}