Chat

Conversational AI assistant endpoints

Send Chat Message

POST

https://api.openpaws.ai

/v1/chat/message

Send a conversational message to the AI advocacy assistant. Supports conversation history for multi-turn dialogues.

Pricing

$0.25 per request (Pay As You Go plan).

Send Chat Message › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Send Chat Message › Request Body

message

string · minLength: 1 · maxLength: 5000 · required

The user's message

object[]

Previous conversation history for context

Send Chat Message › Responses

AI response

response

string

The AI assistant's response

intent

string

Detected intent of the conversation

POST/v1/chat/message

curl --request POST \
  --url https://api.openpaws.ai/v1/chat/message \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "What states have passed cage-free egg legislation in the US?"
}
'

shell

Example Request Body

{
  "message": "What states have passed cage-free egg legislation in the US?"
}

json

application/json

Example Responses

{
  "response": "California's Proposition 12 (2018) is widely considered the strongest cage-free legislation in the US. It bans the sale of eggs from caged hens starting January 2024, with minimum space requirements of 1 square foot per hen. The law includes both criminal penalties (misdemeanor) and civil enforcement by the state attorney general. Massachusetts' Question 3 has similar provisions but California's law is notable because it also applies to eggs imported from other states, giving it nationwide impact on the industry.",
  "intent": "GENERAL_CHAT"
}

json

application/json

Detect Message Intent

POST

https://api.openpaws.ai

/v1/chat/intent

Classify a user message into one of the supported intents and extract relevant entities.

Supported Intents

CREATE_CONTENT — User wants to generate advocacy content
INVESTIGATE_COMPANY — User wants to research a company
RESEARCH_INDIVIDUAL — User wants an OSINT profile on a person
LEGAL_HELP — User needs legal guidance for advocacy activities
TRACK_ISSUES — User wants to monitor advocacy issues
GENERAL_CHAT — General conversation

Pricing

$0.10 per request (Pay As You Go plan).

Detect Message Intent › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Detect Message Intent › Request Body

message

string · minLength: 1 · maxLength: 2000 · required

The user message to classify

Detect Message Intent › Responses

Detected intent with extracted information

intent

string · enum

The detected intent

Enum values:

CREATE_CONTENT

INVESTIGATE_COMPANY

RESEARCH_INDIVIDUAL

LEGAL_HELP

TRACK_ISSUES

GENERAL_CHAT

object

Extracted entities relevant to the intent

confidence

number

Confidence score 0-1

POST/v1/chat/intent

curl --request POST \
  --url https://api.openpaws.ai/v1/chat/intent \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "message": "I want to investigate Tyson Foods' animal welfare practices"
}
EOF

shell

Example Request Body

{
  "message": "I want to investigate Tyson Foods' animal welfare practices"
}

json

application/json

Example Responses

{
  "intent": "INVESTIGATE_COMPANY",
  "extractedInfo": {
    "companyName": "Tyson Foods",
    "focus": "animal welfare practices"
  },
  "confidence": 0.95
}

json

application/json

Summarize Conversation

POST

https://api.openpaws.ai

/v1/chat/summarize

Compress older conversation history into a concise summary. Useful for maintaining context in long conversations while reducing token usage.

Pricing

$0.25 per request (Pay As You Go plan).

Summarize Conversation › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Summarize Conversation › Request Body

object[] · minItems: 2 · required

Conversation messages to summarize (minimum 2)

Summarize Conversation › Responses

Conversation summary

summary

string

Concise summary of the conversation

POST/v1/chat/summarize

curl --request POST \
  --url https://api.openpaws.ai/v1/chat/summarize \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "messages": [
    {
      "role": "user",
      "content": "What are the most effective strategies for corporate campaigns targeting fast food companies?"
    },
    {
      "role": "assistant",
      "content": "The most effective corporate campaign strategies include shareholder advocacy, public pressure campaigns, and direct negotiation..."
    },
    {
      "role": "user",
      "content": "Has this worked with McDonald's specifically?"
    },
    {
      "role": "assistant",
      "content": "Yes, McDonald's has been a frequent target. The Humane Society of the United States and Mercy For Animals both ran successful campaigns..."
    }
  ]
}
EOF

shell

Example Request Body

{
  "messages": [
    {
      "role": "user",
      "content": "What are the most effective strategies for corporate campaigns targeting fast food companies?"
    },
    {
      "role": "assistant",
      "content": "The most effective corporate campaign strategies include shareholder advocacy, public pressure campaigns, and direct negotiation..."
    },
    {
      "role": "user",
      "content": "Has this worked with McDonald's specifically?"
    },
    {
      "role": "assistant",
      "content": "Yes, McDonald's has been a frequent target. The Humane Society of the United States and Mercy For Animals both ran successful campaigns..."
    }
  ]
}

json

application/json

Example Responses

{
  "summary": "The user asked about effective corporate campaign strategies for targeting fast food companies. The assistant described shareholder advocacy, public pressure campaigns, and direct negotiation as key approaches. The user then asked specifically about McDonald's, and the assistant confirmed that HSUS and Mercy For Animals ran successful campaigns against McDonald's."
}

json

application/json

Extract User Memory

POST

https://api.openpaws.ai

/v1/chat/extract-memory

Extract user preferences and context from a completed conversation. Called once per conversation on close/abandon. Extracts non-PII facts like organization, cause areas, role, and research topics.

Extract User Memory › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Extract User Memory › Request Body

object[] · minItems: 4 · required

conversationId

string

Extract User Memory › Responses

Memory extraction result

No data returned

Content Legal

Send Chat Message

POST

https://api.openpaws.ai

/v1/chat/message

Send a conversational message to the AI advocacy assistant. Supports conversation history for multi-turn dialogues.

Pricing

$0.25 per request (Pay As You Go plan).

Send Chat Message › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Send Chat Message › Request Body

message

string · minLength: 1 · maxLength: 5000 · required

The user's message

object[]

Previous conversation history for context

Send Chat Message › Responses

AI response

response

string

The AI assistant's response

intent

string

Detected intent of the conversation

Detect Message Intent

POST

https://api.openpaws.ai

/v1/chat/intent

Classify a user message into one of the supported intents and extract relevant entities.

Supported Intents

CREATE_CONTENT — User wants to generate advocacy content
INVESTIGATE_COMPANY — User wants to research a company
RESEARCH_INDIVIDUAL — User wants an OSINT profile on a person
LEGAL_HELP — User needs legal guidance for advocacy activities
TRACK_ISSUES — User wants to monitor advocacy issues
GENERAL_CHAT — General conversation

Pricing

$0.10 per request (Pay As You Go plan).

Detect Message Intent › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Detect Message Intent › Request Body

message

string · minLength: 1 · maxLength: 2000 · required

The user message to classify

Detect Message Intent › Responses

Detected intent with extracted information

intent

string · enum

The detected intent

Enum values:

CREATE_CONTENT

INVESTIGATE_COMPANY

RESEARCH_INDIVIDUAL

LEGAL_HELP

TRACK_ISSUES

GENERAL_CHAT

object

Extracted entities relevant to the intent

confidence

number

Confidence score 0-1

Summarize Conversation

POST

https://api.openpaws.ai

/v1/chat/summarize

Compress older conversation history into a concise summary. Useful for maintaining context in long conversations while reducing token usage.

Pricing

$0.25 per request (Pay As You Go plan).

Summarize Conversation › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Summarize Conversation › Request Body

object[] · minItems: 2 · required

Conversation messages to summarize (minimum 2)

Summarize Conversation › Responses

Conversation summary

summary

string

Concise summary of the conversation

Extract User Memory

POST

https://api.openpaws.ai

/v1/chat/extract-memory

Extract user preferences and context from a completed conversation. Called once per conversation on close/abandon. Extracts non-PII facts like organization, cause areas, role, and research topics.

Extract User Memory › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Extract User Memory › Request Body

object[] · minItems: 4 · required

conversationId

string

Extract User Memory › Responses

Memory extraction result

No data returned