Skip to content

Quickstart

Discover and invoke one enabled AgentMQ operation.

Updated View as Markdown

Prerequisites

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

Discover allowed operations

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

Choose one operation

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

Invoke it once

curl -X POST \
  https://api.agent.mq/v1/agent/applications/app_<32-lowercase-hex>/operations/<operation-id>/invoke \
  -H "Authorization: Bearer $AGENTMQ_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-20260921-01" \
  -d '{"text":"Hello from AgentMQ"}'

Send the operation input object directly. Do not wrap it in an input property.

Read an asynchronous receipt

If the invocation returns 202, use its invocation ID:

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

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.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close