REST Workflows for Agents - Communicate Developer

Use the OpenAPI document as the authority for request and response schemas:

https://app.communicate.so/api/v1/openapi.json

Request a scoped access token as shown in Authentication, then export it as COMMUNICATE_ACCESS_TOKEN.

Discover agents

curl https://app.communicate.so/api/v1/agents \
  -H "Authorization: Bearer $COMMUNICATE_ACCESS_TOKEN"

Select an agent whose status is active.

Ask a question

curl https://app.communicate.so/api/v1/agents/$AGENT_ID/chat \
  -H "Authorization: Bearer $COMMUNICATE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"message\":\"$QUESTION\",\"requestId\":\"$REQUEST_ID\"}"

Persist the returned conversationId to continue the thread. If mode is human, hand control back to an operator-facing workflow.

​Discover agents

​Ask a question

Discover agents

Ask a question