Apidog API
    • Introduction
    • API Versions
    • Authentication
    • Import & Export
      • Import OpenAPI/Swagger Data
        POST
      • Import Postman Collection Data
        POST
      • Export Data in OpenAPI/Swagger Format
        POST
    • Team Access Grants
      • Assign a team role via the external API
        POST
    • Project Access
      • Find Team Projects by Exact Match
        GET
      • Find Accessible Teams by Exact Match
        GET
      • Grant or Invite Project Access
        POST
      • List Available Project Roles for a Team
        GET
    • Organization Teams
      • Create organization team
        POST
    • Apidog CLI
      • Overview
      • Installing Apidog CLI
      • Apidog CLI Commands & Options
      • Use Apidog CLI with an AI Agent
    • Schemas
      • TeamRole
      • ErrorResponse
      • ProjectAccessMode
      • CreateTeamAccessGrantRequest
      • TeamAccessGrant
      • CreateTeamAccessGrantResponse

    Introduction

    Welcome to the Apidog OpenAPI documentation. This document serves as a comprehensive guide to the public REST APIs provided by Apidog.

    Common Components for Requesting APIs#

    Path#

    All API URLs begin with one the following two base URLs
    Apidog Global: https://api.apidog.com.
    Apidog Europe: https://api.eu.apidog.com.
    If your test scenario or test suite was created in Apidog Europe, specify the EU API base URL with --api-base-url:
    apidog run --access-token xxx -t xxx -e xxx -n 1 -r html,cli --api-base-url https://api.eu.apidog.com

    Header#

    A common header is used for API version control. For detailed information, please refer to the API Version Documentation.

    Authorization#

    Apidog's OpenAPI utilizes the Bearer Token authorization method. Requesting Apidog's APIs requires an access token. For detailed instructions, please refer to the Authorization Documentation.

    Using Apidog CLI#

    The REST APIs in this reference support specific Apidog automation workflows. However, not every Apidog resource or operation has a documented REST endpoint. When there is a need for broader access to Apidog project resources and workflows, especially by AI agents, use Apidog CLI.
    Choosing between REST APIs and Apidog CLI
    Use the REST APIs when building a direct HTTP integration for an operation documented in this reference.
    Use Apidog CLI when you or your AI Agent needs broader resource coverage or needs to perform a multi-step Apidog workflow.
    Refer to the Apidog CLI page for more details.
    Modified at 2026-09-03 04:24:25
    Next
    API Versions
    Built with