Skip to main content
Upload an OpenAPI (Swagger) spec to let your agent call your API endpoints.

​
Setup

​
1. Configure Connection

In Integration → OpenAPI:
FieldDescription
Base URLYour API root (e.g., https://api.yourcompany.com/v1)
Auth TypeNone, API Key, Bearer Token, or JWT Forward

​
2. Configure Auth

Header name: X-API-Key
Value: your-secret-key

​
3. Upload Spec

Drag and drop your .json or .yaml OpenAPI spec file.

​
4. Enable Tools

Go to Actions and select which endpoints to enable.

​
Example Spec

openapi: 3.0.0
info:
  title: My API
  version: 1.0.0
paths:
  /orders/{orderId}:
    get:
      operationId: getOrder
      summary: Get order details
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Order details

​
Client-Side Tools

To let the agent trigger browser-side actions (like navigation), add paths prefixed with /client/: 
paths:
  /client/navigateToPage:
    post:
      operationId: navigateToPage
      summary: Navigate to a page
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                path:
                  type: string
Then register the matching tool in your frontend: 
window.crow('registerTools', {
  navigateToPage: async ({ path }) => {
    router.push(path)
    return { success: true }
  }
})
The operationId must match the key in registerTools.

​
Tips

  • Use descriptive summary and description fields
  • Use clear operationId names (getOrderStatus not get1)
  • Only expose safe operations

​
Troubleshooting

IssueSolution
Spec won’t uploadValidate at editor.swagger.io
API calls failingCheck base URL and auth credentials
Agent not using APIEnable tools in Actions, test in Sandbox

OpenAPI Authentication

Detailed auth guide including JWT Forward