{"openapi":"3.1.0","info":{"title":"Hedra (BYOK) API","version":"0.1.0","description":"Hedra (BYOK) lets an AI assistant read your own Hedra data through the Hedra API with a key you supply (Hedra API key in the form key_id:secret). Read-only: 10 tools (get_balance, get_usage, list_transactions, list_models, get_model, list_model_voices, search_model_voices, list_jobs, list_model_jobs, get_job_status). The BYOK key travels with each request, is used for that one call only and is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-hedra.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-hedra/docs"},"termsOfService":"https://connectorbay.com/byok-hedra/terms"},"servers":[{"url":"https://byok-hedra.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-hedra/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/get_balance":{"post":{"operationId":"get_balance","summary":"Show the API wallet balance, amount spent and currency. Use for \"How much Hedra API balance do I have left\".","description":"Show the API wallet balance, amount spent and currency. Use for \"How much Hedra API balance do I have left\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_balanceArguments","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_usage":{"post":{"operationId":"get_usage","summary":"Summarize jobs, requests and spend over a time window, as one total, one row per UTC day or one row per model. Use for \"","description":"Summarize jobs, requests and spend over a time window, as one total, one row per UTC day or one row per model. Use for \"How much did I spend on Hedra per model in the last week\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"start":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Window start (inclusive, ISO 8601); defaults to 7 days before end.","title":"Start"},"end":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Window end (exclusive, ISO 8601); defaults to now. The window is capped at 90 days.","title":"End"},"group_by":{"anyOf":[{"enum":["total","day","model"],"type":"string"},{"type":"null"}],"default":"total","description":"total, day or model.","title":"Group By"}},"title":"get_usageArguments","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_transactions":{"post":{"operationId":"list_transactions","summary":"List wallet movements, newest first: funds added, jobs charged, refunds and corrections. Use for \"What were my latest He","description":"List wallet movements, newest first: funds added, jobs charged, refunds and corrections. Use for \"What were my latest Hedra wallet transactions\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (1 to 100).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"The next_cursor from the previous answer, to get the next page.","title":"Cursor"}},"title":"list_transactionsArguments","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_models":{"post":{"operationId":"list_models","summary":"List the image, video and audio models available through Hedra with modality and price description. Use for \"Which Hedra","description":"List the image, video and audio models available through Hedra with modality and price description. Use for \"Which Hedra video models are available and what do they cost\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"modality":{"anyOf":[{"enum":["image","video","audio"],"type":"string"},{"type":"null"}],"default":null,"description":"Only models of this modality: image, video or audio.","title":"Modality"}},"title":"list_modelsArguments","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_model":{"post":{"operationId":"get_model","summary":"Get one model's modality, description and price description. Use for \"What does the Hedra model veo-31 cost\".","description":"Get one model's modality, description and price description. Use for \"What does the Hedra model veo-31 cost\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"model":{"description":"Model id as listed by list_models, for example 'veo-31'.","maxLength":200,"title":"Model","type":"string"}},"required":["model"],"title":"get_modelArguments","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_model_voices":{"post":{"operationId":"list_model_voices","summary":"List the voices a model accepts: the shared library plus your own cloned voices. Use for \"Which voices can the Hedra mod","description":"List the voices a model accepts: the shared library plus your own cloned voices. Use for \"Which voices can the Hedra model elevenlabs-v3 use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"model":{"description":"Audio-capable model id from list_models, for example 'elevenlabs-v3'.","maxLength":200,"title":"Model","type":"string"}},"required":["model"],"title":"list_model_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/search_model_voices":{"post":{"operationId":"search_model_voices","summary":"Search a model's voices by a plain-language description such as 'warm british narrator', optionally filtered by gender o","description":"Search a model's voices by a plain-language description such as 'warm british narrator', optionally filtered by gender or language. Use for \"Find a warm British narrator voice for the Hedra model elevenlabs-v3\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"model":{"description":"Audio-capable model id from list_models, for example 'elevenlabs-v3'.","maxLength":200,"title":"Model","type":"string"},"q":{"description":"What the voice should sound like, in plain words.","maxLength":200,"title":"Q","type":"string"},"limit":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many voices to return (1 to 50).","title":"Limit"},"gender":{"anyOf":[{"enum":["male","female"],"type":"string"},{"type":"null"}],"default":null,"description":"Only voices with this label: male or female.","title":"Gender"},"language":{"anyOf":[{"maxLength":8,"type":"string"},{"type":"null"}],"default":null,"description":"Only voices curated for this ISO 639-1 language code, for example 'en'.","title":"Language"}},"required":["model","q"],"title":"search_model_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_jobs":{"post":{"operationId":"list_jobs","summary":"List recent generation jobs with model, status (IN_QUEUE, IN_PROGRESS, COMPLETED or FAILED) and creation time. Use for \"","description":"List recent generation jobs with model, status (IN_QUEUE, IN_PROGRESS, COMPLETED or FAILED) and creation time. Use for \"Which of my Hedra jobs are still in progress\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (1 to 100).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"The next_cursor from the previous answer, to get the next page.","title":"Cursor"}},"title":"list_jobsArguments","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_model_jobs":{"post":{"operationId":"list_model_jobs","summary":"List recent generation jobs of one model with status and creation time. Use for \"Show my latest jobs for the Hedra model","description":"List recent generation jobs of one model with status and creation time. Use for \"Show my latest jobs for the Hedra model veo-31\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"model":{"description":"Model id from list_models, for example 'veo-31'.","maxLength":200,"title":"Model","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (1 to 100).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"The next_cursor from the previous answer, to get the next page.","title":"Cursor"}},"required":["model"],"title":"list_model_jobsArguments","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_job_status":{"post":{"operationId":"get_job_status","summary":"Check the status of one generation job: status, progress and estimated completion time. Use for \"Is my Hedra job job_123","description":"Check the status of one generation job: status, progress and estimated completion time. Use for \"Is my Hedra job job_123 done yet\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"job_id":{"description":"Job id in the form job_<uuid>, as returned by list_jobs.","maxLength":200,"title":"Job Id","type":"string"}},"required":["job_id"],"title":"get_job_statusArguments","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}}}}