Apidog Docs
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. AI Features
  • Apidog Learning Center
  • Get started
    • Introduce Apidog
    • Basic concepts in Apidog
    • Navigating Apidog
    • Quick Start
      • Overview
      • Specify a new endpoint
      • Make a request to the endpoint
      • Add an assertion
      • Create a test scenario
      • Share your API documentation
      • Explore more
      • Send a request and save as an endpoint
    • Migration
      • Overview
      • Manual import
      • Scheduled import
      • Import options
      • Export data
      • Import from...
        • Import from Postman
        • Import OpenAPI (Swagger) spec
        • Import cURL
        • Import Markdowns
        • Import from Insomnia
        • Import from apiDoc
        • Import .har file
        • Import WSDL
  • Design APIs
    • Overview
    • Create a new API project
    • Endpoint basics
    • Components
    • Common fields
    • Global parameters
    • Endpoint change history
    • Batch endpoint management
    • Configure multiple request body examples
    • Schemas
      • Overview
      • Create a new schema
      • Build a schema
      • Generate Schemas from JSON etc.
    • Security schemes
      • Overview
      • Create a security scheme
      • Use the security scheme
      • Security scheme in online documentation
    • Advanced features
      • Custom endpoint fields
      • Import endpoints as test steps
      • Endpoint status
      • Appearance of parameter lists
      • Endpoint unique idenfication
  • Develop and Debug APIs
    • Overview
    • Generate requests
    • Send requests
    • Endpoint cases
    • Dynamic values
    • Validate responses
    • Design-first Mode & Request-first Mode
    • Generate code
    • Environments & variables
      • Overview
      • Using variables
      • Environments & services
    • Vault secrets
      • Overview
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Pre/Post processors
      • Overview
      • Assertion
      • Extract variable
      • Wait
      • Database operations
        • Overview
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
      • Using scripts
        • Overview
        • Pre processor scripts
        • Post processor scripts
        • Public scripts
        • Postman scripts reference
        • Calling other programming languages
        • Using JS libraries
        • Visualizing responses
        • Script examples
          • Assertion scripts
          • Using variables in scripts
          • Using scripts to modify request messages
          • Other examples
    • Dynamic values Modules
  • Mock API data
    • Overview
    • Smart mock
    • Custom mock
    • Mock priority sequence
    • Mock scripts
    • Cloud mock
    • Self-hosted runner mock
    • Mock language (Locales)
  • Automated tests
    • Overview
    • Test reports
    • Test scenarios
      • Create a test scenario
      • Pass data between requests
      • Flow control conditions
      • Import endpoints/endpoint cases from other projects
      • Sync data from endpoints/endpoint cases
      • Export test scenarios
    • Run test scenarios
      • Run a test scenario
      • Data-driven testing
      • Run test scenarios in batch
      • Scheduled tasks
      • Manage the runtime environment of APIs from other projects
    • Test APIs
      • Integration testing
      • Performance testing
      • End-to-end testing
      • Regression testing
    • Apidog CLI
      • Overview
      • Installing and running Apidog CLI
      • Apidog CLI Options
    • CI/CD
      • Overview
      • Integrate with Github Actions
      • Integrate with Jenkins
      • Integrate with Gitlab
      • Trigger Test by Git Commit
  • Publish API Docs
    • Overview
    • API Technologies Supported
    • Quick share
    • View the API documentation
    • Publish docs sites
    • Custom layouts
    • Custom domain
    • SEO settings
    • LLM-friendly Features
    • Advanced Settings
      • Documentation Search
      • CORS Proxy
      • Integrating Google Analytics with Doc Sites
      • Folder tree settings
      • Visibility settings
      • Embedding values in document URLs
    • API Versions
      • Create API versions
      • Publish API versions
      • Share endpoints with API versions
      • Overview
  • Send requests
    • Overview
    • gRPC
    • Use request proxy agents for debugging
    • SOAP/WebService
    • GraphQL
    • WebSocket
    • Socket.IO
    • SSE debugging
    • Create requests
      • Request History
      • Request basics
      • Parameters and body
      • Request headers
      • Request settings
      • HTTP/2
    • Authentication and authorization
      • Overview
      • CA and client certificates
      • Authorization types supported by Apidog
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Response and cookies
      • Overview
      • API response in Apidog
      • Create and send cookies
      • Debug requests
      • Save the request as an endpoint
  • Branches
    • Overview
    • Create a new sprint branch
    • Test APIs in a branch
    • Design API in a branch
    • Merge sprint branches
    • Manage sprint branches
  • AI Features
    • Overview
    • Enable AI Features
    • Modify Schemas with AI
    • FAQs
  • Apidog MCP Server
    • Overview
    • Connect API Specification within Apidog Project to AI via Apidog MCP Server
    • Connect Online API Documentation Published by Apidog to AI via Apidog MCP Server
    • Connect OpenAPI Files to AI via Apidog MCP Server
  • Best practices
    • How to handle API signatures
    • How to access OAuth 2.0 protected APIs
    • Apidog collaboration workflow
    • Managing authentication state in Apidog
  • Administration
    • Onboarding Checklist
      • Basic Concepts
      • Onboarding Guide
    • Managing Teams
      • Managing Teams
      • Managing Team Members
      • Member Roles & Permission Settings
      • Team Activities
      • Team Resources
        • General Runner
        • Team Variables
        • Request Proxy Agent
      • Real-time Collaborations
        • Team Collaboration
    • Managing Projects
      • Managing Projects
      • Managing Project Members
      • Notification Settings
      • Project Resources
        • Database Connection
    • Managing Organizations
      • Single Sign-On (SSO)
        • SSO Overview
        • Configure Microsoft Entra ID
        • Configure Okta
        • Configure SSO for an Organization
        • Managing user accounts
        • Mapping Groups to Teams
      • SCIM Provisioning
        • Intro to SCIM Provisioning
        • Microsoft Entra ID
        • Okta
      • Organization Resources
        • Self-hosted Runner
  • Billing
    • Overview
    • Credits
    • Unable to use credit cards?
    • Managing subscriptions
    • Upgrade plan
  • Data & Security
    • Where is Apidog's data stored, and how is data security ensured?
    • How is user data stored? Will this data be public? Or will it be private? Will all data be stored in the cloud?
    • When sending requests, do they go through the Apidog server? Is data security ensured?
  • Add-ons
    • API Hub
    • Apidog Intellij IDEA plugin
    • Browser Extension
      • Chrome
      • Microsoft Edge
    • Request Proxy
      • Request proxy in Apidog web
      • Request proxy in shared docs
      • Request proxy in Apidog client
  • Account & preferences
    • Account settings
    • Generate OpenAPI access token
    • Language settings
    • Hot keys
    • Network proxy configuration
    • Data backup
    • Updating Apidog
    • Deleting account
    • Experimental Features
  • References
    • API-Design First Approach
    • Apidog OpenAPI/Swagger Specificaiton Extensions
    • JSONPath
    • XPath
    • Regular Expressions
    • JSON Schema
    • CSV File Format
    • Install Java Environment
    • Runner deployment environment
    • Apidog flavored Markdown
  • Apidog Europe
    • Apidog Europe
  • Support Center
  1. AI Features

Enable AI Features

AI features in Apidog are disabled by default. To enable them, go to Organizations/Team – Resources – AI Features and switch them on. Once enabled, all projects within your organization or team can start using AI to boost productivity.
Only organization or team admins (or higher roles) can configure AI features.

Configure Model Providers#

Once AI features are enabled, you'll see an option to configure model providers. Click + Add Provider to start configuration.
image.png
Currently, Apidog supports the following model providers:
OpenAI
Anthropic
Google Al studio
Google Vertex
img_v3_02nl_16642d0d-72b2-4618-9a38-4eeef7db106g.png
If these providers don’t meet your needs, you can also use Custom API Configuration to connect other providers or locally deployed models.
Generally, you can customize the following settings:
1.
API Key
Enter the API Key provided by your chosen model provider. Use the Test function to check if the key is valid.
API Key Setup
2.
API Base URL
The actual URL to which requests are sent when using AI features in Apidog. For built-in providers, we pre-fill the base URL — you can edit it as needed.
Each request to the AI model is sent from the Apidog server to this API base URL.
3.
Model List
The list of models provided by the AI provider. If you’re using a preset provider, some models will appear by default. Only the models enabled in this list can be used for AI features. If a model you need isn’t listed, you can add it manually.
Apidog’sAI featurescome with preset prompts and invocation flows. To get the best results, be sure to select advanced, powerful models (supporting longer context, function calling, etc. for example: GPT-4.1-mini).
4.
API Format
Under Custom API Configuration, you can define the request and response format. Using the wrong format may cause API request to fail. Most models follow the OpenAI format.

Set Default Model#

If a user doesn’t specify a model when using AI features, Apidog will use the default model set here. You’ll see a dropdown with all models currently enabled — just choose the one you want to use by default.
image.png
The default model is set to "Auto Select" by default, which automatically picks an available model based on the order of enabled providers and models.
If you set a specific model as the default but it gets disabled or removed, Apidog will automatically switch back to "Auto Select".

Functions & Prompt#

You can manage all Apidog AI features and customize their prompts here. Once a feature is enabled, you’ll see it appear in the relevant section of your project. Apidog provides default prompts for each feature, which you can adjust to better suit your needs.
image.png
Custom prompt editing is not yet supported—stay tuned for future updates!

Inherit AI Configuration from Organization to Team#

When using organization management, organization admins or owners can set up AI features at the organization level. These settings can apply to all teams under the organization, helping you maintain consistency and simplify management across projects.
You’ll find the same AI Features configuration interface under Resources in the organization management page as you do at the team level.
image.png
Once AI features are set up at the organization level, all teams within the organization can inherit the configured model providers, default model, and functions.
image.png
Key points about team inheritance under organizations:
1.
All toggles — such as AI feature switches, model provider settings, default model selections, and functions — follow the organization’s configuration:
If a feature is enabled at the organization level, teams can choose to turn it on or off.
If a feature is disabled at the organization level, teams won’t be able to enable it.
This ensures centralized control and consistency across all teams.
image.png
2.
Model providers can either be inherited from the organization or set up independently by each team, depending on your needs.
image.png
3.
Teams can also choose to use the default model defined at the organization level or configure their own.
image.png
Modified at 2025-06-30 11:07:50
Previous
Overview
Next
Modify Schemas with AI
Built with