> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# Get Usage

- Component: `appmixer.tavily.core.GetUsage`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.tavily 1.0.2](https://connectors.appmixer.com/connector/appmixer.tavily/1.0.2.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.tavily/1.0.2/component/appmixer.tavily.core.GetUsage>

Get the current API credit usage and plan limits for the connected Tavily account. This call is free of charge.

## Input ports

### Port `in`

_No fields defined for this port._

## Output ports

### Port `out`

| Field | Type | Description |
| --- | --- | --- |
| Key Usage (`key_usage`) | integer | - |
| Key Limit (`key_limit`) | integer | - |
| Current Plan (`plan`) | string | - |
| Plan Usage (`plan_usage`) | integer | - |
| Plan Limit (`plan_limit`) | integer | - |
| Pay As You Go Usage (`paygo_usage`) | integer | - |
| Pay As You Go Limit (`paygo_limit`) | integer | - |
| Search Usage (`search_usage`) | integer | - |
| Extract Usage (`extract_usage`) | integer | - |
| Crawl Usage (`crawl_usage`) | integer | - |
| Map Usage (`map_usage`) | integer | - |

## Full metadata (component.json)

```json
{
  "name": "appmixer.tavily.core.GetUsage",
  "label": "Get Usage",
  "description": "Get the current API credit usage and plan limits for the connected Tavily account. This call is free of charge.",
  "author": "Appmixer <info@appmixer.com>",
  "version": "1.0.0",
  "auth": {
    "service": "appmixer:tavily"
  },
  "quota": {
    "manager": "appmixer:tavily",
    "resources": "requests",
    "scope": {
      "userId": "{{userId}}"
    }
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {}
      },
      "inspector": {
        "inputs": {}
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "schema": {
        "type": "object",
        "properties": {
          "key_usage": {
            "type": "integer",
            "title": "Key Usage",
            "example": 150
          },
          "key_limit": {
            "type": "integer",
            "title": "Key Limit",
            "example": 1000
          },
          "plan": {
            "type": "string",
            "title": "Current Plan",
            "example": "Bootstrap"
          },
          "plan_usage": {
            "type": "integer",
            "title": "Plan Usage",
            "example": 500
          },
          "plan_limit": {
            "type": "integer",
            "title": "Plan Limit",
            "example": 15000
          },
          "paygo_usage": {
            "type": "integer",
            "title": "Pay As You Go Usage",
            "example": 25
          },
          "paygo_limit": {
            "type": "integer",
            "title": "Pay As You Go Limit",
            "example": 100
          },
          "search_usage": {
            "type": "integer",
            "title": "Search Usage",
            "example": 350
          },
          "extract_usage": {
            "type": "integer",
            "title": "Extract Usage",
            "example": 75
          },
          "crawl_usage": {
            "type": "integer",
            "title": "Crawl Usage",
            "example": 50
          },
          "map_usage": {
            "type": "integer",
            "title": "Map Usage",
            "example": 15
          }
        }
      }
    }
  ],
  "icon": "(data URI omitted)"
}
```
