{"openapi":"3.1.0","info":{"title":"Knit (BYOK) API","version":"0.1.0","description":"Knit (BYOK) lets an AI assistant read your own Knit data through the Knit API with a key you supply (Knit API key (API Keys page of the Knit dashboard; US region)). Read-only: 8 tools (list_leave_types, get_leave_balance, list_pay_periods, list_termination_reasons, list_document_categories, list_ats_departments, list_ats_rejection_reasons, list_ats_tags). The BYOK key travels with each request,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-knit.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-knit/docs"},"termsOfService":"https://connectorbay.com/byok-knit/terms"},"servers":[{"url":"https://byok-knit.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-knit/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_leave_types":{"post":{"operationId":"list_leave_types","summary":"List the leave types (vacation, sick, casual and similar) configured in the linked HR system. Use for \"Which leave types","description":"List the leave types (vacation, sick, casual and similar) configured in the linked HR system. Use for \"Which leave types does our HR system have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_leave_typesArguments","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_leave_balance":{"post":{"operationId":"get_leave_balance","summary":"Get the current-year leave balance of one employee per leave type: unit, remaining balance and used amount. Use for \"How","description":"Get the current-year leave balance of one employee per leave type: unit, remaining balance and used amount. Use for \"How much leave does employee 123 have left\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"employee_id":{"description":"Employee id in the linked HR system.","maxLength":100,"title":"Employee Id","type":"string"}},"required":["employee_id"],"title":"get_leave_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/list_pay_periods":{"post":{"operationId":"list_pay_periods","summary":"List the pay periods (name, dates, frequency, processing date, status) defined in the linked payroll system. No pay amou","description":"List the pay periods (name, dates, frequency, processing date, status) defined in the linked payroll system. No pay amounts. Use for \"What pay periods are defined in payroll\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_pay_periodsArguments","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_termination_reasons":{"post":{"operationId":"list_termination_reasons","summary":"List the termination reasons configured in the linked HR system. Use for \"Which termination reasons are configured\".","description":"List the termination reasons configured in the linked HR system. Use for \"Which termination reasons are configured\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_termination_reasonsArguments","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_categories":{"post":{"operationId":"list_document_categories","summary":"List the employee document categories (names only, no documents) of the linked HR system. Use for \"Which employee docume","description":"List the employee document categories (names only, no documents) of the linked HR system. Use for \"Which employee document categories exist\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_document_categoriesArguments","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_ats_departments":{"post":{"operationId":"list_ats_departments","summary":"List departments of the linked recruiting system with name, parent and timestamps. Use for \"Which departments exist in o","description":"List departments of the linked recruiting system with name, parent and timestamps. Use for \"Which departments exist in our ATS\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_token":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination token: the 'nextPageToken' value of the previous answer.","title":"Page Token"}},"title":"list_ats_departmentsArguments","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_ats_rejection_reasons":{"post":{"operationId":"list_ats_rejection_reasons","summary":"List the rejection reasons configured in the linked recruiting system. Use for \"Which rejection reasons can recruiters u","description":"List the rejection reasons configured in the linked recruiting system. Use for \"Which rejection reasons can recruiters use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_ats_rejection_reasonsArguments","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_ats_tags":{"post":{"operationId":"list_ats_tags","summary":"List the global candidate tags (names only, no candidates) of the linked recruiting system. Use for \"Which candidate tag","description":"List the global candidate tags (names only, no candidates) of the linked recruiting system. Use for \"Which candidate tags exist in our ATS\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_ats_tagsArguments","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}}}}