Open Paws API

Search

Endpointhttps://api.openpaws.ai

Search endpoints for querying Open Paws data

Search all tables

POST

https://api.openpaws.ai

/search/all

Search across multiple tables simultaneously. Returns results grouped by table. Useful for discovery and cross-referencing data.

Features

Search all 6 tables in parallel
Per-table filtering
Configurable results per table (1-20)
Both text and semantic search supported

Search all tables › 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.

Search all tables › Request Body

query

string · minLength: 1 · maxLength: 500 · required

The search query text

search_type

string · enum

Type of search to perform

Enum values:

text

semantic

Default: text

tables

string[]

Tables to search. Defaults to all tables.

Enum values:

campaigns

actions

public_figures

organizations

content

suggestions

Default: ["campaigns","actions","public_figures","organizations","content","suggestions"]

limit_per_table

integer · min: 1 · max: 20

Maximum results per table

Default: 5

object

Per-table filters

Search all tables › Responses

Search results grouped by table

query

string

search_type

string

object

POST/search/all

curl --request POST \
  --url https://api.openpaws.ai/search/all \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "animal testing cosmetics",
  "search_type": "text",
  "limit_per_table": 5
}
'

shell

Example Request Body

{
  "query": "animal testing cosmetics",
  "search_type": "text",
  "limit_per_table": 5
}

json

application/json

Example Responses

{
  "query": "animal testing",
  "search_type": "text",
  "results": {
    "campaigns": {
      "count": 3,
      "items": []
    },
    "actions": {
      "count": 5,
      "items": []
    },
    "public_figures": {
      "count": 2,
      "items": []
    },
    "organizations": {
      "count": 4,
      "items": []
    },
    "content": {
      "count": 10,
      "items": []
    },
    "suggestions": {
      "count": 1,
      "items": []
    }
  }
}

json

application/json

Search a single table

POST

https://api.openpaws.ai

/search/{table}

Search within a specific table using text or semantic (AI-powered) search. Supports filtering, pagination, and field selection.

Searchable Tables

campaigns - Advocacy campaigns with goals and talking points
actions - Specific actions users can take (emails, calls, social posts)
public_figures - Politicians, celebrities, and influencers
organizations - Companies, NGOs, and advocacy groups
content - Social media posts and articles
suggestions - AI-generated advocacy suggestions

Search Types

text - Fast keyword-based search (default)
semantic - AI-powered conceptual search using embeddings (5x cost)

Search a single table › path Parameters

table

string · enum · required

The table to search

Enum values:

campaigns

actions

public_figures

organizations

content

suggestions

Search a single table › 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.

Search a single table › Request Body

query

string · minLength: 1 · maxLength: 500 · required

The search query text

search_type

string · enum

Type of search. 'text' uses keyword matching, 'semantic' uses AI embeddings (5x cost)

Enum values:

text

semantic

Default: text

object

Field-specific filters. Available fields vary by table.

limit

integer · min: 1 · max: 100

Maximum results to return

Default: 20

offset

integer · min: 0

Results to skip for pagination

Default: 0

fields

string[]

Specific fields to return. If omitted, returns default fields for the table.

Search a single table › Responses

Search results

table

string

The table that was searched

search_type

string · enum

The type of search performed

Enum values:

text

semantic

query

string

The search query

total

integer

Total matching results

limit

integer

Maximum results returned

offset

integer

Results skipped

object[]

Array of matching records

POST/search/{table}

curl --request POST \
  --url https://api.openpaws.ai/search/:table \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "factory farming",
  "search_type": "text",
  "limit": 10
}
'

shell

Example Request Body

{
  "query": "factory farming",
  "search_type": "text",
  "limit": 10
}

json

application/json

Example Responses

{
  "table": "campaigns",
  "search_type": "text",
  "query": "factory farming",
  "total": 25,
  "limit": 10,
  "offset": 0,
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "title": "End Factory Farming Act",
      "description": "Campaign to pass federal legislation banning factory farming practices",
      "goal": "Pass HR 1234 by end of 2025",
      "status": "active",
      "cause_areas": [
        "animal_welfare",
        "environment"
      ],
      "country_codes": [
        "US"
      ],
      "target_name": "US Congress",
      "target_type": "legislative",
      "image_url": "https://openpaws.ai/images/campaigns/factory-farming.jpg",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

json

application/json

OSINT

Search all tables

POST

https://api.openpaws.ai

/search/all

Search across multiple tables simultaneously. Returns results grouped by table. Useful for discovery and cross-referencing data.

Features

Search all 6 tables in parallel
Per-table filtering
Configurable results per table (1-20)
Both text and semantic search supported

Search all tables › 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.

Search all tables › Request Body

query

string · minLength: 1 · maxLength: 500 · required

The search query text

search_type

string · enum

Type of search to perform

Enum values:

text

semantic

Default: text

tables

string[]

Tables to search. Defaults to all tables.

Enum values:

campaigns

actions

public_figures

organizations

content

suggestions

Default: ["campaigns","actions","public_figures","organizations","content","suggestions"]

limit_per_table

integer · min: 1 · max: 20

Maximum results per table

Default: 5

object

Per-table filters

Search all tables › Responses

Search results grouped by table

query

string

search_type

string

object

curl --request POST \ --url https://api.openpaws.ai/search/all \ --header 'Authorization: <string>' \ --header 'Content-Type: application/json' \ --data ' { "query": "animal testing cosmetics", "search_type": "text", "limit_per_table": 5 } '

{ "query": "animal testing", "search_type": "text", "results": { "campaigns": { "count": 3, "items": [] }, "actions": { "count": 5, "items": [] }, "public_figures": { "count": 2, "items": [] }, "organizations": { "count": 4, "items": [] }, "content": { "count": 10, "items": [] }, "suggestions": { "count": 1, "items": [] } } }

Search a single table

POST

https://api.openpaws.ai

/search/{table}

Search within a specific table using text or semantic (AI-powered) search. Supports filtering, pagination, and field selection.

Searchable Tables

campaigns - Advocacy campaigns with goals and talking points
actions - Specific actions users can take (emails, calls, social posts)
public_figures - Politicians, celebrities, and influencers
organizations - Companies, NGOs, and advocacy groups
content - Social media posts and articles
suggestions - AI-generated advocacy suggestions

Search Types

text - Fast keyword-based search (default)
semantic - AI-powered conceptual search using embeddings (5x cost)

Search a single table › path Parameters

table

string · enum · required

The table to search

Enum values:

campaigns

actions

public_figures

organizations

content

suggestions

Search a single table › 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.

Search a single table › Request Body

query

string · minLength: 1 · maxLength: 500 · required

The search query text

search_type

string · enum

Type of search. 'text' uses keyword matching, 'semantic' uses AI embeddings (5x cost)

Enum values:

text

semantic

Default: text

object

Field-specific filters. Available fields vary by table.

limit

integer · min: 1 · max: 100

Maximum results to return

Default: 20

offset

integer · min: 0

Results to skip for pagination

Default: 0

fields

string[]

Specific fields to return. If omitted, returns default fields for the table.

Search a single table › Responses

Search results

table

string

The table that was searched

search_type

string · enum

The type of search performed

Enum values:

text

semantic

query

string

The search query

total

integer

Total matching results

limit

integer

Maximum results returned

offset

integer

Results skipped

object[]

Array of matching records

curl --request POST \ --url https://api.openpaws.ai/search/:table \ --header 'Authorization: <string>' \ --header 'Content-Type: application/json' \ --data ' { "query": "factory farming", "search_type": "text", "limit": 10 } '

{ "table": "campaigns", "search_type": "text", "query": "factory farming", "total": 25, "limit": 10, "offset": 0, "results": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "title": "End Factory Farming Act", "description": "Campaign to pass federal legislation banning factory farming practices", "goal": "Pass HR 1234 by end of 2025", "status": "active", "cause_areas": [ "animal_welfare", "environment" ], "country_codes": [ "US" ], "target_name": "US Congress", "target_type": "legislative", "image_url": "https://openpaws.ai/images/campaigns/factory-farming.jpg", "created_at": "2024-01-15T10:30:00Z" } ] }