{"openapi":"3.1.0","info":{"title":"Vellum (BYOK) API","version":"0.1.0","description":"Vellum (BYOK) lets an AI assistant read your own Vellum data through the Vellum API with a key you supply (Vellum API key (scoped to one environment)). Read-only: 7 tools (list_prompt_deployments, get_prompt_deployment, list_workflow_deployments, get_workflow_deployment, list_workflow_executions, list_document_indexes, list_documents). The BYOK key travels with each request, is used for that one...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-vellum.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-vellum/docs"},"termsOfService":"https://connectorbay.com/byok-vellum/terms"},"servers":[{"url":"https://byok-vellum.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-vellum/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_prompt_deployments":{"post":{"operationId":"list_prompt_deployments","summary":"List prompt deployments with label, name, status, last deployment time and input variables. Use for \"Which prompts are d","description":"List prompt deployments with label, name, status, last deployment time and input variables. Use for \"Which prompts are deployed in Vellum\".","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 results per page (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first result to return, for paging.","title":"Offset"},"ordering":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Field to order by; prefix with - for descending, for example '-created'.","title":"Ordering"},"status":{"anyOf":[{"enum":["ACTIVE","ARCHIVED","PENDING_DELETION"],"type":"string"},{"type":"null"}],"default":null,"description":"Only items with this status: ACTIVE, ARCHIVED or PENDING_DELETION.","title":"Status"}},"title":"list_prompt_deploymentsArguments","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_prompt_deployment":{"post":{"operationId":"get_prompt_deployment","summary":"Get one prompt deployment by id or unique name. Use for \"Show the Vellum prompt deployment support-reply\".","description":"Get one prompt deployment by id or unique name. Use for \"Show the Vellum prompt deployment support-reply\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deployment":{"description":"Prompt deployment id or its unique name.","maxLength":200,"title":"Deployment","type":"string"}},"required":["deployment"],"title":"get_prompt_deploymentArguments","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_workflow_deployments":{"post":{"operationId":"list_workflow_deployments","summary":"List workflow deployments with label, name, status, last deployment time and input and output variables. Use for \"Which ","description":"List workflow deployments with label, name, status, last deployment time and input and output variables. Use for \"Which workflows are deployed in Vellum\".","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 results per page (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first result to return, for paging.","title":"Offset"},"ordering":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Field to order by; prefix with - for descending, for example '-created'.","title":"Ordering"},"status":{"anyOf":[{"enum":["ACTIVE","ARCHIVED","PENDING_DELETION"],"type":"string"},{"type":"null"}],"default":null,"description":"Only items with this status: ACTIVE, ARCHIVED or PENDING_DELETION.","title":"Status"}},"title":"list_workflow_deploymentsArguments","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_workflow_deployment":{"post":{"operationId":"get_workflow_deployment","summary":"Get one workflow deployment by id or unique name, with input and output variables. Use for \"Show the Vellum workflow dep","description":"Get one workflow deployment by id or unique name, with input and output variables. Use for \"Show the Vellum workflow deployment lead-triage\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deployment":{"description":"Workflow deployment id or its unique name.","maxLength":200,"title":"Deployment","type":"string"}},"required":["deployment"],"title":"get_workflow_deploymentArguments","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_workflow_executions":{"post":{"operationId":"list_workflow_executions","summary":"List recent executions of one workflow deployment with start and end time, inputs, outputs, errors and token usage. Use ","description":"List recent executions of one workflow deployment with start and end time, inputs, outputs, errors and token usage. Use for \"Did the last runs of Vellum workflow lead-triage fail\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"deployment":{"description":"Workflow deployment id or unique name.","maxLength":200,"title":"Deployment","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many executions per page (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first result to return, for paging.","title":"Offset"},"ordering":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Field to order by; prefix with - for descending, for example '-created'.","title":"Ordering"}},"required":["deployment"],"title":"list_workflow_executionsArguments","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_document_indexes":{"post":{"operationId":"list_document_indexes","summary":"List document indexes (searchable knowledge bases) with label, name, status and indexing configuration. Use for \"Which d","description":"List document indexes (searchable knowledge bases) with label, name, status and indexing configuration. Use for \"Which document indexes exist in Vellum\".","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 results per page (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first result to return, for paging.","title":"Offset"},"ordering":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Field to order by; prefix with - for descending, for example '-created'.","title":"Ordering"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only indexes whose name or label contains this text.","title":"Search"},"status":{"anyOf":[{"enum":["ACTIVE","ARCHIVED","PENDING_DELETION"],"type":"string"},{"type":"null"}],"default":null,"description":"Only items with this status: ACTIVE, ARCHIVED or PENDING_DELETION.","title":"Status"}},"title":"list_document_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/list_documents":{"post":{"operationId":"list_documents","summary":"List documents with processing state, keywords and the indexes they belong to; optionally only one index. Use for \"Which","description":"List documents with processing state, keywords and the indexes they belong to; optionally only one index. Use for \"Which documents are in Vellum index help-center\".","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 results per page (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first result to return, for paging.","title":"Offset"},"ordering":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Field to order by; prefix with - for descending, for example '-created'.","title":"Ordering"},"document_index_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only documents in this index (id or unique name).","title":"Document Index Id"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only documents matching this search term.","title":"Search"}},"title":"list_documentsArguments","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}}}}