{"openapi":"3.1.0","info":{"title":"Arbeitsagentur Ausbildungssuche (BYOK) API","version":"0.1.0","description":"Arbeitsagentur Ausbildungssuche (BYOK) lets an AI assistant read your own Arbeitsagentur Ausbildungssuche data through the Arbeitsagentur Ausbildungssuche API with a key you supply (client id of the Ausbildungssuche (X-API-Key)). Read-only: 6 tools (search_training_offers, search_training_by_occupation, search_training_by_type, search_training_by_provider, search_training_with_voucher,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-ausbildungssuche.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-ausbildungssuche/docs"},"termsOfService":"https://connectorbay.com/byok-ausbildungssuche/terms"},"servers":[{"url":"https://byok-ausbildungssuche.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-ausbildungssuche/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_training_offers":{"post":{"operationId":"search_training_offers","summary":"Search training offers (Ausbildungsangebote) by offer group, occupation, place, radius, state and training type. Returns","description":"Search training offers (Ausbildungsangebote) by offer group, occupation, place, radius, state and training type. Returns dated offers with provider, duration, form of teaching and degree. Use for \"Which vocational training offers exist in Bavaria\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"training_group":{"anyOf":[{"enum":[0,1,2,3,4],"type":"integer"},{"type":"null"}],"default":null,"description":"Offer group: 0 vocational training, 1 school leaving certificate, 2 preparation for training or work, 3 accompanying help, 4 all.","title":"Training Group"},"occupation_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Occupation id (Berufs-ID) from the agency's occupation list, for example 2927; several ids may be comma-separated.","title":"Occupation Id"},"place_id":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Place id (Ort-ID), for example 38450; several ids may be comma-separated.","title":"Place Id"},"radius":{"anyOf":[{"enum":["Bundesweit","25","50","100","150","200"],"type":"string"},{"type":"null"}],"default":null,"description":"Search radius around the place: Bundesweit (nationwide), 25, 50, 100, 150 or 200 kilometres.","title":"Radius"},"state":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Federal state code (BAW, BAY, BER, BRA, BRE, HAM, HES, MBV, NDS, NRW, RPF, SAA, SAC, SAN, SLH, THÜ, or - for nationwide offers); several codes may be comma-separated, for example 'BAY,BAW'.","title":"State"},"page":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page"},"size":{"anyOf":[{"maximum":2000,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 2000; at most 10000 results over all pages).","title":"Size"}},"title":"search_training_offersArguments","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_training_by_occupation":{"post":{"operationId":"search_training_by_occupation","summary":"Search training offers for one occupation id, nationwide or limited to a state. Use for \"Which training offers exist for","description":"Search training offers for one occupation id, nationwide or limited to a state. Use for \"Which training offers exist for occupation 2927\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"occupation_id":{"description":"Occupation id (Berufs-ID), for example 2927; several ids may be comma-separated.","maxLength":60,"title":"Occupation Id","type":"string"},"state":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Federal state code (BAW, BAY, BER, BRA, BRE, HAM, HES, MBV, NDS, NRW, RPF, SAA, SAC, SAN, SLH, THÜ, or - for nationwide offers); several codes may be comma-separated, for example 'BAY,BAW'.","title":"State"},"page":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page"},"size":{"anyOf":[{"maximum":2000,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 2000; at most 10000 results over all pages).","title":"Size"}},"required":["occupation_id"],"title":"search_training_by_occupationArguments","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_training_by_type":{"post":{"operationId":"search_training_by_type","summary":"Search offers of one training type such as 102 vocational training, 105 catching up on a degree, 107108 degree programme","description":"Search offers of one training type such as 102 vocational training, 105 catching up on a degree, 107108 degree programmes, 109 retraining. Use for \"Which offers let me catch up on a school degree in Berlin\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"training_type":{"description":"Training type: 0 unassigned, 100 general education, 101 partial qualification, 102 vocational training, 103 regulated further training, 104 further training, 105 catch up on a degree, 106 rehabilitation, 107108 degree programme, 109 retraining.","enum":["0","100","101","102","103","104","105","106","107108","109"],"title":"Training Type","type":"string"},"state":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Federal state code (BAW, BAY, BER, BRA, BRE, HAM, HES, MBV, NDS, NRW, RPF, SAA, SAC, SAN, SLH, THÜ, or - for nationwide offers); several codes may be comma-separated, for example 'BAY,BAW'.","title":"State"},"page":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page"},"size":{"anyOf":[{"maximum":2000,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 2000; at most 10000 results over all pages).","title":"Size"}},"required":["training_type"],"title":"search_training_by_typeArguments","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_training_by_provider":{"post":{"operationId":"search_training_by_provider","summary":"Search offers of one training provider by its provider id (Bildungsanbieter-ID). Use for \"Which training offers does pro","description":"Search offers of one training provider by its provider id (Bildungsanbieter-ID). Use for \"Which training offers does provider 465 run\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"provider_id":{"description":"Provider id, for example 465; several ids may be comma-separated.","maxLength":60,"title":"Provider Id","type":"string"},"page":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page"},"size":{"anyOf":[{"maximum":2000,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 2000; at most 10000 results over all pages).","title":"Size"}},"required":["provider_id"],"title":"search_training_by_providerArguments","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_training_with_voucher":{"post":{"operationId":"search_training_with_voucher","summary":"Search offers that are approved for funding with an education voucher (Bildungsgutschein). Use for \"Which offers in Hamb","description":"Search offers that are approved for funding with an education voucher (Bildungsgutschein). Use for \"Which offers in Hamburg accept an education voucher\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"voucher_only":{"description":"True to show only offers approved for funding with an education voucher.","title":"Voucher Only","type":"boolean"},"state":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Federal state code (BAW, BAY, BER, BRA, BRE, HAM, HES, MBV, NDS, NRW, RPF, SAA, SAC, SAN, SLH, THÜ, or - for nationwide offers); several codes may be comma-separated, for example 'BAY,BAW'.","title":"State"},"page":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page"},"size":{"anyOf":[{"maximum":2000,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (1 to 2000; at most 10000 results over all pages).","title":"Size"}},"required":["voucher_only"],"title":"search_training_with_voucherArguments","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_training_offer":{"post":{"operationId":"get_training_offer","summary":"Get the details of one training offer by id: provider, teaching form, duration, costs, funding, start and end dates, reg","description":"Get the details of one training offer by id: provider, teaching form, duration, costs, funding, start and end dates, registration deadline and number of participants. Use for \"Show training offer 17885\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"offer_id":{"description":"Id of a training offer (the id of an entry returned by the search tools).","minimum":1,"title":"Offer Id","type":"integer"}},"required":["offer_id"],"title":"get_training_offerArguments","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}}}}