muwkl
عربيContact usSign-up
DocumentationAPI v1
Browse documentation

Your first request

Set up a server-side credential and read the agents in your workspace.

Before you start

You need an enabled development environment, its API base URL and a workspace API key with read scope. Create or request the key through your workspace. Keep it in a server secret store, outside your repository and browser bundle.

# Set these in your server environment.
# Use the actual base URL supplied for your workspace.
MUWKL_BASE_URL="https://your-assigned-api-host"
MUWKL_API_KEY="your-workspace-key"

List your agents

Send a GET request to /v1/agents with the bearer key. The credential determines the workspace; do not include a tenant selector in the body or query.

curl "$MUWKL_BASE_URL/v1/agents" \
  -H "Authorization: Bearer $MUWKL_API_KEY"

Read the response

A successful response contains agents and next_cursor. An empty agents array is a valid result. Follow the cursor when present; do not infer that every agent is live.

{
  "agents": [],
  "next_cursor": null
}

Continue into a conversation

Choose a live agent, grant the separate converse scope, and use the Conversations reference to create a conversation and submit a message. Keep read scope if your integration also needs to inspect the results.

Need a hand? Get in touch