Skip to main content

API Copilot

API Copilot is an AI assistant integrated into APIMatic's Developer Portal. It allows developers to describe their integration requirements in natural language and receive precise answers as well as working code tailored to their specific use case and programming language.

Developers typically search through multiple API documentation pages to understand API behavior and then write code to implement their desired use case. API Copilot combines these steps into a single chat interface where developers can request and receive complete code for their integration scenarios.

Experience API Copilot firsthand on the Spotify Web API Developer Portal - a live implementation showcasing its capabilities.

Features

Hallucination-Free Code Generation

Generates accurate code based on APIMatic-generated SDKs and code samples, eliminating the possibility of hallucination.

Natural Language Query Processing

Processes complex integration requirements described in plain English, including multi-endpoint scenarios and workflow combinations.

API Use Case Guidance

Provides step-by-step code explanations alongside generated snippets for any API use case.

24/7 Instant Assistance

Delivers immediate responses without human intervention, scaling support capacity and reducing documentation dependency.

Customizable Prompt Suggestions

Allows portal owners to configure welcome messages with suggested queries that help developers discover API capabilities and common integration patterns.

Enable API Copilot using the CLI

Run the copilot configuration command to set up your AI assistant:

apimatic portal copilot

Learn more about the portal copilot command in the CLI Reference.

Enable API Copilot using the Web UI

To start using API Copilot on your portal, follow these easy steps:

  1. Go to the API Copilot page in the portal editor.
  2. Turn on the switch to enable it.
  3. Customize the user's experience by adding a welcome message and suggestive prompts.
  4. Save your settings.
  5. Publish your portal.