Skip to content

Enhance OpenAPI documentation with usage guidelines and examples #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion fern/api-reference/openapi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,40 @@ title: OpenAPI
slug: api-reference/openapi
---


<Check>
Our OpenAPI is hosted at
[https://api.vapi.ai/api-json](https://api.vapi.ai/api-json)
</Check>

## What's New

Our OpenAPI specification has been significantly updated with comprehensive improvements and additions. The specification now includes enhanced endpoint documentation, improved data models, and expanded API coverage to better serve your development needs.

## Using the OpenAPI Specification

The OpenAPI specification provides a complete reference for all available API endpoints, request/response schemas, and authentication methods. You can use this specification to:

- Generate client libraries in your preferred programming language
- Import into API testing tools like Postman or Insomnia
- Integrate with API documentation tools
- Validate API requests and responses

## Integration Examples

You can easily integrate our OpenAPI specification into your development workflow:

```bash
# Download the OpenAPI specification
curl https://api.vapi.ai/api-json -o vapi-openapi.json
```

```javascript
// Example: Using the specification with OpenAPI Generator
// Generate a client library for your preferred language
npx @openapitools/openapi-generator-cli generate \
-i https://api.vapi.ai/api-json \
-g javascript \
-o ./vapi-client
```

For the most up-to-date API reference and detailed endpoint documentation, always refer to the live OpenAPI specification at the URL above.
Loading