Call with curl

The quickest way to see what your agent sends back. This is the curl snippet from your agent’s page in the dashboard, which fills in the agent’s URL for you.

Before you begin

A deployed agent and its ID, from its page in the dashboard.
An API key in ONECORTEX_API_KEY.

Stream the reply

-N turns off curl’s output buffering, so each event prints as it arrives. Replace agt_... with your agent’s ID:

Terminal

curl -N https://api.onecortex.io/v1/agents/agt_.../invoke \
  -H "Authorization: Bearer $ONECORTEX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"hello","stream":true}'

For the quickstart’s echo agent:

Output

event: tool_call_start
data: {"v":1,"type":"tool_call_start","id":"call_1","name":"word_count"}

event: tool_call_args
data: {"v":1,"type":"tool_call_args","id":"call_1","delta":"{\"text\": \"hello\"}"}

event: tool_call_end
data: {"v":1,"type":"tool_call_end","id":"call_1"}

event: tool_result
data: {"v":1,"type":"tool_result","id":"call_1","output":"1"}

event: text
data: {"v":1,"type":"text","delta":"You said: hello"}

event: done
data: {"v":1,"type":"done","result":"You said: hello","sessionId":"01K...","versionNumber":1,"durationMs":212}

A stream that has started has already sent 200 OK, and cannot change it. If the run fails after that, the failure arrives in the stream as event: error. Handle it: a client that reads only text and done shows a failed run as an empty success.

Get one JSON response

Leave out "stream":true:

Terminal

curl https://api.onecortex.io/v1/agents/agt_.../invoke \
  -H "Authorization: Bearer $ONECORTEX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"hello"}'

Output

{"status":"completed","result":"You said: hello","events":[{"v":1,"type":"tool_call_start","id":"call_1","name":"word_count"},{"v":1,"type":"tool_call_args","id":"call_1","delta":"{\"text\": \"hello\"}"},{"v":1,"type":"tool_call_end","id":"call_1"},{"v":1,"type":"tool_result","id":"call_1","output":"1"}],"sessionId":"01K...","agentId":"agt_...","versionNumber":1,"requestId":"req_01K...","durationMs":212}

Pipe it through jq .result for the reply alone.

See the headers

Add -i to see the status and headers, including X-Request-Id to quote to support, and X-Onecortex-Session-Id to continue the conversation:

Terminal

curl -i https://api.onecortex.io/v1/agents/agt_.../invoke \
  -H "Authorization: Bearer $ONECORTEX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"hello","sessionId":"user-42"}'

Every field and header is on the invoke API.

Get started

Build your agent

Frameworks

Deploy

Call your agent

Observe

Production

Organizations

Resources

Before you begin

Stream the reply

Get one JSON response

See the headers

​Before you begin

​Stream the reply

​Get one JSON response

​See the headers

Before you begin

Stream the reply

Get one JSON response

See the headers