Skip to content

Application API quickstart

Updated View as Markdown

This guide uses application Agent keys and the /v1/agent/ API. For integration setup through MCP, start with Get started and the client setup guide.

Prerequisites

  • An application ID such as app_<32-lowercase-hex>.
  • An enabled operation in that application.
  • An unexpired application Agent key stored as TOOLUSE_API_KEY.

Discover allowed operations

curl "https://api.tooluse.net/v1/agent/applications/app_<32-lowercase-hex>/operations" \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"

Choose one operation

Read its id and inputSchema. The schema is the request body contract.

Invoke it once

Create input.json with an object matching the selected operation’s inputSchema before running this request. Send that object directly; do not wrap it in an input property. A text-only example is not valid for every operation.

curl -X POST \
  "https://api.tooluse.net/v1/agent/applications/app_<32-lowercase-hex>/operations/<operation-id>/invoke" \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-20260921-01" \
  --data-binary @input.json

Read an asynchronous receipt

If the invocation returns 202, use its invocation ID:

curl "https://api.tooluse.net/v1/agent/applications/app_<32-lowercase-hex>/invocations/<invocation-id>" \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"

You should see

Discovery returns operations; invocation returns either a completed service result (200) or an accepted native execution (202). Reusing the same idempotency key returns the recorded invocation instead of dispatching a second effect.

Next step

Learn how operation discovery and schemas work.

Type to search…

↑↓ navigate↵ selectEsc close