{"openapi":"3.1.1","info":{"title":"Okapi API","version":"1.0.0","summary":"Breaking changes of third-party APIs, and a check of your code's calls against them.","description":"Okapi reads what API providers announce (endpoints removed, versions retired, models shut down) and checks API calls against it. Docs: https://www.okapi.bot/docs/api/. Free key: https://www.okapi.bot/app/api-keys/. The same data reaches agents through the MCP server, https://mcp.okapi.bot/mcp. Without a key, per client: 10 checks an hour (`anonymous_limit`), and 120 requests an hour to the other routes and the MCP server together (`keyless_limit`).","termsOfService":"https://www.okapi.bot/terms/#api","license":{"name":"Okapi's API terms","url":"https://www.okapi.bot/terms/#api"},"contact":{"name":"Okapi","email":"hello@okapi.bot","url":"https://www.okapi.bot/docs/api/"}},"externalDocs":{"description":"Docs","url":"https://www.okapi.bot/docs/api/"},"servers":[{"url":"https://api.okapi.bot/v1"}],"security":[{"okapiKey":[]}],"tags":[{"name":"Check","description":"Your calls against every breaking change."},{"name":"Breaking changes","description":"Providers' breaking changes, by provider or one at a time."},{"name":"Providers","description":"Find a provider and its slug."},{"name":"Keys","description":"Your plan, your usage, your keys."}],"paths":{"/check":{"post":{"operationId":"checkCalls","tags":["Check"],"summary":"Check API calls against every breaking change","description":"Send the calls your code makes; each comes back with its status and the breaking changes that hit it. Without a key: 25 calls a request, 10 requests an hour, the changes providers announced only. With a free key: 100 calls a request, every change, each call counted against the month.","security":[{},{"okapiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["calls"],"properties":{"calls":{"type":"array","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/CheckCall"}}}},"example":{"calls":[{"method":"POST","url":"https://api.openai.com/v1/chat/completions","models":["gpt-4-0613"]}]}}}},"responses":{"200":{"description":"Each call, in the order sent.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAnswer"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/breaking-changes":{"get":{"operationId":"listBreakingChanges","tags":["Breaking changes"],"summary":"Search providers' breaking changes","description":"The breaking changes of 1 to 10 providers, those to come first. One call of the month a page; 25 different providers a month.","parameters":[{"name":"providers","in":"query","required":true,"description":"Providers' slugs, comma-separated: `openai,stripe-api`. Find one with GET /providers.","schema":{"type":"string"},"example":"openai,anthropic"},{"name":"kind","in":"query","schema":{"type":"string","enum":["removal","version_retirement","behaviour_change","model_retirement"]}},{"name":"when","in":"query","description":"upcoming (to come or undated), past (in effect within a year), or all.","schema":{"type":"string","enum":["upcoming","past","all"],"default":"upcoming"}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"cursor","in":"query","description":"From the page before: follow `next` rather than building it.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of changes, and the next.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BreakingChangePage"},"example":{"data":[{"id":"openai/gpt-4o","provider":{"slug":"openai","name":"OpenAI","host":"api.openai.com","page":"https://www.okapi.bot/providers/openai/"},"title":"gpt-4o stops working","kind":"model_retirement","outcome":"fails","status":"upcoming","announcedAt":"2026-07-14","effectiveAt":"2027-01-14","model":"gpt-4o","targets":{"models":"gpt-4o"},"summary":"OpenAI shuts down gpt-4o on January 14, 2027.","migration":"Send gpt-5.6 instead.","page":"https://www.okapi.bot/models/openai/gpt-4o/"}],"next":null}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/breaking-changes/{provider}/{slug}":{"get":{"operationId":"getBreakingChange","tags":["Breaking changes"],"summary":"Read one breaking change","description":"By its id, the end of its okapi.bot page address: `/models/openai/gpt-4o/` is `openai/gpt-4o`. One call of the month, found or not.","parameters":[{"name":"provider","in":"path","required":true,"schema":{"type":"string"},"example":"openai"},{"name":"slug","in":"path","required":true,"description":"The rest of the id; it may hold slashes (`inception/mercury-2`).","schema":{"type":"string"},"example":"gpt-4o"}],"responses":{"200":{"description":"The change.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BreakingChange"},"example":{"id":"openai/gpt-4o","provider":{"slug":"openai","name":"OpenAI","host":"api.openai.com","page":"https://www.okapi.bot/providers/openai/"},"title":"gpt-4o stops working","kind":"model_retirement","outcome":"fails","status":"upcoming","announcedAt":"2026-07-14","effectiveAt":"2027-01-14","model":"gpt-4o","targets":{"models":"gpt-4o"},"summary":"OpenAI shuts down gpt-4o on January 14, 2027.","migration":"Send gpt-5.6 instead.","page":"https://www.okapi.bot/models/openai/gpt-4o/"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/providers":{"get":{"operationId":"searchProviders","tags":["Providers"],"summary":"Find providers by name, host or slug","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":80},"example":"stripe"}],"responses":{"200":{"description":"Up to 10 providers, an exact name first.","headers":{"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Provider"}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/keys":{"get":{"operationId":"listKeys","tags":["Keys"],"summary":"Your plan, this month's usage and your keys","responses":{"200":{"description":"Never a key itself.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}},"/keys/{id}":{"delete":{"operationId":"deleteKey","tags":["Keys"],"summary":"Revoke one of your keys","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Revoked."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}}}}},"components":{"securitySchemes":{"okapiKey":{"type":"http","scheme":"bearer","bearerFormat":"okapi_<48 hex>","description":"A free key from https://www.okapi.bot/app/api-keys/"}},"schemas":{"Problem":{"type":"object","description":"RFC 9457 problem details, with Okapi's `code` for programs to switch on.","required":["type","title","status","detail","code"],"properties":{"type":{"type":"string","format":"uri","example":"https://www.okapi.bot/docs/api/#monthly_limit"},"title":{"type":"string","example":"Monthly limit reached"},"status":{"type":"integer","example":429},"detail":{"type":"string","example":"This account's 10000 calls a month are used; the count starts again in 2073600 s."},"code":{"type":"string","example":"monthly_limit"}},"additionalProperties":true},"CheckCall":{"type":"object","description":"One API call your code makes: at least a url, a model or an SDK.","properties":{"method":{"type":"string","example":"POST"},"url":{"type":"string","maxLength":2048,"example":"https://api.openai.com/v1/chat/completions"},"models":{"type":"array","items":{"type":"string"},"maxItems":10,"example":["gpt-4-0613"]},"params":{"type":"array","items":{"type":"string"},"maxItems":30,"example":["temperature"]},"headers":{"type":"object","additionalProperties":{"type":"string"},"description":"Every version header the call sends, name and literal value; `{}` when it sends none, so the changes for calls without one apply. Left out, Okapi cannot tell. Never a secret.","example":{"anthropic-version":"2023-06-01"}},"sdk":{"type":"object","required":["package"],"properties":{"package":{"type":"string"},"version":{"type":"string"},"symbol":{"type":"string"}}},"operation":{"type":"object","description":"For MCP and A2A calls.","properties":{"protocol":{"type":"string","enum":["mcp","a2a","json-rpc"]},"name":{"type":"string"}}}}},"CallBreakingChange":{"type":"object","properties":{"title":{"type":"string"},"level":{"type":"string"},"origin":{"type":"string","enum":["announced","inferred"]},"outcome":{"type":"string"},"matchedOn":{"type":"array","items":{"type":"string"}},"announcedAt":{"type":["string","null"],"format":"date"},"effectiveAt":{"type":["string","null"],"format":"date"},"migration":{"type":["string","null"]},"scope":{"type":["string","null"]},"source":{"type":"string","format":"uri"},"page":{"type":["string","null"],"format":"uri","description":"Its okapi.bot page: link it when you show it."}}},"CheckedCall":{"type":"object","required":["index","status","breakingChanges"],"properties":{"index":{"type":"integer","description":"The call's place in the request."},"status":{"type":"string","enum":["broken","at_risk","redirected","deprecated","ok","unknown","file"]},"provider":{"type":["object","null"],"properties":{"name":{"type":"string"},"host":{"type":"string"},"slug":{"type":["string","null"]},"page":{"type":["string","null"]},"watched":{"type":"boolean"}}},"breakingChanges":{"type":"array","items":{"$ref":"#/components/schemas/CallBreakingChange"}},"hiddenInferred":{"type":"integer","description":"Without a key: the changes Okapi inferred, left out."}}},"CheckAnswer":{"type":"object","required":["checkedAt","calls"],"properties":{"checkedAt":{"type":"string","format":"date-time"},"calls":{"type":"array","items":{"$ref":"#/components/schemas/CheckedCall"}},"notice":{"type":"string","description":"Without a key: what a free key would add."}}},"BreakingChange":{"type":"object","required":["id","provider","title","kind","status","page"],"properties":{"id":{"type":"string","description":"provider/slug, the end of its page address.","example":"openai/gpt-4o"},"provider":{"$ref":"#/components/schemas/ProviderRef"},"title":{"type":"string","example":"gpt-4o stops working"},"kind":{"type":"string","enum":["removal","version_retirement","behaviour_change","model_retirement"]},"outcome":{"type":"string"},"status":{"type":"string","enum":["upcoming","deprecated","in_effect"]},"announcedAt":{"type":["string","null"],"format":"date"},"effectiveAt":{"type":["string","null"],"format":"date"},"model":{"type":["string","null"]},"targets":{"type":"object","description":"What it hits: method, path, parameter, header, models, sdk, protocol, tool."},"summary":{"type":["string","null"]},"migration":{"type":["string","null"]},"scope":{"type":["string","null"]},"source":{"type":"string","format":"uri","description":"The provider's own page."},"quote":{"type":["string","null"]},"page":{"type":"string","format":"uri","description":"Its okapi.bot page: link it when you show it."}}},"BreakingChangePage":{"type":"object","required":["data","next"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BreakingChange"}},"next":{"type":["string","null"],"format":"uri","description":"The next page, null on the last."}}},"ProviderRef":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"},"host":{"type":"string"},"page":{"type":"string","format":"uri"}}},"Provider":{"type":"object","properties":{"slug":{"type":"string","example":"openai"},"name":{"type":"string","example":"OpenAI"},"host":{"type":"string","example":"api.openai.com"},"page":{"type":"string","format":"uri"},"changes":{"type":"integer","description":"Breaking changes Okapi publishes for it."}}},"Key":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":["string","null"]},"prefix":{"type":"string","example":"okapi_1a2b3c4d"},"createdAt":{"type":"string","format":"date-time"},"lastUsedAt":{"type":["string","null"],"format":"date-time"},"revokedAt":{"type":["string","null"],"format":"date-time"},"callsThisMonth":{"type":"integer"}}},"Account":{"type":"object","properties":{"plan":{"type":"object","properties":{"name":{"type":"string","example":"free"},"callsPerMonth":{"type":"integer","example":10000},"requestsPerMinute":{"type":"integer","example":30},"providersPerMonth":{"type":"integer","example":25}}},"usage":{"type":"object","properties":{"calls":{"type":"integer"},"providers":{"type":"integer"},"resetsAt":{"type":"string","format":"date-time"}}},"keys":{"type":"array","items":{"$ref":"#/components/schemas/Key"}}}}},"headers":{"RateLimit":{"description":"What is left of each quota: `\"minute\"; r=29; t=60, \"month\"; r=9958; t=2073600`. Without a key: `\"hour\"; r=9; t=3540` on a check, `\"keyless\"; r=119; t=3540` on the other routes.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"The quotas: `\"minute\"; q=30; w=60, \"month\"; q=10000; w=2592000` with a key. Without one: checks `\"hour\"; q=10; w=3600`, every other request `\"keyless\"; q=120; w=3600`, per client.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds to wait, on a 429.","schema":{"type":"integer"}}},"responses":{"BadRequest":{"description":"The request is not valid: `detail` says what to fix (`errors` per field).","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"Unauthorized":{"description":"No key, or a key that is not valid or was revoked.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"NotFound":{"description":"No such provider or change.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"TooManyRequests":{"description":"A limit is reached, its `code` saying which: `minute_limit` (the tier's requests a minute), `monthly_limit` (its calls a month), `provider_limit` (the providers searched this month), `anonymous_limit` (checks without a key: 10 an hour per client) or `keyless_limit` (other requests without a key: 120 an hour per client). Its RateLimit headers describe that limit.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"headers":{"Retry-After":{"$ref":"#/components/headers/Retry-After"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"}}}}}}