Get a tool

GET/v1/tools/{tool}

No API key needed. Without one, requests are limited per IP address. A key sent must be valid.

Fetch one tool: the input it takes, the output it returns, and each provider that can serve it.

input_schema and output_schema are JSON Schemas and are the same whichever provider serves the call. Each provider lists its price, the inputs it accepts (values is null when it accepts any value the input schema allows) and the optional outputs it returns. The schemas are null while the tool is not callable.

No API key is needed. Without one, requests are rate limited per IP address.

Path parameters

toolstringRequired

The tool's ID, such as google.serp.organic.

Response

The tool. One tool in full: its input and output schemas and each provider that can serve it. The schemas are null while the tool is not callable.

toolstring

The tool's ID, as calls and quotes take it.

namestring

The tool's name.

platformobject

The platform the tool's data is about.

platform.slugstring

The platform's ID, as the platform filter takes it.

platform.namestring

The platform's name.

categorystring

The kind of data it returns.

seo

social

enrichment

reviews

callableboolean

Whether the tool can be called today.

from_price_usdstring· nullable

What one call costs at the cheapest provider. Null when no provider can serve it.

input_schemaobject· nullable

The JSON Schema of a call's input. Null while the tool is not callable.

output_schemaobject· nullable

The JSON Schema of a call's output. Null while the tool is not callable.

providersarray of object

Each provider that can serve it, with its price.

providers.providerstring

The provider's ID, as a call's provider takes it.

providers.namestring

The provider's name.

providers.priceobject

What one call costs you when this provider serves it.

providers.price.basisstring

What a call is priced by.

per_call

per_success

per_result

per_call_and_result

free

providers.price.unit_price_usdstring

The price of one call, or of one result_unit under per_result.

providers.price.max_price_usdstring· nullable

The most one call can cost. Null when the price states no ceiling.

providers.price.result_unitstring· nullable

What one result is, under a basis priced by results. Null otherwise.

providers.price.max_resultsinteger· nullable

The most results one call is charged for. Null under a basis not priced by results.

providers.price.minimum_price_usdstring· nullable

The least one call costs under per_result. Null otherwise.

providers.price.result_price_usdstring· nullable

The price of each result under per_call_and_result. Null otherwise.

providers.supported_inputsarray of object

Each input the provider accepts.

providers.supported_inputs.namestring

The input's name in the tool's input_schema.

providers.supported_inputs.valuesarray of string or integer or number or boolean· nullable

The values the provider accepts. Null when it accepts any the schema allows.

providers.optional_outputsarray of string

The optional outputs the provider returns, by name, as a call's require takes them.

400Refused request body

The request was refused.

401INVALID_AUTH_TOKENRefused request body

An API key was sent and is wrong or revoked.

404MODEL_NOT_FOUNDRefused request body

No tool has this ID.

422VALIDATIONInvalid request body

The request is not valid.

429RATE_LIMITEDRefused request body

Too many requests without an API key from this IP address, or with this API key.

Retry-After: Seconds until the limit resets.

curl https://api.voxoria.ai/v1/tools/google.serp.organic

import httpx

response = httpx.get(
    "https://api.voxoria.ai/v1/tools/google.serp.organic",
)
print(response.json())

const response = await fetch("https://api.voxoria.ai/v1/tools/google.serp.organic");
console.log(await response.json());

{
  "name": "get_tool",
  "arguments": {
    "tool": "google.serp.organic"
  }
}

200 OKResponseapplication/json

{
  "tool": "google.serp.organic",
  "name": "Search Google organic results",
  "platform": {
    "slug": "google",
    "name": "Google"
  },
  "category": "seo",
  "callable": true,
  "from_price_usd": "0.0214",
  "input_schema": {
    "type": "object",
    "properties": {
      "query": {
        "type": "string"
      },
      "country": {
        "type": "string",
        "default": "us"
      }
    },
    "required": [
      "query"
    ]
  },
  "output_schema": {
    "type": "object",
    "properties": {
      "results": {
        "type": "array"
      },
      "related_questions": {
        "type": "array"
      },
      "related_searches": {
        "type": "array"
      }
    }
  },
  "providers": [
    {
      "provider": "example-provider",
      "name": "Example provider",
      "price": {
        "basis": "per_call",
        "unit_price_usd": "0.0214",
        "max_price_usd": null,
        "result_unit": null,
        "max_results": null,
        "minimum_price_usd": null,
        "result_price_usd": null
      },
      "supported_inputs": [
        {
          "name": "country",
          "values": [
            "us",
            "gb",
            "de"
          ]
        }
      ],
      "optional_outputs": []
    }
  ]
}