{"openapi":"3.1.0","info":{"title":"Hume (BYOK) API","version":"0.1.0","description":"Hume (BYOK) lets an AI assistant read your own Hume data through the Hume API with a key you supply (Hume API key). Read-only: 7 tools (list_voices, list_configs, list_prompts, list_tools, list_chats, list_chat_events, list_chat_groups). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.hume.ai. Unofficial...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-hume.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-hume/docs"},"termsOfService":"https://connectorbay.com/byok-hume/terms"},"servers":[{"url":"https://byok-hume.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-hume/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_voices":{"post":{"operationId":"list_voices","summary":"List text-to-speech voices: Hume's shared voice library (HUME_AI) or the custom voices saved in your account (CUSTOM_VOI","description":"List text-to-speech voices: Hume's shared voice library (HUME_AI) or the custom voices saved in your account (CUSTOM_VOICE), optionally filtered by tag. Use for \"Which custom voices have I saved in Hume\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"provider":{"description":"Which voices: HUME_AI (shared library) or CUSTOM_VOICE (your own).","enum":["HUME_AI","CUSTOM_VOICE"],"title":"Provider","type":"string"},"page_number":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100).","title":"Page Size"},"ascending_order":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for oldest first, false for newest first.","title":"Ascending Order"},"filter_tag":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Only voices with this tag, written TAG:VALUE, for example GENDER:Male.","title":"Filter Tag"}},"required":["provider"],"title":"list_voicesArguments","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_configs":{"post":{"operationId":"list_configs","summary":"List EVI voice agent configurations with name, version, EVI version, prompt and voice settings. Use for \"Which EVI confi","description":"List EVI voice agent configurations with name, version, EVI version, prompt and voice settings. Use for \"Which EVI configs do I have in Hume\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_number":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100).","title":"Page Size"},"restrict_to_most_recent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True (default) returns only the latest version of each item; false returns every version.","title":"Restrict To Most Recent"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only configs with exactly this name.","title":"Name"}},"title":"list_configsArguments","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_prompts":{"post":{"operationId":"list_prompts","summary":"List EVI prompts (system instructions) with their text and version. Use for \"Which prompts are stored for my Hume EVI ag","description":"List EVI prompts (system instructions) with their text and version. Use for \"Which prompts are stored for my Hume EVI agents\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_number":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100).","title":"Page Size"},"restrict_to_most_recent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True (default) returns only the latest version of each item; false returns every version.","title":"Restrict To Most Recent"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only prompts with exactly this name.","title":"Name"}},"title":"list_promptsArguments","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_tools":{"post":{"operationId":"list_tools","summary":"List user-defined EVI tools (functions an agent can call) with description, parameter schema and version. Use for \"Which","description":"List user-defined EVI tools (functions an agent can call) with description, parameter schema and version. Use for \"Which tools can my Hume EVI agents call\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_number":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100).","title":"Page Size"},"restrict_to_most_recent":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True (default) returns only the latest version of each item; false returns every version.","title":"Restrict To Most Recent"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only tools with exactly this name.","title":"Name"}},"title":"list_toolsArguments","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_chats":{"post":{"operationId":"list_chats","summary":"List EVI voice chats with status, start and end time, event count and the config used; filter by config or status. Use f","description":"List EVI voice chats with status, start and end time, event count and the config used; filter by config or status. Use for \"Show my latest Hume EVI chats\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_number":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100).","title":"Page Size"},"ascending_order":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for oldest first, false for newest first.","title":"Ascending Order"},"config_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only chats that used this config id.","title":"Config Id"},"status":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only chats with this status (a ChatStatus value such as ACTIVE or USER_ENDED).","title":"Status"}},"title":"list_chatsArguments","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_chat_events":{"post":{"operationId":"list_chat_events","summary":"List the events (user and agent messages, tool calls) of one EVI chat with role, type, time and message text. Use for \"W","description":"List the events (user and agent messages, tool calls) of one EVI chat with role, type, time and message text. Use for \"What was said in Hume EVI chat 8a3b1c2d\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"chat_id":{"description":"Chat id (UUID) from list_chats.","maxLength":200,"title":"Chat Id","type":"string"},"page_number":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100).","title":"Page Size"},"ascending_order":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for oldest first, false for newest first.","title":"Ascending Order"}},"required":["chat_id"],"title":"list_chat_eventsArguments","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_chat_groups":{"post":{"operationId":"list_chat_groups","summary":"List chat groups (chats that were resumed from each other) with chat counts and the most recent chat and config. Use for","description":"List chat groups (chats that were resumed from each other) with chat counts and the most recent chat and config. Use for \"Which Hume EVI chat groups exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_number":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100).","title":"Page Size"},"ascending_order":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for oldest first, false for newest first.","title":"Ascending Order"},"config_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only groups whose most recent chat used this config id.","title":"Config Id"}},"title":"list_chat_groupsArguments","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}}}}