api.md

Shared Types

from profound.types import (
    AnalysisTypeFilter,
    AssetIDFilter,
    BotNameFilter,
    BotProviderFilter,
    CursorPagination,
    ModelIDFilter,
    Pagination,
    PathFilter,
    PersonaIDFilter,
    PromptFilter,
    PromptTypeFilter,
    RegionIDFilter,
    RegionNameFilter,
    TagIDFilter,
    TopicIDFilter,
)

Organizations

Types:

from profound.types import (
    Category,
    NamedResource,
    Organization,
    PersonaProfile,
    PersonaProfileBehavior,
    PersonaProfileDemographics,
    PersonaProfileEmployment,
    OrganizationListResponse,
    OrganizationDomainsResponse,
    OrganizationGetPersonasResponse,
    OrganizationListAssetsResponse,
    OrganizationModelsResponse,
    OrganizationRegionsResponse,
)

Methods:

• client.organizations.list() -> OrganizationListResponse
• client.organizations.domains(**params) -> OrganizationDomainsResponse
• client.organizations.get_personas(**params) -> OrganizationGetPersonasResponse
• client.organizations.list_assets(**params) -> OrganizationListAssetsResponse
• client.organizations.models() -> OrganizationModelsResponse
• client.organizations.regions(**params) -> OrganizationRegionsResponse

Categories

Types:

from profound.types.organizations import (
    FieldDiff,
    IDOrName,
    NamedResourceDiffList,
    CategoryListResponse,
    CategoryAssetsResponse,
    CategoryCreatePromptsResponse,
    CategoryGetCategoryPersonasResponse,
    CategoryPromptsResponse,
    CategoryRetrieveRegionsResponse,
    CategoryTagsResponse,
    CategoryTopicsResponse,
    CategoryUpdatePromptStatusResponse,
    CategoryUpdatePromptsResponse,
)

Methods:

• client.organizations.categories.list(**params) -> CategoryListResponse
• client.organizations.categories.assets(category_id) -> CategoryAssetsResponse
• client.organizations.categories.create_prompts(category_id, **params) -> CategoryCreatePromptsResponse
• client.organizations.categories.get_category_personas(category_id) -> CategoryGetCategoryPersonasResponse
• client.organizations.categories.prompts(category_id, **params) -> CategoryPromptsResponse
• client.organizations.categories.retrieve_regions(category_id) -> CategoryRetrieveRegionsResponse
• client.organizations.categories.tags(category_id) -> CategoryTagsResponse
• client.organizations.categories.topics(category_id) -> CategoryTopicsResponse
• client.organizations.categories.update_prompt_status(category_id, **params) -> CategoryUpdatePromptStatusResponse
• client.organizations.categories.update_prompts(category_id, **params) -> CategoryUpdatePromptsResponse

Prompts

Types:

from profound.types import PromptAnswersResponse, PromptAnswersV2Response

Methods:

• client.prompts.answers(**params) -> PromptAnswersResponse
• client.prompts.answers_v2(**params) -> PromptAnswersV2Response
• client.prompts.stream_answers_v2(**params) -> None

Reports

Types:

from profound.types import (
    HostnameFilter,
    PromptIDFilter,
    ReportInfo,
    ReportResponse,
    ReportResult,
    RootDomainFilter,
    TagNameFilter,
    TopicNameFilter,
    URLFilter,
    ReportCitationsResponse,
    ReportQueryCitationsResponse,
    ReportQueryFanoutsV2Response,
    ReportQuerySentimentResponse,
    ReportQuerySentimentV2Response,
    ReportQueryVisibilityResponse,
    ReportStreamCitationsResponse,
    ReportStreamSentimentResponse,
    ReportStreamVisibilityResponse,
)

Methods:

• client.reports.citations(**params) -> ReportCitationsResponse
• client.reports.get_bots_report(**params) -> ReportResponse
• client.reports.get_bots_report_v2(**params) -> ReportResponse
• client.reports.get_referrals_report(**params) -> ReportResponse
• client.reports.get_referrals_report_v2(**params) -> ReportResponse
• client.reports.query_citations(**params) -> ReportQueryCitationsResponse
• client.reports.query_fanouts(**params) -> ReportResponse
• client.reports.query_fanouts_v2(**params) -> ReportQueryFanoutsV2Response
• client.reports.query_sentiment(**params) -> ReportQuerySentimentResponse
• client.reports.query_sentiment_v2(**params) -> ReportQuerySentimentV2Response
• client.reports.query_visibility(**params) -> ReportQueryVisibilityResponse
• client.reports.sentiment(**params) -> ReportResponse
• client.reports.stream_citations(**params) -> ReportStreamCitationsResponse
• client.reports.stream_citations_v2(**params) -> None
• client.reports.stream_query_fanouts(**params) -> None
• client.reports.stream_sentiment(**params) -> ReportStreamSentimentResponse
• client.reports.stream_sentiment_v2(**params) -> None
• client.reports.stream_visibility(**params) -> ReportStreamVisibilityResponse
• client.reports.stream_visibility_v2(**params) -> None
• client.reports.visibility(**params) -> ReportResponse

WebSearchResults

Types:

from profound.types.reports import WebSearchResultQueryResponse, WebSearchResultStreamResponse

Methods:

• client.reports.web_search_results.query(**params) -> WebSearchResultQueryResponse
• client.reports.web_search_results.stream(**params) -> WebSearchResultStreamResponse

Shopping

Types:

from profound.types.reports import (
    BrandNameFilter,
    MerchantNameFilter,
    ProductNameFilter,
    ShoppingAllItemsWithMerchantsResponse,
    ShoppingExecutionsResponse,
    ShoppingItemVisibilityResponse,
    ShoppingMerchantByItemsResponse,
    ShoppingMerchantDistributionResponse,
    ShoppingMerchantShareResponse,
    ShoppingMerchantVisibilityByBrandResponse,
    ShoppingProductMerchantURLsResponse,
    ShoppingTriggerRateResponse,
    ShoppingVisibilityResponse,
)

Methods:

• client.reports.shopping.all_items_with_merchants(**params) -> ShoppingAllItemsWithMerchantsResponse
• client.reports.shopping.executions(**params) -> ShoppingExecutionsResponse
• client.reports.shopping.item_visibility(**params) -> ShoppingItemVisibilityResponse
• client.reports.shopping.merchant_by_items(**params) -> ShoppingMerchantByItemsResponse
• client.reports.shopping.merchant_distribution(**params) -> ShoppingMerchantDistributionResponse
• client.reports.shopping.merchant_share(**params) -> ShoppingMerchantShareResponse
• client.reports.shopping.merchant_visibility_by_brand(**params) -> ShoppingMerchantVisibilityByBrandResponse
• client.reports.shopping.product_merchant_urls(**params) -> ShoppingProductMerchantURLsResponse
• client.reports.shopping.trigger_rate(**params) -> ShoppingTriggerRateResponse
• client.reports.shopping.visibility(**params) -> ShoppingVisibilityResponse

Accuracy

Types:

from profound.types.reports import (
    AccuracyCreateBreakdownResponse,
    AccuracyCreateCitationAnalysisResponse,
    AccuracyCreateClaimBreakdownResponse,
    AccuracyCreateClaimCitationsResponse,
    AccuracyCreateClusterExampleRunsResponse,
    AccuracyCreateClusterVerificationPairsResponse,
    AccuracyCreateFactcheckSetupStatusResponse,
    AccuracyCreateInaccuracyDriversResponse,
    AccuracyCreateInaccurateClustersResponse,
    AccuracyCreateInaccurateThemesResponse,
    AccuracyCreateOverviewResponse,
    AccuracyCreateTopInaccurateClaimsResponse,
    AccuracyCreateTopicIDsResponse,
)

Methods:

• client.reports.accuracy.create_breakdown(**params) -> AccuracyCreateBreakdownResponse
• client.reports.accuracy.create_citation_analysis(**params) -> AccuracyCreateCitationAnalysisResponse
• client.reports.accuracy.create_claim_breakdown(**params) -> AccuracyCreateClaimBreakdownResponse
• client.reports.accuracy.create_claim_citations(**params) -> AccuracyCreateClaimCitationsResponse
• client.reports.accuracy.create_cluster_example_runs(**params) -> AccuracyCreateClusterExampleRunsResponse
• client.reports.accuracy.create_cluster_verification_pairs(**params) -> AccuracyCreateClusterVerificationPairsResponse
• client.reports.accuracy.create_factcheck_setup_status(**params) -> AccuracyCreateFactcheckSetupStatusResponse
• client.reports.accuracy.create_inaccuracy_drivers(**params) -> AccuracyCreateInaccuracyDriversResponse
• client.reports.accuracy.create_inaccurate_clusters(**params) -> AccuracyCreateInaccurateClustersResponse
• client.reports.accuracy.create_inaccurate_themes(**params) -> AccuracyCreateInaccurateThemesResponse
• client.reports.accuracy.create_overview(**params) -> AccuracyCreateOverviewResponse
• client.reports.accuracy.create_top_inaccurate_claims(**params) -> AccuracyCreateTopInaccurateClaimsResponse
• client.reports.accuracy.create_topic_ids(**params) -> AccuracyCreateTopicIDsResponse

Logs

Raw

Types:

from profound.types.logs import RawBotsResponse, RawLogsResponse

Methods:

• client.logs.raw.bots(**params) -> RawBotsResponse
• client.logs.raw.logs(**params) -> RawLogsResponse

Content

Optimization

Types:

from profound.types.content import OptimizationRetrieveResponse, OptimizationListResponse

Methods:

• client.content.optimization.retrieve(content_id, *, asset_id) -> OptimizationRetrieveResponse
• client.content.optimization.list(asset_id, **params) -> OptimizationListResponse

Agents

Types:

from profound.types import (
    AgentCreateResponse,
    AgentRetrieveResponse,
    AgentUpdateResponse,
    AgentListResponse,
    AgentPublishResponse,
    AgentRetrieveGraphResponse,
)

Methods:

• client.agents.create(**params) -> AgentCreateResponse
• client.agents.retrieve(agent_id, **params) -> AgentRetrieveResponse
• client.agents.update(agent_id, **params) -> AgentUpdateResponse
• client.agents.list(**params) -> AgentListResponse
• client.agents.publish(agent_id) -> AgentPublishResponse
• client.agents.retrieve_graph(agent_id, **params) -> AgentRetrieveGraphResponse

Runs

Types:

from profound.types.agents import RunCreateResponse, RunRetrieveResponse

Methods:

• client.agents.runs.create(agent_id, **params) -> RunCreateResponse
• client.agents.runs.retrieve(run_id, *, agent_id) -> RunRetrieveResponse

NodeTypes

Types:

from profound.types.agents import NodeTypeListResponse, NodeTypeRetrieveSchemaResponse

Methods:

• client.agents.node_types.list() -> NodeTypeListResponse
• client.agents.node_types.retrieve_schema(node_type) -> NodeTypeRetrieveSchemaResponse

KnowledgeBases

Types:

from profound.types import KnowledgeBaseListResponse, KnowledgeBaseSearchResponse

Methods:

• client.knowledge_bases.list(**params) -> KnowledgeBaseListResponse
• client.knowledge_bases.search(knowledge_base_id, **params) -> KnowledgeBaseSearchResponse

Documents

Types:

from profound.types.knowledge_bases import (
    DocumentCreateResponse,
    DocumentUpdateResponse,
    DocumentDeleteResponse,
)

Methods:

• client.knowledge_bases.documents.create(knowledge_base_id, **params) -> DocumentCreateResponse
• client.knowledge_bases.documents.update(knowledge_base_id, **params) -> DocumentUpdateResponse
• client.knowledge_bases.documents.delete(knowledge_base_id, **params) -> DocumentDeleteResponse

Folders

Types:

from profound.types.knowledge_bases import FolderCreateResponse, FolderDeleteResponse

Methods:

• client.knowledge_bases.folders.create(knowledge_base_id, **params) -> FolderCreateResponse
• client.knowledge_bases.folders.delete(knowledge_base_id, **params) -> FolderDeleteResponse