{"openapi":"3.1.0","info":{"title":"Twelve Labs (BYOK) API","version":"0.1.0","description":"Twelve Labs (BYOK) lets an AI assistant read your own Twelve Labs data through the Twelve Labs API with a key you supply (Twelve Labs API key). Read-only: 8 tools (list_indexes, get_index, list_indexed_assets, get_indexed_asset, list_assets, get_asset, list_entity_collections, list_indexing_tasks). The BYOK key travels with each request, is used for that one call only and is never stored, logged...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-twelvelabs.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-twelvelabs/docs"},"termsOfService":"https://connectorbay.com/byok-twelvelabs/terms"},"servers":[{"url":"https://byok-twelvelabs.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-twelvelabs/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_indexes":{"post":{"operationId":"list_indexes","summary":"List your video indexes with model names, video count, total duration and creation time. Use for \"Which Twelve Labs inde","description":"List your video indexes with model names, video count, total duration and creation time. Use for \"Which Twelve Labs indexes do I have and how many videos are in each\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_limit":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Items per page (1 to 50).","title":"Page Limit"},"sort_by":{"anyOf":[{"enum":["created_at","updated_at"],"type":"string"},{"type":"null"}],"default":"created_at","description":"Field to sort on.","title":"Sort By"},"sort_option":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction.","title":"Sort Option"},"index_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only indexes with this name.","title":"Index Name"},"model_family":{"anyOf":[{"enum":["marengo","pegasus"],"type":"string"},{"type":"null"}],"default":null,"description":"Only indexes using this model family.","title":"Model Family"}},"title":"list_indexesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_index":{"post":{"operationId":"get_index","summary":"Get one index by id: name, models and options enabled, video count, total duration and expiry. Use for \"Show details of ","description":"Get one index by id: name, models and options enabled, video count, total duration and expiry. Use for \"Show details of Twelve Labs index 62d85fe7340fa665f1fda5dd\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"index_id":{"description":"Id of the index (from list_indexes).","maxLength":200,"title":"Index Id","type":"string"}},"required":["index_id"],"title":"get_indexArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_indexed_assets":{"post":{"operationId":"list_indexed_assets","summary":"List the videos (indexed assets) of one index with indexing status, filename, duration and resolution. Use for \"Which vi","description":"List the videos (indexed assets) of one index with indexing status, filename, duration and resolution. Use for \"Which videos in my index have finished indexing\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"index_id":{"description":"Id of the index (from list_indexes).","maxLength":200,"title":"Index Id","type":"string"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_limit":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Items per page (1 to 50).","title":"Page Limit"},"sort_by":{"anyOf":[{"enum":["created_at","updated_at"],"type":"string"},{"type":"null"}],"default":"created_at","description":"Field to sort on.","title":"Sort By"},"sort_option":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction.","title":"Sort Option"},"status":{"anyOf":[{"enum":["ready","pending","queued","indexing","validating","failed"],"type":"string"},{"type":"null"}],"default":null,"description":"Only indexed assets with this indexing status.","title":"Status"},"filename":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only indexed assets whose filename matches.","title":"Filename"}},"required":["index_id"],"title":"list_indexed_assetsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_indexed_asset":{"post":{"operationId":"get_indexed_asset","summary":"Get one indexed video: status, system metadata and any user-defined metadata (no embeddings or transcript). Use for \"Wha","description":"Get one indexed video: status, system metadata and any user-defined metadata (no embeddings or transcript). Use for \"What is the status and resolution of indexed video 6298d673f1090f1100476d4c\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"index_id":{"description":"Id of the index (from list_indexes).","maxLength":200,"title":"Index Id","type":"string"},"indexed_asset_id":{"description":"Id of the indexed asset (from list_indexed_assets).","maxLength":200,"title":"Indexed Asset Id","type":"string"}},"required":["index_id","indexed_asset_id"],"title":"get_indexed_assetArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_assets":{"post":{"operationId":"list_assets","summary":"List uploaded assets (video, audio, image, document files) newest first with status, filename, type, size and duration. ","description":"List uploaded assets (video, audio, image, document files) newest first with status, filename, type, size and duration. Use for \"What files have I uploaded to Twelve Labs\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_limit":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Items per page (1 to 50).","title":"Page Limit"},"asset_types":{"anyOf":[{"enum":["image","video","audio","document"],"type":"string"},{"type":"null"}],"default":null,"description":"Only assets of this type.","title":"Asset Types"},"filename":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only assets whose filename contains this text (case-insensitive).","title":"Filename"}},"title":"list_assetsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_asset":{"post":{"operationId":"get_asset","summary":"Get one uploaded asset: status, filename, MIME type, size, duration and any processing error. Use for \"Did asset 6298d67","description":"Get one uploaded asset: status, filename, MIME type, size, duration and any processing error. Use for \"Did asset 6298d673f1090f1100476aaa finish processing\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"asset_id":{"description":"Id of the asset (from list_assets).","maxLength":200,"title":"Asset Id","type":"string"}},"required":["asset_id"],"title":"get_assetArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_entity_collections":{"post":{"operationId":"list_entity_collections","summary":"List entity collections (named groups of people, objects or brands used for entity search) with description and dates. U","description":"List entity collections (named groups of people, objects or brands used for entity search) with description and dates. Use for \"Which entity collections do I have in Twelve Labs\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_limit":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Items per page (1 to 50).","title":"Page Limit"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only collections with this name.","title":"Name"},"sort_by":{"anyOf":[{"enum":["created_at","updated_at","name"],"type":"string"},{"type":"null"}],"default":"created_at","description":"Field to sort on.","title":"Sort By"},"sort_option":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction.","title":"Sort Option"}},"title":"list_entity_collectionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_indexing_tasks":{"post":{"operationId":"list_indexing_tasks","summary":"List video indexing tasks (an older interface, being retired) with status, index, filename and times. Use for \"Are any o","description":"List video indexing tasks (an older interface, being retired) with status, index, filename and times. Use for \"Are any of my Twelve Labs indexing tasks failing\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_limit":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"Items per page (1 to 50).","title":"Page Limit"},"sort_by":{"anyOf":[{"enum":["created_at","updated_at"],"type":"string"},{"type":"null"}],"default":"created_at","description":"Field to sort on.","title":"Sort By"},"sort_option":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort direction.","title":"Sort Option"},"index_id":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Only tasks of this index.","title":"Index Id"},"status":{"anyOf":[{"enum":["ready","uploading","validating","pending","queued","indexing","failed"],"type":"string"},{"type":"null"}],"default":null,"description":"Only tasks with this status.","title":"Status"}},"title":"list_indexing_tasksArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}