Open Paws API

Schemas

SearchRequest

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.

SearchResponse

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

SearchAllRequest

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

SearchAllResponse

query

string

search_type

string

object

TableResults

count

integer

Number of results for this table

object[]

Array of matching records

error

string

Error message if search failed for this table

OSINTRequest

firstName

string · minLength: 1 · maxLength: 100 · required

Person's first name

lastName

string · minLength: 1 · maxLength: 100 · required

Person's last name

companyName

string · maxLength: 200

Company or organization name (optional)

companyDomain

string · hostname

Company website domain (optional)

linkedinURL

string · uri · pattern: ^https?://(www\.)?li…

LinkedIn profile URL (optional)

reportGoal

string · maxLength: 500

Context for the report (optional)

OSINTResponse

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: type, metadata
	type = object · requires: type, content, metadata
	type = object · requires: type, metadata
	type = object · requires: type, metadata

Properties for Variant 1:

Marks the start of a workflow step

type

string · enum · required

Event type indicating step start

Enum values:

begin

object · required

Metadata attached to each streaming event

OSINTStreamEventMetadata

Metadata attached to each streaming event

nodeId

string · uuid

Unique identifier for the workflow node

nodeName

string

Human-readable name of the workflow step (e.g., 'Step 1: Discovery', 'Step 4: Report Writing', 'Respond to Webhook')

itemIndex

integer

Index of the item within the node output

runIndex

integer

Run iteration index

timestamp

integer

Unix timestamp in milliseconds when the event occurred

OSINTStreamEventBegin

Marks the start of a workflow step

type

string · enum · required

Event type indicating step start

Enum values:

begin

object · required

Metadata attached to each streaming event

OSINTStreamEventItem

Streaming content chunk containing a text fragment

type

string · enum · required

Event type indicating a content chunk

Enum values:

item

content

string · required

Text content fragment. For 'Respond to Webhook' events, this contains the final JSON report as a string.

object · required

Metadata attached to each streaming event

OSINTStreamEventEnd

Marks the end of a workflow step

type

string · enum · required

Event type indicating step completion

Enum values:

end

object · required

Metadata attached to each streaming event

OSINTStreamEventError

Error event from a workflow node

type

string · enum · required

Event type indicating an error

Enum values:

error

object · required

Metadata attached to each streaming event

OSINTFinalReport

The final OSINT report JSON, delivered as a string in the 'content' field of the last 'item' event from the 'Respond to Webhook' node. Parse the content string as JSON to access this structure.

Final Report

string · required

Comprehensive OSINT report in markdown format. Contains:

Executive Summary — Key findings and recommended actions
Top Priorities — Immediate action items
Identity Resolution — Steps to disambiguate common names
Verification Steps — How to validate identity before outreach
Psychological Profiling — Rapid assessment techniques
Engagement Playbooks — Tailored approaches based on personality type
Message Architecture — Email/DM templates
Call Script — Structured conversation outline
Network Mapping — Second-degree connection strategies
Compliance & Ethics — Legal considerations (CFAA, GDPR)
Footnotes — Numbered source citations with URLs

Campaign

id

string · uuid

title

string

description

string

goal

string

status

string · enum

Enum values:

active

paused

completed

draft

cause_areas

string[]

country_codes

string[]

target_name

string

target_type

string

approaches

string[]

image_url

string · uri

created_at

string · date-time

Action

id

string · uuid

title

string

action_type

string

platform

string

target_type

string

target_value

string

recipient_label

string

priority_score

number

image_url

string · uri

deadline

string · date-time

created_at

string · date-time

PublicFigure

id

string · uuid

name

string

display_name

string

first_name

string

last_name

string

party

string

office

string

country_code

string

figure_type

string

federal_member

boolean

profile_image_url

string · uri

overall_alignment_ranking

number

twitter_link

string · uri

created_at

string · date-time

Organization

id

string · uuid

name

string

description

string

industry

string

org_type

string

country_codes

string[]

headquarters_location

string

logo_url

string · uri

website

string · uri

overall_alignment_ranking

number

created_at

string · date-time

Content

id

string · uuid

title

string

platform

string

author

string

content_type

string

stance

string

url

string · uri

views

integer

likes

integer

engagement_score

number

published_at

string · date-time

created_at

string · date-time

Suggestion

id

string · uuid

suggestion_text

string

tone

string

approach

string

audience

string

position

string

created_at

string · date-time

ContentGenerateRequest

topic

string · minLength: 1 · maxLength: 500 · required

The advocacy topic to create content about

platform

string · enum

Target social media platform

Enum values:

instagram

twitter

facebook

contentType

string · enum

Type of content to generate

Enum values:

social

press

educational

Default: social

tone

string · enum

Desired tone of the content

Enum values:

urgent

hopeful

emotional

educational

keyPoints

string · maxLength: 1000

Specific points, stats, or facts to include

callToAction

string · maxLength: 500

Desired call to action

ContentGenerateResponse

object[]

Array of content variations with different approaches

ChatMessageRequest

message

string · minLength: 1 · maxLength: 5000 · required

The user's message

object[]

Previous conversation history for context

ChatMessageResponse

response

string

The AI assistant's response

intent

string

Detected intent of the conversation

IntentDetectRequest

message

string · minLength: 1 · maxLength: 2000 · required

The user message to classify

IntentDetectResponse

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

CompanyProfileRequest

companyName

string · minLength: 1 · maxLength: 200 · required

Company or organization name

companyDomain

string · maxLength: 200

Company website domain (e.g., 'tysonfoods.com'). Improves accuracy of OSINT discovery.

reportGoal

string · maxLength: 500

Additional context describing what the OSINT report should focus on (e.g., executives, risks, structure, financials)

LegalGuidanceRequest

prompt

string · minLength: 1 · maxLength: 2000 · required

Your legal research question

timeline

string · maxLength: 200

When is this happening

TrackingRequest

topics

string[]

Topic IDs to track

frequency

string · enum

How often to receive updates

Enum values:

daily

weekly

realtime

Default: weekly

customKeywords

string[]

Custom keywords to monitor

specificInterests

string · maxLength: 1000

Additional context about tracking interests

AsyncTaskResponse

taskId

string · uuid

Unique identifier for the async task

message

string

Human-readable confirmation message

estimatedTime

string

Estimated time for completion

taskType

string

Type of task that was started

KnowledgeSearchRequest

query

string · minLength: 1 · maxLength: 500 · required

Search query text

collection

string · enum

Knowledge collection to search

Enum values:

AnimalAdvocacy

LegalPrecedents

CampaignArchive

Research

Legislation

Default: AnimalAdvocacy

limit

integer · min: 1 · max: 50

Maximum results to return

Default: 10

certainty

number · min: 0 · max: 1

Minimum similarity threshold (0-1)

Default: 0.7

fields

string[]

Fields to return. Defaults to collection-specific fields.

KnowledgeSearchResponse

query

string

collection

string

count

integer

object[]

Error

error

string

Error type

message

string

Detailed error message

Open Paws API

Schemas

SearchRequest

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.

SearchResponse

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

SearchAllRequest

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

SearchAllResponse

query

string

search_type

string

object

TableResults

count

integer

Number of results for this table

object[]

Array of matching records

error

string

Error message if search failed for this table

OSINTRequest

firstName

string · minLength: 1 · maxLength: 100 · required

Person's first name

lastName

string · minLength: 1 · maxLength: 100 · required

Person's last name

companyName

string · maxLength: 200

Company or organization name (optional)

companyDomain

string · hostname

Company website domain (optional)

linkedinURL

string · uri · pattern: ^https?://(www\.)?li…

LinkedIn profile URL (optional)

reportGoal

string · maxLength: 500

Context for the report (optional)

OSINTResponse

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: type, metadata
	type = object · requires: type, content, metadata
	type = object · requires: type, metadata
	type = object · requires: type, metadata

Properties for Variant 1:

Marks the start of a workflow step

type

string · enum · required

Event type indicating step start

Enum values:

begin

object · required

Metadata attached to each streaming event

OSINTStreamEventMetadata

Metadata attached to each streaming event

nodeId

string · uuid

Unique identifier for the workflow node

nodeName

string

Human-readable name of the workflow step (e.g., 'Step 1: Discovery', 'Step 4: Report Writing', 'Respond to Webhook')

itemIndex

integer

Index of the item within the node output

runIndex

integer

Run iteration index

timestamp

integer

Unix timestamp in milliseconds when the event occurred

OSINTStreamEventBegin

Marks the start of a workflow step

type

string · enum · required

Event type indicating step start

Enum values:

begin

object · required

Metadata attached to each streaming event

OSINTStreamEventItem

Streaming content chunk containing a text fragment

type

string · enum · required

Event type indicating a content chunk

Enum values:

item

content

string · required

Text content fragment. For 'Respond to Webhook' events, this contains the final JSON report as a string.

object · required

Metadata attached to each streaming event

OSINTStreamEventEnd

Marks the end of a workflow step

type

string · enum · required

Event type indicating step completion

Enum values:

end

object · required

Metadata attached to each streaming event

OSINTStreamEventError

Error event from a workflow node

type

string · enum · required

Event type indicating an error

Enum values:

error

object · required

Metadata attached to each streaming event

OSINTFinalReport

The final OSINT report JSON, delivered as a string in the 'content' field of the last 'item' event from the 'Respond to Webhook' node. Parse the content string as JSON to access this structure.

Final Report

string · required

Comprehensive OSINT report in markdown format. Contains:

Executive Summary — Key findings and recommended actions
Top Priorities — Immediate action items
Identity Resolution — Steps to disambiguate common names
Verification Steps — How to validate identity before outreach
Psychological Profiling — Rapid assessment techniques
Engagement Playbooks — Tailored approaches based on personality type
Message Architecture — Email/DM templates
Call Script — Structured conversation outline
Network Mapping — Second-degree connection strategies
Compliance & Ethics — Legal considerations (CFAA, GDPR)
Footnotes — Numbered source citations with URLs

Campaign

id

string · uuid

title

string

description

string

goal

string

status

string · enum

Enum values:

active

paused

completed

draft

cause_areas

string[]

country_codes

string[]

target_name

string

target_type

string

approaches

string[]

image_url

string · uri

created_at

string · date-time

Action

id

string · uuid

title

string

action_type

string

platform

string

target_type

string

target_value

string

recipient_label

string

priority_score

number

image_url

string · uri

deadline

string · date-time

created_at

string · date-time

PublicFigure

id

string · uuid

name

string

display_name

string

first_name

string

last_name

string

party

string

office

string

country_code

string

figure_type

string

federal_member

boolean

profile_image_url

string · uri

overall_alignment_ranking

number

twitter_link

string · uri

created_at

string · date-time

Organization

id

string · uuid

name

string

description

string

industry

string

org_type

string

country_codes

string[]

headquarters_location

string

logo_url

string · uri

website

string · uri

overall_alignment_ranking

number

created_at

string · date-time

Content

id

string · uuid

title

string

platform

string

author

string

content_type

string

stance

string

url

string · uri

views

integer

likes

integer

engagement_score

number

published_at

string · date-time

created_at

string · date-time

Suggestion

id

string · uuid

suggestion_text

string

tone

string

approach

string

audience

string

position

string

created_at

string · date-time

ContentGenerateRequest

topic

string · minLength: 1 · maxLength: 500 · required

The advocacy topic to create content about

platform

string · enum

Target social media platform

Enum values:

instagram

twitter

facebook

contentType

string · enum

Type of content to generate

Enum values:

social

press

educational

Default: social

tone

string · enum

Desired tone of the content

Enum values:

urgent

hopeful

emotional

educational

keyPoints

string · maxLength: 1000

Specific points, stats, or facts to include

callToAction

string · maxLength: 500

Desired call to action

ContentGenerateResponse

object[]

Array of content variations with different approaches

ChatMessageRequest

message

string · minLength: 1 · maxLength: 5000 · required

The user's message

object[]

Previous conversation history for context

ChatMessageResponse

response

string

The AI assistant's response

intent

string

Detected intent of the conversation

IntentDetectRequest

message

string · minLength: 1 · maxLength: 2000 · required

The user message to classify

IntentDetectResponse

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

CompanyProfileRequest

companyName

string · minLength: 1 · maxLength: 200 · required

Company or organization name

companyDomain

string · maxLength: 200

Company website domain (e.g., 'tysonfoods.com'). Improves accuracy of OSINT discovery.

reportGoal

string · maxLength: 500

Additional context describing what the OSINT report should focus on (e.g., executives, risks, structure, financials)

LegalGuidanceRequest

prompt

string · minLength: 1 · maxLength: 2000 · required

Your legal research question

timeline

string · maxLength: 200

When is this happening

TrackingRequest

topics

string[]

Topic IDs to track

frequency

string · enum

How often to receive updates

Enum values:

daily

weekly

realtime

Default: weekly

customKeywords

string[]

Custom keywords to monitor

specificInterests

string · maxLength: 1000

Additional context about tracking interests

AsyncTaskResponse

taskId

string · uuid

Unique identifier for the async task

message

string

Human-readable confirmation message

estimatedTime

string

Estimated time for completion

taskType

string

Type of task that was started

KnowledgeSearchRequest

query

string · minLength: 1 · maxLength: 500 · required

Search query text

collection

string · enum

Knowledge collection to search

Enum values:

AnimalAdvocacy

LegalPrecedents

CampaignArchive

Research

Legislation

Default: AnimalAdvocacy

limit

integer · min: 1 · max: 50

Maximum results to return

Default: 10

certainty

number · min: 0 · max: 1

Minimum similarity threshold (0-1)

Default: 0.7

fields

string[]

Fields to return. Defaults to collection-specific fields.

KnowledgeSearchResponse

query

string

collection

string

count

integer

object[]

Error

error

string

Error type

message

string

Detailed error message