openapi

KrosAI provides a complete OpenAPI 3.0 specification for the API.

Specification URL

https://api.krosai.com/v1/openapi.json

Using the Specification

Generate Client Libraries

npx @openapitools/openapi-generator-cli generate \
  -i https://api.krosai.com/v1/openapi.json \
  -g typescript-fetch \
  -o ./krosai-client

Import into Postman

1

Open Postman

Open the Postman application.

2

Import

Click Import.

3

Select Link.

4

Paste URL

Paste:

https://api.krosai.com/v1/openapi.json
5

Import File

Click Import.

Import into Insomnia

1

Open Insomnia

Open the Insomnia application.

2

Import/Export

Click Import/ExportImport Data.

3

From URL

Select From URL.

4

Enter URL

Enter:

https://api.krosai.com/v1/openapi.json

Specification Structure

Interactive Documentation

Visit our interactive API explorer:

API Explorerarrow-up-right

Features:

  • Try API calls directly

  • View request/response examples

  • Authenticate with your API key

  • Copy code samples

Versioning

The API follows semantic versioning:

  • Major versions (v1, v2): Breaking changes

  • Minor updates: Backwards-compatible additions

  • Patch updates: Bug fixes

The current version is v1. We maintain backwards compatibility within major versions.

Changelog

v1.0.0 (Current)

  • Initial public release

  • Phone Numbers API

  • Endpoints API

  • Calls API

  • Outbound Calls API

  • Webhooks API

Upcoming

  • v1.1.0: SDK session API improvements

  • v1.2.0: Enhanced analytics endpoints

SDKs

We recommend using official SDKs rather than generating clients:

SDK Documentationarrow-up-right

Next Steps