Understand the API schema

A schema tells you what a request accepts and what its response contains. You can read examples in these docs or give the OpenAPI file to an API client or coding agent.

Use a production API key for these examples. Keys in the OpenRecipe demo workspace are for preview only.

On this page 4 sections

Find the inputs for a call
Read the result
Use the specification with your tools
Files for agents

Open the OpenAPI JSON to inspect or import the specification. For a working request, start with the quickstart.

Find the inputs for a call

Each service action has its own inputs. Send a free GET request to the action URL to read its description, price, and input schema before making a paid POST request.

curl https://vaaya.ai/api/run/exa/search

Schema field	What it means
`properties`	The inputs you can send, such as a search query or page URL.
`type`	The value an input accepts, such as text (`string`), a number, or a list (`array`).
`required`	The inputs you must include. Other inputs can be omitted unless the action says otherwise.
`enum`	The allowed values for an input. Use one of the values listed.
`description`	An explanation of the input and how to use it.

Read the result

Successful catalog calls return the service result with billing details. Keep the transaction ID to match a response to your account history.

{
  "ok": true,
  "data": {
    "results": []
  },
  "charged_cents": 1,
  "balance_remaining_cents": 199,
  "transaction_id": "tx_example"
}

Response field	What it means
`ok`	Whether the call succeeded.
`data`	The result from the service. Its contents depend on the action.
`charged_cents`	The amount charged, in cents.
`balance_remaining_cents`	Your remaining gateway balance, when returned for account payments.
`transaction_id`	The identifier for the transaction, when returned.

The response above is illustrative. For error codes, retries, and billing rules, see Errors & billing.

Use the specification with your tools

Import https://vaaya.ai/openapi.json into a client that supports OpenAPI 3.1, or give the URL to your coding agent.
Choose an operation and read its request schema. Supply your gateway key as a bearer token when making an account-funded call.
Check the action’s current descriptor and set max_cost_cents before making a paid request.

When x402 publishing is enabled, the OpenAPI file lists fixed-price actions costing at least 1¢, plus the catalog index. If publishing is disabled, its paths object is empty. For free or variable-price actions, use the full catalog JSON and each action’s GET descriptor. The model router has its own guide.

Files for agents

File	Use it for
OpenAPI JSON	Structured operations, inputs, responses, and authentication.
llms.txt	Finding the right documentation page.
llms-full.txt	Reading MCP tool descriptions and complete input schemas.
x402 discovery JSON	Finding endpoints that accept direct x402 payments. Read the payment guide first.