{"openapi":"3.1.0","info":{"title":"Arbeitsagentur BERUFENET (BYOK) API","version":"0.1.0","description":"Arbeitsagentur BERUFENET (BYOK) lets an AI assistant read your own Arbeitsagentur BERUFENET data through the Arbeitsagentur BERUFENET API with a key you supply (client id of BERUFENET (X-API-Key)). Read-only: 5 tools (search_occupations, list_occupations_by_letter, list_occupations_by_cluster, list_occupations_by_group, list_all_occupations). The BYOK key travels with each request, is used for...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-berufenet.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-berufenet/docs"},"termsOfService":"https://connectorbay.com/byok-berufenet/terms"},"servers":[{"url":"https://byok-berufenet.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-berufenet/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/search_occupations":{"post":{"operationId":"search_occupations","summary":"Search the BERUFENET occupation list by search words that appear in the occupation information; * lists all occupations.","description":"Search the BERUFENET occupation list by search words that appear in the occupation information; * lists all occupations. 20 entries per page. Use for \"Which occupations mention 'Pflege' in BERUFENET\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search_words":{"description":"Words that should appear in the occupation information, for example 'Pflege'; * matches all.","maxLength":100,"title":"Search Words","type":"string"},"page":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0; 20 entries per page.","title":"Page"}},"required":["search_words"],"title":"search_occupationsArguments","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_occupations_by_letter":{"post":{"operationId":"list_occupations_by_letter","summary":"List occupations whose name starts with a given letter (two entries starting with a digit cannot be listed this way). 20","description":"List occupations whose name starts with a given letter (two entries starting with a digit cannot be listed this way). 20 entries per page. Use for \"List BERUFENET occupations starting with B\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"letter":{"description":"First letter of the occupation name, one character a to z.","maxLength":1,"title":"Letter","type":"string"},"page":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0; 20 entries per page.","title":"Page"}},"required":["letter"],"title":"list_occupations_by_letterArguments","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_occupations_by_cluster":{"post":{"operationId":"list_occupations_by_cluster","summary":"List occupations in a thematic occupation cluster, for example regulated occupations, mathematics, computer science, nat","description":"List occupations in a thematic occupation cluster, for example regulated occupations, mathematics, computer science, natural science or technology. Use for \"Which occupations are regulated professions\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cluster":{"description":"Cluster code, comma-separated for several: 'TC 0201' regulated occupations, 'TC 101' mathematics, 'TC 0102' computer science, 'TC 0103' natural science, 'TC 104' technology.","maxLength":60,"title":"Cluster","type":"string"},"page":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0; 20 entries per page.","title":"Page"}},"required":["cluster"],"title":"list_occupations_by_clusterArguments","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_occupations_by_group":{"post":{"operationId":"list_occupations_by_group","summary":"List occupations by occupation group: training occupations, further-training occupations, degree subjects, university oc","description":"List occupations by occupation group: training occupations, further-training occupations, degree subjects, university occupations, civil-service careers or other job options. Use for \"Which degree subjects does BERUFENET list\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"group":{"description":"Group code, comma-separated for several: 100/102/105 training occupations, 200/201/203/204 further-training occupations, 300/301/302 degree subjects, 400/401/402 university occupations, 500/503 civil-service careers, 700 other job options.","maxLength":60,"title":"Group","type":"string"},"page":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0; 20 entries per page.","title":"Page"}},"required":["group"],"title":"list_occupations_by_groupArguments","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_all_occupations":{"post":{"operationId":"list_all_occupations","summary":"List all occupations of BERUFENET page by page (20 per page) without any filter. Use for \"Give me page 2 of all BERUFENE","description":"List all occupations of BERUFENET page by page (20 per page) without any filter. Use for \"Give me page 2 of all BERUFENET occupations\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search_words":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":"*","description":"Search words; the default * lists every occupation.","title":"Search Words"},"page":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0; 20 entries per page.","title":"Page"}},"title":"list_all_occupationsArguments","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}}}}