{"openapi":"3.0.3","info":{"title":"BeReach API","description":"BeReach | Unofficial Linkedin API","version":"2.0.0","contact":{"name":"BeReach Support","email":"alexandre@berea.ch","url":"https://bereach.ai/api"},"license":{"name":"AGPL-3.0 license","url":"https://github.com/berea-ch/bereach/blob/main/LICENSE.md"}},"servers":[{"url":"https://api.bereach.ai","description":"Production API"},{"url":"https://api-staging.bereach.ai","description":"Staging API"}],"tags":[{"name":"search","description":"Search LinkedIn for posts, people, companies, and jobs. Includes parameter resolution (typeahead) for converting text to LinkedIn IDs."},{"name":"salesNav","description":"Search LinkedIn Sales Navigator for leads (people) and accounts (companies). Requires an active Sales Navigator subscription."},{"name":"profile","description":"Endpoints for the authenticated user's own LinkedIn profile"},{"name":"scrapers","description":"Endpoints for scraping LinkedIn interactions (likes, comments, posts)"},{"name":"actions","description":"Endpoints for performing LinkedIn actions (visit, connect, message, like, reply, publish)"},{"name":"chat","description":"Endpoints for LinkedIn inbox: list conversations, search, read messages"},{"name":"companyPages","description":"Endpoints for managing LinkedIn company pages: list, permissions, posts, and actions"},{"name":"campaigns","description":"Endpoints for managing campaigns and workflow filtering"},{"name":"contacts","description":"Endpoints for managing contacts and lifecycle stages without requiring a campaign"},{"name":"scheduledMessages","description":"Endpoints for creating, scheduling, and managing draft DMs"},{"name":"context","description":"Endpoints for managing user-defined context entries (ICP, Messaging Playbook, search-strategy, engagement-strategy, etc.)"},{"name":"tasks","description":"Endpoints for listing, cancelling, and monitoring async campaign tasks and workflow chains"},{"name":"settings","description":"Endpoints for DM polling and connection polling configuration"},{"name":"workspace","description":"Endpoints for managing workspace accounts, invitations, and plan upgrades"}],"paths":{"/collect/linkedin/likes":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"],"resultShape":"list","guards":["omitData"]},"operationId":"collectLikes","x-speakeasy-name-override":"collectLikes","summary":"Scrape LinkedIn post likes","description":"Returns up to 100 profiles per page that reacted to the specified post. Supports pagination. Use count=0 to get only the total count without profile data.","tags":["scrapers"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"postUrl":"https://www.linkedin.com/feed/update/urn:li:activity:1234567890123456789/","start":0},"schema":{"type":"object","properties":{"postUrl":{"type":"string","description":"LinkedIn post URL to inspect for reactions."},"start":{"description":"Pagination offset (multiples of 100).","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"description":"Number of likes to fetch per page (0-100, default 100). Use count=0 to fetch only the total count without profile data.","type":"integer","minimum":0,"maximum":100},"campaignSlug":{"description":"Campaign ID. Auto-adds discovered contacts to this campaign in background.","type":"string"},"omitData":{"description":"When true, returns only counts (no profiles array). Data is still saved to DB.","type":"boolean"}},"required":["postUrl"]}}}},"responses":{"200":{"description":"List of profiles who liked the post","content":{"application/json":{"example":{"success":true,"profiles":[{"name":"Alex Doe","headline":"Growth Lead @ Example","profileUrl":"https://www.linkedin.com/in/alex-doe","imageUrl":"https://media.licdn.com/dms/image/C4D03AQG1/profile-displayphoto-shrink_200_200/0/...","publicIdentifier":"alex-doe","profileUrn":"urn:li:fsd_profile:ACoAABZ0Qo4B6pt58d4FVmts1F7TPi4D1-uL1fw","type":"like","reactionType":"LIKE"}],"count":1,"total":250,"start":0,"hasMore":true,"previousTotal":null,"creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"profiles":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"headline":{"nullable":true,"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"imageUrl":{"nullable":true,"type":"string"},"publicIdentifier":{"nullable":true,"description":"Vanity slug from profile URL (e.g. john-doe) when not URN-based","type":"string"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN (e.g. urn:li:fsd_profile:ACoAAA...) when available","type":"string"},"type":{"type":"string","enum":["like"]},"reactionType":{"description":"Reaction type (e.g. 'LIKE', 'CELEBRATE', 'EMPATHY', 'INTEREST', 'PRAISE', 'APPRECIATION').","type":"string"}},"required":["name","headline","profileUrl","imageUrl","publicIdentifier","profileUrn","type"],"additionalProperties":false}},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of profiles returned in this page."},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total number of likes on the post."},"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pagination offset used for this response."},"hasMore":{"type":"boolean","description":"True when more pages are available beyond this one."},"previousTotal":{"nullable":true,"description":"The total from your last call to this endpoint for the same post (null on first call). Compare with total to detect new likes without client-side tracking.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","profiles","count","total","start","hasMore","previousTotal","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/collect/linkedin/comments":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"],"resultShape":"list","guards":["omitData"]},"operationId":"collectComments","x-speakeasy-name-override":"collectComments","summary":"Scrape LinkedIn post comments","description":"Returns paginated top-level comments for a LinkedIn post (newest first). Use count=0 to get only the total count without profile data. Response includes previousTotal to detect new comments without client-side tracking.","tags":["scrapers"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"postUrl":"https://www.linkedin.com/feed/update/urn:li:activity:1234567890123456789/","start":0,"count":100},"schema":{"type":"object","properties":{"postUrl":{"type":"string","description":"LinkedIn post URL to inspect for comments."},"start":{"description":"Pagination offset (multiples of 100).","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"description":"Number of comments to fetch per page (0-100, default 100). Use count=0 to fetch only the total count without profile data.","type":"integer","minimum":0,"maximum":100},"campaignSlug":{"description":"When provided, each profile in the response includes actionsCompleted (message/reply/like/visit/connect booleans) and knownDistance (cached memberDistance from recent visits, null if not cached). Enables campaign-aware scraping without manual cross-referencing. Also auto-adds contacts to the campaign.","type":"string"},"omitData":{"description":"When true, returns only counts (no profiles array). Data is still saved to DB.","type":"boolean"}},"required":["postUrl"]}}}},"responses":{"200":{"description":"List of profiles who commented on the post","content":{"application/json":{"example":{"success":true,"profiles":[{"name":"Sam Smith","headline":"Founder @ Startup","profileUrl":"https://www.linkedin.com/in/sam-smith","imageUrl":"https://media.licdn.com/dms/image/C4D03AQG1/profile-displayphoto-shrink_200_200/0/...","publicIdentifier":"sam-smith","profileUrn":"urn:li:fsd_profile:ACoAABZ0Qo4B6pt58d4FVmts1F7TPi4D1-uL1fw","commentText":"Love this insight!","timestamp":1731547200000,"isEdited":false,"commentUrn":"urn:li:comment:(activity:1234567890123456789,9876543210987654321)","commentHash":"a1b2c3d4e5f6...","isPostAuthor":false,"repliesCount":2,"hasReplyFromPostAuthor":false,"postUrn":"urn:li:activity:1234567890123456789","postHash":"f6e5d4c3b2a1...","type":"comment"}],"count":1,"total":12,"start":0,"hasMore":true,"previousTotal":10,"creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"profiles":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"headline":{"nullable":true,"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"imageUrl":{"nullable":true,"type":"string"},"publicIdentifier":{"nullable":true,"description":"Vanity slug from profile URL (e.g. john-doe) when not URN-based","type":"string"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN (e.g. urn:li:fsd_profile:ACoAAA...) when available","type":"string"},"type":{"type":"string","enum":["comment"]},"commentText":{"type":"string"},"timestamp":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"isEdited":{"type":"boolean"},"commentUrn":{"description":"Full comment URN — use directly for /reply and /like endpoints. Do NOT reconstruct from hash fields.","type":"string"},"commentHash":{"description":"SHA256 hash of commentUrn — use for dedup slugs only, not for building URNs.","type":"string"},"isPostAuthor":{"description":"True if the commenter is the post author.","type":"boolean"},"repliesCount":{"description":"Number of replies to this comment.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasReplyFromPostAuthor":{"description":"True if the post author already replied to this comment. Null when unknown (e.g. LinkedIn only preloaded partial replies).","nullable":true,"type":"boolean"},"parentCommentUrn":{"description":"URN of the parent comment, present on replies only.","type":"string"},"postUrn":{"description":"URN of the post being commented on.","type":"string"},"postHash":{"description":"SHA256 hash of postUrn — use for dedup slugs only.","type":"string"},"actionsCompleted":{"description":"Per-profile action completion status within the campaign. Only present when campaignSlug is provided in the request.","type":"object","properties":{"message":{"type":"boolean"},"reply":{"type":"boolean"},"like":{"type":"boolean"},"visit":{"type":"boolean"},"connect":{"type":"boolean"}},"required":["message","reply","like","visit","connect"],"additionalProperties":false},"knownDistance":{"nullable":true,"description":"Cached memberDistance from a recent profile visit (1 = connected, 2 = 2nd degree, etc.). null if campaignSlug not provided or profile not visited recently.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["name","headline","profileUrl","imageUrl","publicIdentifier","profileUrn","type","timestamp","knownDistance"],"additionalProperties":false}},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of profiles returned in this page."},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total number of comments on the post."},"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Pagination offset used for this response."},"hasMore":{"type":"boolean","description":"True when more pages are available beyond this one."},"previousTotal":{"nullable":true,"description":"The total from your last call to this endpoint for the same post (null on first call). Compare with total to detect new comments without client-side tracking.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"processedCount":{"description":"Number of returned profiles that already have a completed 'message' action in this campaign. Only present when campaignSlug is provided.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"newCount":{"description":"Number of returned profiles that have NOT yet been messaged in this campaign. Only present when campaignSlug is provided.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","profiles","count","total","start","hasMore","previousTotal","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/collect/linkedin/comments/replies":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"],"resultShape":"list"},"operationId":"collectCommentReplies","x-speakeasy-name-override":"collectCommentReplies","summary":"Scrape replies to a LinkedIn comment","description":"Returns paginated replies for a specific LinkedIn comment. Use the commentUrn from the comments endpoint response.","tags":["scrapers"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"commentUrn":"urn:li:comment:(activity:7654321098765432100,1234567890)"},"schema":{"type":"object","properties":{"commentUrn":{"type":"string","description":"Comment URN returned by the comments endpoint (e.g., 'urn:li:comment:(activity:123456,789)')."},"start":{"description":"Pagination offset (default 0).","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"description":"Number of replies to fetch per page (0-100, default 100)","type":"integer","minimum":0,"maximum":100}},"required":["commentUrn"]}}}},"responses":{"200":{"description":"List of replies to the comment","content":{"application/json":{"example":{"success":true,"replies":[{"name":"Jane Doe","headline":"Product Manager at Acme","profileUrl":"https://www.linkedin.com/in/janedoe","imageUrl":"https://media.licdn.com/dms/image/example/photo.jpg","publicIdentifier":"janedoe","profileUrn":"urn:li:fsd_profile:ACoAABZ0Qo4B6pt58d4FVmts1F7TPi4D1-uL1fw","type":"comment","commentText":"Great point! I totally agree.","timestamp":1700000000000,"isEdited":false}],"count":1,"total":3,"start":0,"hasMore":true,"parentCommentUrn":"urn:li:comment:(activity:7654321098765432100,1234567890)","previousTotal":null,"creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"replies":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"headline":{"nullable":true,"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"imageUrl":{"nullable":true,"type":"string"},"publicIdentifier":{"nullable":true,"description":"Vanity slug from profile URL (e.g. john-doe) when not URN-based","type":"string"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN (e.g. urn:li:fsd_profile:ACoAAA...) when available","type":"string"},"type":{"type":"string","enum":["comment"]},"commentText":{"type":"string"},"timestamp":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"isEdited":{"type":"boolean"},"commentUrn":{"description":"Full comment URN — use directly for /reply and /like endpoints. Do NOT reconstruct from hash fields.","type":"string"},"commentHash":{"description":"SHA256 hash of commentUrn — use for dedup slugs only, not for building URNs.","type":"string"},"isPostAuthor":{"description":"True if the commenter is the post author.","type":"boolean"},"repliesCount":{"description":"Number of replies to this comment.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasReplyFromPostAuthor":{"description":"True if the post author already replied to this comment. Null when unknown (e.g. LinkedIn only preloaded partial replies).","nullable":true,"type":"boolean"},"parentCommentUrn":{"description":"URN of the parent comment, present on replies only.","type":"string"},"postUrn":{"description":"URN of the post being commented on.","type":"string"},"postHash":{"description":"SHA256 hash of postUrn — use for dedup slugs only.","type":"string"},"actionsCompleted":{"description":"Per-profile action completion status within the campaign. Only present when campaignSlug is provided in the request.","type":"object","properties":{"message":{"type":"boolean"},"reply":{"type":"boolean"},"like":{"type":"boolean"},"visit":{"type":"boolean"},"connect":{"type":"boolean"}},"required":["message","reply","like","visit","connect"],"additionalProperties":false},"knownDistance":{"nullable":true,"description":"Cached memberDistance from a recent profile visit (1 = connected, 2 = 2nd degree, etc.). null if campaignSlug not provided or profile not visited recently.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["name","headline","profileUrl","imageUrl","publicIdentifier","profileUrn","type","timestamp","knownDistance"],"additionalProperties":false}},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasMore":{"type":"boolean"},"parentCommentUrn":{"type":"string"},"previousTotal":{"nullable":true,"description":"The total from your last call to this endpoint for the same comment (null on first call). Compare with total to detect new replies without client-side tracking.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","replies","count","total","start","hasMore","parentCommentUrn","previousTotal","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/collect/linkedin/posts":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"],"resultShape":"post"},"operationId":"collectPosts","x-speakeasy-name-override":"collectPosts","summary":"Scrape LinkedIn profile posts","description":"Returns paginated posts from a LinkedIn profile. Supports count, start, and paginationToken for pagination.","tags":["scrapers"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"profileUrl":"https://www.linkedin.com/in/username","count":20,"start":0},"schema":{"type":"object","properties":{"profileUrl":{"type":"string","description":"LinkedIn profile identifier. Accepts PERSONAL profiles (full URLs like https://www.linkedin.com/in/username, vanity names like john-doe, or URNs like urn:li:fsd_profile:ACoAAA...) AND COMPANY pages (full URLs like https://www.linkedin.com/company/fnaim or https://fr.linkedin.com/company/fnaim). Company URLs hit the organization-updates feed; personal URLs hit the profile activity feed. Same result shape for both."},"count":{"description":"Number of posts to fetch (0-100, default 20)","type":"integer","minimum":0,"maximum":100},"start":{"description":"Pagination offset (default 0).","type":"integer","minimum":0,"maximum":9007199254740991},"paginationToken":{"description":"Pagination token from a previous response to fetch the next page.","type":"string"},"returnReposts":{"default":false,"description":"Include reposts/reshares in results. Defaults to false (only original posts).","type":"boolean"}},"required":["profileUrl"]}}}},"responses":{"200":{"description":"Paginated list of posts from the profile","content":{"application/json":{"example":{"success":true,"posts":[{"postUrl":"https://www.linkedin.com/posts/username_activity-1234567890","text":"Post content here","date":1731547200000,"likesCount":50,"commentsCount":10,"sharesCount":5,"postUrn":"urn:li:activity:1234567890","postId":"1234567890","type":"activity"}],"count":1,"total":42,"start":0,"hasMore":true,"paginationToken":"abc123-pagination-token","creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"posts":{"type":"array","items":{"type":"object","properties":{"postUrl":{"type":"string","description":"Public URL of the post."},"text":{"type":"string","description":"Post text content."},"date":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Post creation timestamp (Unix milliseconds)."},"likesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total reactions on this post."},"commentsCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total top-level comments on this post."},"sharesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total shares/reposts of this post."},"postUrn":{"type":"string","description":"LinkedIn internal URN for this post. Use with engagement tools (like, comment, collect_likes/comments)."},"postId":{"type":"string","description":"Numeric post identifier parsed from the URN."},"type":{"type":"string","enum":["activity","ugcPost","share"],"description":"LinkedIn post type: 'ugcPost' = standard post, 'share' = native share/repost, 'activity' = legacy format."},"isRepost":{"description":"True when the post is a repost/reshare of another post. Absent for original posts.","type":"boolean"},"media":{"description":"Media attached to the post (image, video, document, or article). Absent when the post is text-only.","type":"object","properties":{"type":{"type":"string","enum":["image","video","document","article"],"description":"Type of media attached to the post."},"urls":{"type":"array","items":{"type":"string"},"description":"Media URLs (image URLs for carousels, video streaming URL, article link, etc.)."},"title":{"description":"Title of the article or document, when available.","type":"string"},"thumbnailUrl":{"description":"Thumbnail URL for videos, articles, or document covers.","type":"string"}},"required":["type","urls"],"additionalProperties":false}},"required":["postUrl","text","date","likesCount","commentsCount","sharesCount","postUrn","postId","type"],"additionalProperties":false}},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasMore":{"type":"boolean"},"paginationToken":{"nullable":true,"type":"string"},"previousTotal":{"nullable":true,"description":"The total from your last call to this endpoint for the same profile (null on first call). Compare with total to detect new posts without client-side tracking.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","posts","count","total","start","hasMore","paginationToken","previousTotal","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/search/linkedin":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"],"excludeTool":true},"operationId":"unifiedSearch","x-speakeasy-name-override":"search","summary":"Unified LinkedIn Search — posts, people, companies, jobs","description":"# Unified LinkedIn Search\n\nThis is the **all-in-one** search endpoint. It accepts any of the 4 categories (posts, people, companies, jobs) and returns structured results.\n\n## When to use this endpoint\nUse this endpoint when you need to search across categories dynamically (e.g. the user chooses the category at runtime). For a simpler interface with category-specific documentation, use the dedicated endpoints:\n- `POST /search/linkedin/posts` — search posts\n- `POST /search/linkedin/people` — search people\n- `POST /search/linkedin/companies` — search companies\n- `POST /search/linkedin/jobs` — search jobs\n- `POST /search/linkedin/url` — search by pasting a LinkedIn search URL\n\n## Two ways to search\n1. **Structured**: pass `category` + `keywords` + optional filters\n2. **URL-based**: pass a LinkedIn search `url` — the endpoint parses it automatically\n\nExplicit parameters always override URL-derived values.\n\n## Keyword syntax (Boolean operators)\nKeywords support LinkedIn Boolean search syntax for precise matching:\n- **Exact phrase**: wrap in double quotes — `\"outreach automation\"` matches only that exact phrase\n- **AND**: both terms required — `outreach AND linkedin` (default when terms are space-separated)\n- **OR**: either term — `CEO OR founder OR owner`\n- **NOT**: exclude — `manager NOT assistant`\n- **Parentheses**: group — `(CEO OR CTO) AND SaaS`\n\nOperators must be **UPPERCASE** (`AND`, `OR`, `NOT`). Lowercase is treated as plain text. Wildcards (`*`) and `+`/`-` are not supported. Precedence: Quotes → Parentheses → NOT → AND → OR.\n\nWithout quotes, a multi-word query like `outreach automation` is treated as `outreach AND automation`, which may return broad results. Use `\"outreach automation\"` for exact matching.\n\n## Resolving filter IDs\nMany filters (location, industry, company, school) require LinkedIn numeric IDs. Use `GET /search/linkedin/parameters` to convert text (e.g. \"San Francisco\") into IDs (e.g. \"103644278\").\n\n## Pagination\nUse `start` (offset, default 0) and `count` (page size, default 10, max 50). The response includes `paging.total` and `hasMore` to control iteration.\n\n## Credits\n","tags":["search"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"category":"people","keywords":"software engineer","connectionDegree":["F","S"],"location":["103644278"],"industry":["4","6"],"count":10,"start":0},"schema":{"type":"object","properties":{"category":{"description":"Type of search to perform (required unless url is provided)","type":"string","enum":["posts","people","companies","jobs"]},"url":{"description":"LinkedIn search URL — category and filters are extracted automatically. Explicit params override URL-derived ones.","type":"string"},"keywords":{"description":"Search keywords. Supports LinkedIn Boolean syntax: use double quotes for exact phrases (e.g. \"outreach automation\"), AND to require both terms, OR for alternatives (e.g. CEO OR founder), NOT to exclude (e.g. manager NOT assistant), and parentheses to group (e.g. (CEO OR CTO) AND SaaS). Operators must be UPPERCASE. Without quotes, multi-word queries are treated as AND by default which may return overly broad results — use exact phrases with quotes for precise matching.","type":"string"},"sortBy":{"description":"Sort order (posts & jobs)","type":"string","enum":["relevance","date"]},"datePosted":{"description":"Time filter (posts & jobs)","type":"string","enum":["past-24h","past-week","past-month"]},"contentType":{"description":"Media type filter (posts only)","type":"string","enum":["images","videos","documents"]},"authorIndustry":{"description":"Author industry IDs (posts only, resolve via /search/parameters)","type":"array","items":{"type":"string"}},"authorCompany":{"description":"Author company IDs (posts only, resolve via /search/parameters)","type":"array","items":{"type":"string"}},"connectionDegree":{"description":"Connection degree: F=1st, S=2nd, O=3rd+ (people only)","type":"array","items":{"type":"string","enum":["F","S","O"]}},"firstName":{"description":"First name filter (people only)","type":"string"},"lastName":{"description":"Last name filter (people only)","type":"string"},"title":{"description":"Job title filter (people only). Supports LinkedIn Boolean OR syntax: 'CEO OR CTO OR CMO'. Pipe separators are auto-converted: 'CEO|CTO|CMO' becomes 'CEO OR CTO OR CMO'. Use quotes for exact multi-word titles: '\"Head of Marketing\"'.","type":"string"},"connectionOf":{"description":"Profile URN to find connections of (people only)","type":"string"},"followersOf":{"description":"Profile URNs whose followers to search — find a creator's audience (people only)","type":"array","items":{"type":"string"}},"openToVolunteering":{"description":"Only people open to volunteering (people only)","type":"boolean"},"serviceCategories":{"description":"LinkedIn Service-Marketplace category names — for freelancer/consultant discovery, resolved to IDs server-side (people only)","type":"array","items":{"type":"string"}},"profileLanguage":{"description":"Profile language codes e.g. ['en','fr'] (people only)","type":"array","items":{"type":"string"}},"school":{"description":"School IDs (people only, resolve via /search/parameters)","type":"array","items":{"type":"string"}},"location":{"description":"Geo IDs (people, companies, jobs -- resolve via /search/parameters)","type":"array","items":{"type":"string"}},"industry":{"description":"Industry IDs (people, companies -- resolve via /search/parameters)","type":"array","items":{"type":"string"}},"currentCompany":{"description":"Current company IDs (people only, resolve via /search/parameters)","type":"array","items":{"type":"string"}},"pastCompany":{"description":"Past company IDs (people only, resolve via /search/parameters)","type":"array","items":{"type":"string"}},"companySize":{"description":"Company size: A=1-10, B=11-50, C=51-200, D=201-500, E=501-1K, F=1K-5K, G=5K-10K, H=10K+, I=self (companies only)","type":"array","items":{"type":"string","enum":["A","B","C","D","E","F","G","H","I"]}},"jobType":{"description":"Job type: F=Full-time, P=Part-time, C=Contract, T=Temporary, I=Internship, V=Volunteer, O=Other (jobs only)","type":"array","items":{"type":"string","enum":["F","P","C","T","I","V","O"]}},"experienceLevel":{"description":"Experience level: 1=Internship, 2=Entry, 3=Associate, 4=Mid-Senior, 5=Director, 6=Executive (jobs only)","type":"array","items":{"type":"string","enum":["1","2","3","4","5","6"]}},"workplaceType":{"description":"Workplace type: 1=On-site, 2=Remote, 3=Hybrid (jobs only)","type":"array","items":{"type":"string","enum":["1","2","3"]}},"company":{"description":"Hiring company names, resolved to IDs server-side (jobs only)","type":"array","items":{"type":"string"}},"jobFunction":{"description":"Job function names: Information Technology, Engineering, Consulting, Sales, Marketing, Finance, Business Development, Management, Project Management, Quality Assurance, Analyst, Research, Manufacturing, Other (jobs only)","type":"array","items":{"type":"string"}},"easyApply":{"description":"Only LinkedIn Easy Apply jobs (jobs only)","type":"boolean"},"under10Applicants":{"description":"Only jobs with fewer than 10 applicants (jobs only)","type":"boolean"},"inYourNetwork":{"description":"Only jobs at companies where you have a connection (jobs only)","type":"boolean"},"hasVerifications":{"description":"Only jobs from verified posters (jobs only)","type":"boolean"},"fairChanceEmployer":{"description":"Only jobs from Fair Chance employers (jobs only)","type":"boolean"},"benefits":{"description":"Advertised benefit names e.g. ['Medical insurance','401(k)'] (jobs only)","type":"array","items":{"type":"string"}},"commitments":{"description":"Employer commitment names e.g. ['Work-life balance'] (jobs only)","type":"array","items":{"type":"string"}},"start":{"description":"Pagination offset (default 0)","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"description":"Results per page (default 10, max 50)","type":"integer","minimum":1,"maximum":50},"campaignSlug":{"description":"Campaign ID. Auto-adds discovered contacts to this campaign in background.","type":"string"}}}}}},"responses":{"200":{"description":"Search results for the specified category","content":{"application/json":{"example":{"success":true,"category":"people","items":[{"type":"PEOPLE","name":"Jane Smith","profileUrl":"https://www.linkedin.com/in/janesmith","headline":"Senior Software Engineer at Google","location":"San Francisco Bay Area","profilePicture":null,"networkDistance":"DISTANCE_2","currentPositions":[{"company":"Google","role":"Senior Software Engineer"}],"publicIdentifier":"janesmith","profileUrn":"urn:li:fsd_profile:ACoAAB1234567890"}],"paging":{"start":0,"count":10,"total":1000},"hasMore":true,"creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"category":{"type":"string","enum":["posts","people","companies","jobs"]},"items":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["POST"]},"postUrl":{"type":"string","description":"Public URL of the post."},"text":{"type":"string","description":"Post text content."},"date":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Post creation timestamp (Unix milliseconds)."},"likesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total reactions on this post."},"commentsCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total top-level comments on this post."},"sharesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total shares/reposts of this post."},"postUrn":{"type":"string","description":"LinkedIn internal URN for this post. Use with engagement tools (like, comment, collect_likes/comments)."},"postId":{"type":"string","description":"Numeric post identifier parsed from the URN."},"author":{"type":"object","properties":{"name":{"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"profilePicture":{"nullable":true,"type":"string"},"isCompany":{"type":"boolean"},"publicIdentifier":{"nullable":true,"description":"Vanity slug when not URN-based","type":"string"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN when available","type":"string"}},"required":["name","profileUrl","headline","profilePicture","isCompany","publicIdentifier","profileUrn"],"additionalProperties":false},"isRepost":{"type":"boolean"},"media":{"description":"Media attached to the post (image, video, document, or article). Absent when the post is text-only.","type":"object","properties":{"type":{"type":"string","enum":["image","video","document","article"],"description":"Type of media attached to the post."},"urls":{"type":"array","items":{"type":"string"},"description":"Media URLs (image URLs for carousels, video streaming URL, article link, etc.)."},"title":{"description":"Title of the article or document, when available.","type":"string"},"thumbnailUrl":{"description":"Thumbnail URL for videos, articles, or document covers.","type":"string"}},"required":["type","urls"],"additionalProperties":false}},"required":["type","postUrl","text","date","likesCount","commentsCount","sharesCount","postUrn","postId","author","isRepost"],"additionalProperties":false}},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["PEOPLE"]},"name":{"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"location":{"nullable":true,"type":"string"},"profilePicture":{"nullable":true,"type":"string"},"networkDistance":{"nullable":true,"description":"LinkedIn network distance: DISTANCE_1=connected, DISTANCE_2=2nd degree, DISTANCE_3=3rd degree, OUT_OF_NETWORK=not connected.","type":"string","enum":["DISTANCE_1","DISTANCE_2","DISTANCE_3","OUT_OF_NETWORK"]},"currentPositions":{"type":"array","items":{"type":"object","properties":{"company":{"nullable":true,"type":"string"},"role":{"nullable":true,"type":"string"}},"required":["company","role"],"additionalProperties":false},"description":"Current work positions for this profile."},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN (e.g. urn:li:fsd_profile:ACoAAA...) when available","type":"string"},"publicIdentifier":{"nullable":true,"description":"Vanity slug from profile URL (e.g. john-doe) when not URN-based","type":"string"}},"required":["type","name","profileUrl","headline","location","profilePicture","networkDistance","currentPositions","profileUrn","publicIdentifier"],"additionalProperties":false}},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["COMPANY"]},"name":{"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"summary":{"nullable":true,"type":"string"},"industry":{"nullable":true,"type":"string"},"location":{"nullable":true,"type":"string"},"followersCount":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","profileUrl","summary","industry","location","followersCount"],"additionalProperties":false}},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["JOB"]},"title":{"type":"string"},"company":{"nullable":true,"type":"string"},"companyUrl":{"nullable":true,"type":"string"},"companyLogo":{"nullable":true,"type":"string"},"location":{"nullable":true,"type":"string"},"workplaceType":{"nullable":true,"type":"string"},"postedAt":{"nullable":true,"type":"string"},"jobUrl":{"type":"string"},"listingId":{"type":"string"}},"required":["type","title","company","companyUrl","companyLogo","location","workplaceType","postedAt","jobUrl","listingId"],"additionalProperties":false}}]},"paging":{"type":"object","properties":{"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["start","count","total"],"additionalProperties":false},"hasMore":{"type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","category","items","paging","hasMore","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/search/linkedin/posts":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"],"resultShape":"post"},"operationId":"searchPosts","x-speakeasy-name-override":"posts","summary":"Search LinkedIn Posts","description":"# Search LinkedIn Posts\n\nSearch LinkedIn's content index for posts matching your keywords and filters. Returns structured post data including full text, engagement metrics, author info, and URLs.\n\n## Required parameters\n- **keywords** (string, required): The search terms to match against post content. Examples: `\"AI automation\"`, `\"remote work trends\"`, `\"SaaS growth strategies\"`.\n\n## Keyword syntax (Boolean operators)\nKeywords support LinkedIn Boolean search syntax:\n- **Exact phrase**: `\"outreach automation\"` — matches only that exact phrase\n- **AND**: `AI AND marketing` — both terms required (spaces default to AND)\n- **OR**: `\"growth hacking\" OR \"growth marketing\"` — either term\n- **NOT**: `outreach NOT webinar` — exclude unwanted terms\n- **Parentheses**: `(AI OR ML) AND \"case study\"` — group logic\n\nOperators must be **UPPERCASE**. Precedence: Quotes > Parentheses > NOT > AND > OR.\n\n## Available filters\n| Filter | Type | Description |\n|--------|------|-------------|\n| `sortBy` | `\"relevance\"` \\| `\"date\"` | Sort by relevance (default) or most recent first |\n| `datePosted` | `\"past-24h\"` \\| `\"past-week\"` \\| `\"past-month\"` | Filter by publication recency |\n| `contentType` | `\"images\"` \\| `\"videos\"` \\| `\"documents\"` | Filter by media type |\n| `authorIndustry` | string[] | Author's industry IDs (resolve via `/search/linkedin/parameters` with type=`INDUSTRY`) |\n| `authorCompany` | string[] | Author's company IDs (resolve via `/search/linkedin/parameters` with type=`COMPANY`) |\n\n## Response fields (per item)\n| Field | Type | Description |\n|-------|------|-------------|\n| `postUrl` | string | Direct URL to the LinkedIn post |\n| `text` | string | Full post text content |\n| `date` | number | Publication timestamp (ms since epoch) |\n| `likesCount` | number | Total reactions |\n| `commentsCount` | number | Total comments |\n| `sharesCount` | number | Total shares/reposts |\n| `author.name` | string | Author's display name |\n| `author.profileUrl` | string | Author's LinkedIn profile URL |\n| `author.headline` | string | Author's headline |\n| `author.isCompany` | boolean | Whether the author is a company page |\n| `isRepost` | boolean | Whether this is a repost of another post |\n\n## Pagination\n- Default page size: 10, max: 50\n- Use `start` + `count` to paginate: `start=0, count=10` → page 1, `start=10, count=10` → page 2\n- Check `hasMore` in the response to know if more pages exist\n- `paging.total` gives the estimated total number of results\n\n## Example workflows\n1. **Content research**: Search for trending topics → analyze top posts → extract engagement patterns\n2. **Lead generation**: Search for posts about problems your product solves → extract author profiles\n3. **Competitive intelligence**: Search for competitor mentions → track sentiment and engagement\n\n## Credits\n","tags":["search"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"keywords":"AI automation","sortBy":"date","datePosted":"past-week","count":10,"start":0},"schema":{"type":"object","properties":{"keywords":{"type":"string","description":"Search keywords (required). Searches across post text content. Supports LinkedIn Boolean syntax: use double quotes for exact phrases (e.g. \"AI automation\"), AND to require both terms, OR for alternatives (e.g. \"growth hacking\" OR \"growth marketing\"), NOT to exclude (e.g. outreach NOT webinar), and parentheses to group (e.g. (AI OR ML) AND \"case study\"). Operators must be UPPERCASE. Without quotes, multi-word queries are treated as AND by default which may return broad results."},"url":{"description":"Optional LinkedIn search URL. If provided, keywords and filters are extracted from the URL. Explicit params override URL-derived values.","type":"string"},"sortBy":{"description":"Sort order. 'relevance' (default) returns the most relevant posts. 'date' returns the most recent posts first.","type":"string","enum":["relevance","date"]},"datePosted":{"description":"Filter by publication date. Useful for finding recent discussions or trending topics.","type":"string","enum":["past-24h","past-week","past-month"]},"contentType":{"description":"Filter by media type. Only return posts that contain the specified media. 'images' = photo posts, 'videos' = video posts, 'documents' = carousel/PDF posts.","type":"string","enum":["images","videos","documents"]},"authorIndustry":{"description":"Filter by the post author's industry. Array of LinkedIn industry IDs. Resolve text to IDs via GET /search/linkedin/parameters with type='INDUSTRY'. Example: resolve 'Technology' to get industry IDs.","type":"array","items":{"type":"string"}},"authorCompany":{"description":"Filter by the post author's company. Array of LinkedIn company IDs. Resolve text to IDs via GET /search/linkedin/parameters with type='COMPANY'. Example: resolve 'Google' to get company ID '1441'.","type":"array","items":{"type":"string"}},"start":{"description":"Pagination offset (default 0). Use multiples of `count` to page through results. Example: start=0 for page 1, start=10 for page 2 (with count=10).","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"description":"Results per page (default 10, max 50). Controls how many posts are returned per request.","type":"integer","minimum":1,"maximum":50}},"required":["keywords"]}}}},"responses":{"200":{"description":"List of LinkedIn posts matching the search criteria","content":{"application/json":{"example":{"success":true,"category":"posts","items":[{"type":"POST","postUrl":"https://www.linkedin.com/feed/update/urn:li:activity:1234567890","text":"Just shipped our new AI automation pipeline...","date":1731547200000,"likesCount":142,"commentsCount":23,"sharesCount":8,"postUrn":"urn:li:activity:1234567890","postId":"1234567890","author":{"name":"Sarah Chen","profileUrl":"https://www.linkedin.com/in/sarahchen","headline":"VP Engineering at TechCo","profilePicture":null,"isCompany":false,"publicIdentifier":"sarahchen","profileUrn":"urn:li:fsd_profile:ACoAAC9876543210"},"isRepost":false}],"paging":{"start":0,"count":10,"total":500},"hasMore":true,"creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"category":{"type":"string","enum":["posts"]},"items":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["POST"]},"postUrl":{"type":"string","description":"Public URL of the post."},"text":{"type":"string","description":"Post text content."},"date":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Post creation timestamp (Unix milliseconds)."},"likesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total reactions on this post."},"commentsCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total top-level comments on this post."},"sharesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total shares/reposts of this post."},"postUrn":{"type":"string","description":"LinkedIn internal URN for this post. Use with engagement tools (like, comment, collect_likes/comments)."},"postId":{"type":"string","description":"Numeric post identifier parsed from the URN."},"author":{"type":"object","properties":{"name":{"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"profilePicture":{"nullable":true,"type":"string"},"isCompany":{"type":"boolean"},"publicIdentifier":{"nullable":true,"description":"Vanity slug when not URN-based","type":"string"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN when available","type":"string"}},"required":["name","profileUrl","headline","profilePicture","isCompany","publicIdentifier","profileUrn"],"additionalProperties":false},"isRepost":{"type":"boolean"},"media":{"description":"Media attached to the post (image, video, document, or article). Absent when the post is text-only.","type":"object","properties":{"type":{"type":"string","enum":["image","video","document","article"],"description":"Type of media attached to the post."},"urls":{"type":"array","items":{"type":"string"},"description":"Media URLs (image URLs for carousels, video streaming URL, article link, etc.)."},"title":{"description":"Title of the article or document, when available.","type":"string"},"thumbnailUrl":{"description":"Thumbnail URL for videos, articles, or document covers.","type":"string"}},"required":["type","urls"],"additionalProperties":false}},"required":["type","postUrl","text","date","likesCount","commentsCount","sharesCount","postUrn","postId","author","isRepost"],"additionalProperties":false}},"paging":{"type":"object","properties":{"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["start","count","total"],"additionalProperties":false},"hasMore":{"type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","category","items","paging","hasMore","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/search/linkedin/people":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"],"resultShape":"list"},"operationId":"searchPeople","x-speakeasy-name-override":"people","summary":"Search LinkedIn People","description":"# Search LinkedIn People\n\nFind professionals on LinkedIn by name, title, company, location, industry, and more. Returns structured profile data including name, headline, current positions, and connection degree.\n\n## Parameters\n- **keywords** (optional): Search terms matched against name, headline, company, skills, and bio\n- You can search by filters alone (no keywords) — e.g. find all 2nd-degree connections in Paris\n\n## Keyword syntax (Boolean operators)\nKeywords support LinkedIn Boolean search syntax:\n- **Exact phrase**: `\"product manager\"` — matches only that exact title\n- **AND**: `engineer AND startup` — both terms required (spaces default to AND)\n- **OR**: `CEO OR founder OR CTO` — any of the terms\n- **NOT**: `manager NOT assistant` — exclude unwanted terms\n- **Parentheses**: `(CEO OR CTO) AND SaaS` — group logic\n\nOperators must be **UPPERCASE**. Precedence: Quotes > Parentheses > NOT > AND > OR.\n\n## Available filters\n| Filter | Type | Description | Resolve IDs via |\n|--------|------|-------------|------------------|\n| `connectionDegree` | `[\"F\"\\|\"S\"\\|\"O\"]` | Connection level: F=1st, S=2nd, O=3rd+ | — |\n| `firstName` | string | Exact first name match | — |\n| `lastName` | string | Exact last name match | — |\n| `title` | string | Current job title (supports `\\|` OR syntax: `\"CEO\\|CTO\"`) | — |\n| `connectionOf` | string | Profile URN — find their connections | — |\n| `followersOf` | string[] | Profile URNs — find a creator's followers | — |\n| `openToVolunteering` | boolean | Only people open to volunteering | — |\n| `serviceCategories` | string[] | Service-Marketplace category names | — |\n| `profileLanguage` | string[] | ISO 639-1 codes: `[\"en\",\"fr\"]` | — |\n| `location` | string[] | Geo IDs | `/search/linkedin/parameters` type=`GEO` |\n| `industry` | string[] | Industry IDs | `/search/linkedin/parameters` type=`INDUSTRY` |\n| `currentCompany` | string[] | Company IDs (current employer) | `/search/linkedin/parameters` type=`COMPANY` |\n| `pastCompany` | string[] | Company IDs (past employer) | `/search/linkedin/parameters` type=`COMPANY` |\n| `school` | string[] | School/university IDs | `/search/linkedin/parameters` type=`SCHOOL` |\n\n## Response fields (per item)\n| Field | Type | Description |\n|-------|------|-------------|\n| `name` | string | Full display name |\n| `profileUrl` | string | LinkedIn profile URL |\n| `headline` | string\\|null | Professional headline |\n| `location` | string\\|null | Geographic location |\n| `profilePicture` | string\\|null | Profile photo URL |\n| `networkDistance` | string\\|null | `DISTANCE_1`, `DISTANCE_2`, `DISTANCE_3`, or `OUT_OF_NETWORK` |\n| `currentPositions` | array | Current job positions with `company` and `role` |\n\n## Pagination\n- Default page size: 10, max: 50\n- Use `start` + `count` to paginate. Check `hasMore` for more pages.\n- Paginate via `start` + `count`; check `hasMore` for more pages.\n\n## Example workflows\n1. **Prospect list building**: Search by title + location + industry → build a targeted outreach list\n2. **Recruiting**: Search by title + company + school → find qualified candidates\n3. **Network mapping**: Search `connectionOf` + filters → explore someone's network\n\n## Multi-step workflow with filter ID resolution\n```\nStep 1: GET /search/linkedin/parameters { type: 'GEO', keywords: 'San Francisco' }\n        → returns [{ id: '102277331', title: 'San Francisco, CA' }]\nStep 2: GET /search/linkedin/parameters { type: 'COMPANY', keywords: 'Google' }\n        → returns [{ id: '1441', title: 'Google' }]\nStep 3: POST /search/linkedin/people { keywords: 'product manager', location: ['102277331'], currentCompany: ['1441'] }\n        → returns matching people\n```\n\n## Credits\n","tags":["search"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"keywords":"product manager","connectionDegree":["S"],"location":["103644278"],"currentCompany":["1441"],"count":10,"start":0},"schema":{"type":"object","properties":{"keywords":{"description":"Search keywords. Matches against name, headline, company, skills, and bio. Optional — you can search by filters alone (e.g. all 2nd-degree connections in Paris). Supports LinkedIn Boolean syntax: use double quotes for exact phrases (e.g. \"product manager\"), AND to require both terms, OR for alternatives (e.g. CEO OR founder OR CTO), NOT to exclude (e.g. manager NOT assistant), and parentheses to group (e.g. (CEO OR CTO) AND SaaS). Operators must be UPPERCASE.","type":"string"},"url":{"description":"Optional LinkedIn search URL. If provided, keywords and filters are extracted from the URL. Explicit params override URL-derived values.","type":"string"},"connectionDegree":{"description":"Filter by connection degree. 'F' = 1st degree (your direct connections), 'S' = 2nd degree (connections of connections), 'O' = 3rd+ degree and out of network. Accepts multiple values, e.g. ['F','S'] for 1st and 2nd degree.","type":"array","items":{"type":"string","enum":["F","S","O"]}},"firstName":{"description":"Filter by first name. Exact match (case-insensitive).","type":"string"},"lastName":{"description":"Filter by last name. Exact match (case-insensitive).","type":"string"},"title":{"description":"Filter by current job title. Matches against the person's current position title. Supports LinkedIn Boolean OR: 'CEO OR CTO OR Founder'. Pipe separators are auto-converted: 'CEO|CTO|Founder' becomes 'CEO OR CTO OR Founder'. Use double quotes for exact multi-word titles: '\"Head of Marketing\" OR \"VP Sales\"'.","type":"string"},"connectionOf":{"description":"Find connections of a specific person. Pass the person's LinkedIn profile URN (e.g. 'urn:li:fsd_profile:ACoAABZ0Qo4B...'). Returns people who are connected to this person.","type":"string"},"profileLanguage":{"description":"Filter by LinkedIn profile language. Array of ISO 639-1 codes. Example: ['en'] for English profiles, ['en','fr'] for English or French profiles.","type":"array","items":{"type":"string"}},"school":{"description":"Filter by school/university. Array of LinkedIn school IDs. Resolve text to IDs via GET /search/linkedin/parameters with type='SCHOOL'. Example: resolve 'Harvard' to get school IDs.","type":"array","items":{"type":"string"}},"location":{"description":"Filter by geographic location. Array of LinkedIn geo IDs. Resolve text to IDs via GET /search/linkedin/parameters with type='GEO'. Example: resolve 'San Francisco' → '102277331'.","type":"array","items":{"type":"string"}},"industry":{"description":"Filter by industry. Array of LinkedIn industry IDs. Resolve text to IDs via GET /search/linkedin/parameters with type='INDUSTRY'.","type":"array","items":{"type":"string"}},"currentCompany":{"description":"Filter by current employer. Array of LinkedIn company IDs. Resolve text to IDs via GET /search/linkedin/parameters with type='COMPANY'. Example: resolve 'Google' → '1441'.","type":"array","items":{"type":"string"}},"pastCompany":{"description":"Filter by past employer. Array of LinkedIn company IDs. Finds people who previously worked at these companies.","type":"array","items":{"type":"string"}},"followersOf":{"description":"Find people who follow a specific creator/thought-leader. Array of LinkedIn profile URNs (e.g. 'urn:li:fsd_profile:ACoAAB...'). A warm-discovery vector: the audience of an influential voice in your space. Get URNs from a prior search_people / visit_profile result.","type":"array","items":{"type":"string"}},"openToVolunteering":{"description":"When true, only return people who marked themselves open to volunteering.","type":"boolean"},"serviceCategories":{"description":"Filter by LinkedIn Service-Marketplace category — for finding freelancers/consultants. Pass category NAMES (e.g. ['Digital Marketing','Web Development','Management Consulting']) — resolved to IDs server-side.","type":"array","items":{"type":"string"}},"start":{"description":"Pagination offset (default 0). Use multiples of `count` to page through results.","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"description":"Results per page (default 10, max 50).","type":"integer","minimum":1,"maximum":50}}}}}},"responses":{"200":{"description":"List of LinkedIn people matching the search criteria","content":{"application/json":{"example":{"success":true,"category":"people","items":[{"type":"PEOPLE","name":"Jane Smith","profileUrl":"https://www.linkedin.com/in/janesmith","headline":"Senior Product Manager at Google","location":"San Francisco Bay Area","profilePicture":null,"networkDistance":"DISTANCE_2","currentPositions":[{"company":"Google","role":"Senior Product Manager"}],"publicIdentifier":"janesmith","profileUrn":"urn:li:fsd_profile:ACoAAB1234567890"}],"paging":{"start":0,"count":10,"total":1000},"hasMore":true,"creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"category":{"type":"string","enum":["people"]},"items":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["PEOPLE"]},"name":{"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"location":{"nullable":true,"type":"string"},"profilePicture":{"nullable":true,"type":"string"},"networkDistance":{"nullable":true,"description":"LinkedIn network distance: DISTANCE_1=connected, DISTANCE_2=2nd degree, DISTANCE_3=3rd degree, OUT_OF_NETWORK=not connected.","type":"string","enum":["DISTANCE_1","DISTANCE_2","DISTANCE_3","OUT_OF_NETWORK"]},"currentPositions":{"type":"array","items":{"type":"object","properties":{"company":{"nullable":true,"type":"string"},"role":{"nullable":true,"type":"string"}},"required":["company","role"],"additionalProperties":false},"description":"Current work positions for this profile."},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN (e.g. urn:li:fsd_profile:ACoAAA...) when available","type":"string"},"publicIdentifier":{"nullable":true,"description":"Vanity slug from profile URL (e.g. john-doe) when not URN-based","type":"string"}},"required":["type","name","profileUrl","headline","location","profilePicture","networkDistance","currentPositions","profileUrn","publicIdentifier"],"additionalProperties":false}},"paging":{"type":"object","properties":{"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["start","count","total"],"additionalProperties":false},"hasMore":{"type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","category","items","paging","hasMore","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/search/linkedin/companies":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"],"resultShape":"list"},"operationId":"searchCompanies","x-speakeasy-name-override":"companies","summary":"Search LinkedIn Companies","description":"# Search LinkedIn Companies\n\nFind companies on LinkedIn by name, industry, location, and employee count. Returns structured company data including name, industry, location, and follower count.\n\n## Parameters\n- **keywords** (optional): Search terms matched against company name, description, and specialties\n\n## Keyword syntax (Boolean operators)\nKeywords support LinkedIn Boolean search syntax:\n- **Exact phrase**: `\"artificial intelligence\"` — matches only that exact phrase\n- **AND**: `fintech AND payments` — both terms required (spaces default to AND)\n- **OR**: `SaaS OR \"cloud computing\"` — either term\n- **NOT**: `consulting NOT staffing` — exclude unwanted terms\n- **Parentheses**: `(AI OR ML) AND healthcare` — group logic\n\nOperators must be **UPPERCASE**. Precedence: Quotes > Parentheses > NOT > AND > OR.\n\n## Available filters\n| Filter | Type | Description | Resolve IDs via |\n|--------|------|-------------|------------------|\n| `location` | string[] | HQ geo IDs | `/search/linkedin/parameters` type=`GEO` |\n| `industry` | string[] | Industry IDs | `/search/linkedin/parameters` type=`INDUSTRY` |\n| `companySize` | string[] | Employee count codes (see below) | — |\n\n### Company size codes\n| Code | Employees |\n|------|-----------|\n| `A` | 1–10 |\n| `B` | 11–50 |\n| `C` | 51–200 |\n| `D` | 201–500 |\n| `E` | 501–1,000 |\n| `F` | 1,001–5,000 |\n| `G` | 5,001–10,000 |\n| `H` | 10,001+ |\n| `I` | Self-employed |\n\n## Response fields (per item)\n| Field | Type | Description |\n|-------|------|-------------|\n| `name` | string | Company display name |\n| `profileUrl` | string | LinkedIn company page URL |\n| `summary` | string\\|null | Company tagline/description |\n| `industry` | string\\|null | Primary industry |\n| `location` | string\\|null | HQ location |\n| `followersCount` | number\\|null | Number of LinkedIn followers |\n\n## Pagination\n- Default page size: 10, max: 50\n- Use `start` + `count` to paginate. Check `hasMore` for more pages.\n\n## Example workflows\n1. **Market research**: Search by industry + location → map the competitive landscape\n2. **Sales targeting**: Search by industry + size → build a list of target accounts\n3. **Partnership discovery**: Search by keywords + location → find potential partners\n\n## Credits\n","tags":["search"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"keywords":"AI startup","location":["103644278"],"companySize":["B","C"],"count":10,"start":0},"schema":{"type":"object","properties":{"keywords":{"description":"Search keywords. Matches against company name, description, and specialties. Optional — you can search by filters alone. Supports LinkedIn Boolean syntax: use double quotes for exact phrases (e.g. \"artificial intelligence\"), AND to require both terms, OR for alternatives (e.g. SaaS OR \"cloud computing\"), NOT to exclude (e.g. consulting NOT staffing), and parentheses to group (e.g. (AI OR ML) AND healthcare). Operators must be UPPERCASE.","type":"string"},"url":{"description":"Optional LinkedIn search URL. If provided, keywords and filters are extracted from the URL. Explicit params override URL-derived values.","type":"string"},"location":{"description":"Filter by company HQ location. Array of LinkedIn geo IDs. Resolve text to IDs via GET /search/linkedin/parameters with type='GEO'.","type":"array","items":{"type":"string"}},"industry":{"description":"Filter by company industry. Array of LinkedIn industry IDs. Resolve text to IDs via GET /search/linkedin/parameters with type='INDUSTRY'.","type":"array","items":{"type":"string"}},"companySize":{"description":"Filter by employee count. Multiple values accepted (OR logic). Codes: A=1-10 employees, B=11-50, C=51-200, D=201-500, E=501-1,000, F=1,001-5,000, G=5,001-10,000, H=10,001+, I=Self-employed.","type":"array","items":{"type":"string","enum":["A","B","C","D","E","F","G","H","I"]}},"start":{"description":"Pagination offset (default 0). Use multiples of `count` to page through results.","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"description":"Results per page (default 10, max 50).","type":"integer","minimum":1,"maximum":50}}}}}},"responses":{"200":{"description":"List of LinkedIn companies matching the search criteria","content":{"application/json":{"example":{"success":true,"category":"companies","items":[{"type":"COMPANY","name":"AI Startup Inc","profileUrl":"https://www.linkedin.com/company/ai-startup-inc","summary":"Building next-gen AI tools for businesses","industry":"Technology, Information and Internet","location":"San Francisco, CA","followersCount":5200}],"paging":{"start":0,"count":10,"total":350},"hasMore":true,"creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"category":{"type":"string","enum":["companies"]},"items":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["COMPANY"]},"name":{"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"summary":{"nullable":true,"type":"string"},"industry":{"nullable":true,"type":"string"},"location":{"nullable":true,"type":"string"},"followersCount":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","profileUrl","summary","industry","location","followersCount"],"additionalProperties":false}},"paging":{"type":"object","properties":{"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["start","count","total"],"additionalProperties":false},"hasMore":{"type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","category","items","paging","hasMore","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/search/linkedin/jobs":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"],"resultShape":"list"},"operationId":"searchJobs","x-speakeasy-name-override":"jobs","summary":"Search LinkedIn Jobs","description":"# Search LinkedIn Jobs\n\nFind job listings on LinkedIn by keywords, location, job type, experience level, and workplace type.\n\n## Parameters\n- **keywords** (optional): Search terms matched against job title, company name, and description\n\n## Keyword syntax (Boolean operators)\nKeywords support LinkedIn Boolean search syntax:\n- **Exact phrase**: `\"frontend engineer\"` — matches only that exact title\n- **AND**: `React AND TypeScript` — both terms required (spaces default to AND)\n- **OR**: `\"frontend engineer\" OR \"front-end developer\"` — either term\n- **NOT**: `engineer NOT intern` — exclude unwanted terms\n- **Parentheses**: `(React OR Vue) AND \"senior engineer\"` — group logic\n\nOperators must be **UPPERCASE**. Precedence: Quotes > Parentheses > NOT > AND > OR.\n\n## Available filters\nPass human-readable names for `location`, `company`, `industry`, `jobFunction`, `benefits`, `commitments` — they are resolved to LinkedIn IDs server-side. Do not hand-resolve.\n\n| Filter | Type | Description |\n|--------|------|-------------|\n| `location` | string[] | City/region/country names |\n| `company` | string[] | Hiring company names |\n| `industry` | string[] | Company industry names |\n| `jobFunction` | string[] | Job function names (Engineering, Sales, …) |\n| `datePosted` | string | `\"past-24h\"` \\| `\"past-week\"` \\| `\"past-month\"` |\n| `sortBy` | string | `\"relevance\"` \\| `\"date\"` |\n| `jobType` | string[] | Employment type codes (see below) |\n| `experienceLevel` | string[] | Seniority codes (see below) |\n| `workplaceType` | string[] | Work location codes (see below) |\n| `benefits` | string[] | Advertised benefit names |\n| `commitments` | string[] | Employer commitment names |\n| `easyApply` | boolean | Only Easy Apply jobs |\n| `under10Applicants` | boolean | Only jobs with <10 applicants |\n| `inYourNetwork` | boolean | Only jobs where you have a connection |\n| `hasVerifications` | boolean | Only verified job posters |\n| `fairChanceEmployer` | boolean | Only Fair Chance employers |\n\n### Job type codes\n| Code | Type |\n|------|------|\n| `F` | Full-time |\n| `P` | Part-time |\n| `C` | Contract |\n| `T` | Temporary |\n| `I` | Internship |\n| `V` | Volunteer |\n| `O` | Other |\n\n### Experience level codes\n| Code | Level |\n|------|-------|\n| `1` | Internship |\n| `2` | Entry level |\n| `3` | Associate |\n| `4` | Mid-Senior level |\n| `5` | Director |\n| `6` | Executive |\n\n### Workplace type codes\n| Code | Type |\n|------|------|\n| `1` | On-site |\n| `2` | Remote |\n| `3` | Hybrid |\n\n## Response fields (per item)\n| Field | Type | Description |\n|-------|------|-------------|\n| `title` | string | Job title |\n| `company` | string\\|null | Hiring company name |\n| `companyUrl` | string\\|null | Company LinkedIn page URL |\n| `companyLogo` | string\\|null | Company logo URL |\n| `location` | string\\|null | Job location |\n| `workplaceType` | string\\|null | On-site / Remote / Hybrid |\n| `postedAt` | string\\|null | Human-readable posting time (e.g. `\"2 days ago\"`) |\n| `jobUrl` | string | Direct URL to the job listing |\n| `listingId` | string | LinkedIn job listing ID |\n\n## Pagination\n- Default page size: 10, max: 50\n- Use `start` + `count` to paginate. Check `hasMore` for more pages.\n\n## Example workflows\n1. **Job monitoring**: Search by title + location → track new openings in your area\n2. **Competitive hiring analysis**: Search by company keywords → see what roles competitors are hiring for\n3. **Market demand research**: Search by skills → gauge demand for specific expertise\n\n## Credits\n","tags":["search"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"keywords":"frontend engineer","location":["102095887"],"jobType":["F"],"workplaceType":["2"],"experienceLevel":["3","4"],"count":10,"start":0},"schema":{"type":"object","properties":{"keywords":{"description":"Search keywords. Matches against job title, company name, and description. Optional — you can search by filters alone. Supports LinkedIn Boolean syntax: use double quotes for exact phrases (e.g. \"frontend engineer\"), AND to require both terms, OR for alternatives (e.g. React OR Vue OR Angular), NOT to exclude (e.g. engineer NOT intern), and parentheses to group (e.g. (React OR Vue) AND \"senior engineer\"). Operators must be UPPERCASE.","type":"string"},"url":{"description":"Optional LinkedIn search URL. If provided, keywords and filters are extracted from the URL. Explicit params override URL-derived values.","type":"string"},"location":{"description":"Filter by job location. Array of LinkedIn geo IDs. Resolve text to IDs via GET /search/linkedin/parameters with type='GEO'.","type":"array","items":{"type":"string"}},"datePosted":{"description":"Filter by posting date. Useful for finding recently posted jobs.","type":"string","enum":["past-24h","past-week","past-month"]},"sortBy":{"description":"Sort order. 'relevance' (default) or 'date' (most recent first).","type":"string","enum":["relevance","date"]},"jobType":{"description":"Filter by employment type. Multiple values accepted (OR logic). Codes: F=Full-time, P=Part-time, C=Contract, T=Temporary, I=Internship, V=Volunteer, O=Other.","type":"array","items":{"type":"string","enum":["F","P","C","T","I","V","O"]}},"experienceLevel":{"description":"Filter by seniority. Multiple values accepted (OR logic). Codes: 1=Internship, 2=Entry level, 3=Associate, 4=Mid-Senior level, 5=Director, 6=Executive.","type":"array","items":{"type":"string","enum":["1","2","3","4","5","6"]}},"workplaceType":{"description":"Filter by workplace type. Multiple values accepted (OR logic). Codes: 1=On-site, 2=Remote, 3=Hybrid.","type":"array","items":{"type":"string","enum":["1","2","3"]}},"company":{"description":"Filter by hiring company. Pass company NAMES (e.g. ['Stripe','Datadog']) — they are resolved to LinkedIn company IDs server-side. Numeric IDs also accepted.","type":"array","items":{"type":"string"}},"industry":{"description":"Filter by company industry. Pass industry NAMES (e.g. ['Software Development','Financial Services']) — resolved to LinkedIn industry IDs server-side. Numeric IDs also accepted.","type":"array","items":{"type":"string"}},"jobFunction":{"description":"Filter by job function. Pass function names: Information Technology, Engineering, Consulting, Sales, Marketing, Finance, Business Development, Management, Project Management, Quality Assurance, Analyst, Research, Manufacturing, Other.","type":"array","items":{"type":"string"}},"easyApply":{"description":"When true, only return jobs with LinkedIn Easy Apply (apply without leaving LinkedIn).","type":"boolean"},"under10Applicants":{"description":"When true, only return jobs with fewer than 10 applicants — less competition.","type":"boolean"},"inYourNetwork":{"description":"When true, only return jobs at companies where the credential holder has a connection.","type":"boolean"},"hasVerifications":{"description":"When true, only return jobs from verified job posters.","type":"boolean"},"fairChanceEmployer":{"description":"When true, only return jobs from Fair Chance employers.","type":"boolean"},"benefits":{"description":"Filter by advertised benefits. Names: Medical insurance, Vision insurance, Dental insurance, 401(k), Pension plan, Paid maternity leave, Paid paternity leave, Commuter benefits, Student loan assistance, Tuition assistance, Disability insurance.","type":"array","items":{"type":"string"}},"commitments":{"description":"Filter by employer commitments. Names: Diversity equity and inclusion, Environmental sustainability, Work-life balance, Social impact, Career growth and learning.","type":"array","items":{"type":"string"}},"start":{"description":"Pagination offset (default 0). Use multiples of `count` to page through results.","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"description":"Results per page (default 10, max 50).","type":"integer","minimum":1,"maximum":50}}}}}},"responses":{"200":{"description":"List of LinkedIn job listings matching the search criteria","content":{"application/json":{"example":{"success":true,"category":"jobs","items":[{"type":"JOB","title":"Senior Frontend Engineer","company":"TechCo","companyUrl":"https://www.linkedin.com/company/techco","companyLogo":null,"location":"Paris, France","workplaceType":"Remote","postedAt":"2 days ago","jobUrl":"https://www.linkedin.com/jobs/view/1234567890","listingId":"1234567890"}],"paging":{"start":0,"count":10,"total":200},"hasMore":true,"creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"category":{"type":"string","enum":["jobs"]},"items":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["JOB"]},"title":{"type":"string"},"company":{"nullable":true,"type":"string"},"companyUrl":{"nullable":true,"type":"string"},"companyLogo":{"nullable":true,"type":"string"},"location":{"nullable":true,"type":"string"},"workplaceType":{"nullable":true,"type":"string"},"postedAt":{"nullable":true,"type":"string"},"jobUrl":{"type":"string"},"listingId":{"type":"string"}},"required":["type","title","company","companyUrl","companyLogo","location","workplaceType","postedAt","jobUrl","listingId"],"additionalProperties":false}},"paging":{"type":"object","properties":{"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["start","count","total"],"additionalProperties":false},"hasMore":{"type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","category","items","paging","hasMore","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/search/linkedin/url":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"]},"operationId":"searchByUrl","x-speakeasy-name-override":"byUrl","summary":"Search LinkedIn by URL","description":"# Search LinkedIn by URL\n\nPaste any LinkedIn search URL and the endpoint will automatically extract the category, keywords, and all filters from it, then execute the search and return structured results.\n\n## When to use this endpoint\n- A user gives you a LinkedIn search URL and you want to get the results programmatically\n- You want to replicate a search the user performed in their browser\n- You want to automate searches based on bookmarked LinkedIn search URLs\n\n## Supported URL formats\nThe endpoint supports all standard LinkedIn search URLs:\n- `https://www.linkedin.com/search/results/people/?keywords=engineer`\n- `https://www.linkedin.com/search/results/content/?keywords=AI&sortBy=%22date_posted%22`\n- `https://www.linkedin.com/search/results/companies/?keywords=startup&companyHqGeo=%5B%22103644278%22%5D`\n- `https://www.linkedin.com/jobs/search/?keywords=frontend&location=Paris`\n- `https://www.linkedin.com/search/results/all/?keywords=test` (treated as people search)\n\n## URL path → Category mapping\n| URL path segment | Category |\n|------------------|----------|\n| `/results/content/` | posts |\n| `/results/people/` | people |\n| `/results/companies/` | companies |\n| `/results/all/` | people |\n| `/jobs/search/` | jobs |\n\n## Extracted parameters\nThe following URL query parameters are parsed and mapped to search filters:\n- `keywords` → keywords\n- `network` → connectionDegree (people)\n- `geoUrn` / `companyHqGeo` → location\n- `industry` → industry\n- `company` / `currentCompany` → currentCompany\n- `pastCompany` → pastCompany\n- `school` → school\n- `profileLanguage` → profileLanguage\n- `connectionOf` → connectionOf\n- `firstName` / `lastName` → firstName / lastName\n- `title` → title\n- `companySize` → companySize (companies)\n- `sortBy` → sortBy\n- `datePosted` → datePosted\n- `f_TPR` → datePosted (jobs)\n- `f_JT` → jobType (jobs)\n- `f_E` → experienceLevel (jobs)\n- `f_WT` → workplaceType (jobs)\n\n## Pagination override\nYou can optionally pass `start` and `count` to override the pagination embedded in the URL.\n\n## Credits\n","tags":["search"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"url":"https://www.linkedin.com/search/results/people/?keywords=software%20engineer&network=%5B%22S%22%5D&origin=FACETED_SEARCH","count":10},"schema":{"type":"object","properties":{"url":{"type":"string","description":"A LinkedIn search URL. The endpoint automatically extracts the category, keywords, and all filters from the URL. Example: 'https://www.linkedin.com/search/results/people/?keywords=engineer&network=%5B%22S%22%5D'"},"start":{"description":"Override pagination offset. If not provided, uses the page from the URL (or defaults to 0).","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"description":"Override results per page (default 10, max 50).","type":"integer","minimum":1,"maximum":50}},"required":["url"]}}}},"responses":{"200":{"description":"Search results parsed from the LinkedIn URL","content":{"application/json":{"example":{"success":true,"category":"people","items":[{"type":"PEOPLE","name":"Alex Rivera","profileUrl":"https://www.linkedin.com/in/alexrivera","headline":"Software Engineer at Meta","location":"New York, NY","profilePicture":null,"publicIdentifier":"alexrivera","profileUrn":"urn:li:fsd_profile:ACoAABZ0Qo4B6pt58d4FVmts1F7TPi4D1-uL1fw","networkDistance":"DISTANCE_2","currentPositions":[{"company":"Meta","role":"Software Engineer"}]}],"paging":{"start":0,"count":10,"total":500},"hasMore":true,"creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"category":{"type":"string","enum":["posts","people","companies","jobs"]},"items":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["POST"]},"postUrl":{"type":"string","description":"Public URL of the post."},"text":{"type":"string","description":"Post text content."},"date":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Post creation timestamp (Unix milliseconds)."},"likesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total reactions on this post."},"commentsCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total top-level comments on this post."},"sharesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total shares/reposts of this post."},"postUrn":{"type":"string","description":"LinkedIn internal URN for this post. Use with engagement tools (like, comment, collect_likes/comments)."},"postId":{"type":"string","description":"Numeric post identifier parsed from the URN."},"author":{"type":"object","properties":{"name":{"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"profilePicture":{"nullable":true,"type":"string"},"isCompany":{"type":"boolean"},"publicIdentifier":{"nullable":true,"description":"Vanity slug when not URN-based","type":"string"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN when available","type":"string"}},"required":["name","profileUrl","headline","profilePicture","isCompany","publicIdentifier","profileUrn"],"additionalProperties":false},"isRepost":{"type":"boolean"},"media":{"description":"Media attached to the post (image, video, document, or article). Absent when the post is text-only.","type":"object","properties":{"type":{"type":"string","enum":["image","video","document","article"],"description":"Type of media attached to the post."},"urls":{"type":"array","items":{"type":"string"},"description":"Media URLs (image URLs for carousels, video streaming URL, article link, etc.)."},"title":{"description":"Title of the article or document, when available.","type":"string"},"thumbnailUrl":{"description":"Thumbnail URL for videos, articles, or document covers.","type":"string"}},"required":["type","urls"],"additionalProperties":false}},"required":["type","postUrl","text","date","likesCount","commentsCount","sharesCount","postUrn","postId","author","isRepost"],"additionalProperties":false}},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["PEOPLE"]},"name":{"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"location":{"nullable":true,"type":"string"},"profilePicture":{"nullable":true,"type":"string"},"networkDistance":{"nullable":true,"description":"LinkedIn network distance: DISTANCE_1=connected, DISTANCE_2=2nd degree, DISTANCE_3=3rd degree, OUT_OF_NETWORK=not connected.","type":"string","enum":["DISTANCE_1","DISTANCE_2","DISTANCE_3","OUT_OF_NETWORK"]},"currentPositions":{"type":"array","items":{"type":"object","properties":{"company":{"nullable":true,"type":"string"},"role":{"nullable":true,"type":"string"}},"required":["company","role"],"additionalProperties":false},"description":"Current work positions for this profile."},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN (e.g. urn:li:fsd_profile:ACoAAA...) when available","type":"string"},"publicIdentifier":{"nullable":true,"description":"Vanity slug from profile URL (e.g. john-doe) when not URN-based","type":"string"}},"required":["type","name","profileUrl","headline","location","profilePicture","networkDistance","currentPositions","profileUrn","publicIdentifier"],"additionalProperties":false}},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["COMPANY"]},"name":{"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"summary":{"nullable":true,"type":"string"},"industry":{"nullable":true,"type":"string"},"location":{"nullable":true,"type":"string"},"followersCount":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","name","profileUrl","summary","industry","location","followersCount"],"additionalProperties":false}},{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["JOB"]},"title":{"type":"string"},"company":{"nullable":true,"type":"string"},"companyUrl":{"nullable":true,"type":"string"},"companyLogo":{"nullable":true,"type":"string"},"location":{"nullable":true,"type":"string"},"workplaceType":{"nullable":true,"type":"string"},"postedAt":{"nullable":true,"type":"string"},"jobUrl":{"type":"string"},"listingId":{"type":"string"}},"required":["type","title","company","companyUrl","companyLogo","location","workplaceType","postedAt","jobUrl","listingId"],"additionalProperties":false}}]},"paging":{"type":"object","properties":{"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["start","count","total"],"additionalProperties":false},"hasMore":{"type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","category","items","paging","hasMore","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/search/linkedin/parameters":{"get":{"x-bereach":{"cost":"read","agents":["lead_gen"]},"operationId":"resolveParameters","x-speakeasy-name-override":"resolveParameters","summary":"Resolve human text to LinkedIn search parameter IDs","description":"Call this BEFORE any search that takes an ID-valued filter. The agent must NEVER guess LinkedIn IDs.\n\nTwo resolution modes:\n\n**A. Entity typeahead** (live LinkedIn lookup, needs a credential). Resolves user-instance entities (specific company, school, person):\n- `GEO` — locations. Resolve before passing to a `location` / `companyHeadquarters` filter.\n- `COMPANY` — companies/organizations. Resolve before `currentCompany` / `pastCompany` / `authorCompany`.\n- `INDUSTRY` — industries. Resolve before `industry` / `authorIndustry`.\n- `SCHOOL` — schools. Resolve before `school`.\n- `PEOPLE` — any LinkedIn user. Resolve to a profile URN (use with `connectionOf` Sales-Nav filter).\n- `CONNECTIONS` — your own LinkedIn connections by name.\n\n**B. Closed-enum lookup** (static dictionary, no LinkedIn round-trip, works without a Sales Nav seat). Resolves the fixed enum slots. Pass an empty `keywords` to LIST every option of the enum (use this to inspect available values when the user's ICP is ambiguous):\n- `SENIORITY` — Sales-Nav seniority levels (`seniority` field). Values are 3-digit ids (e.g. CXO=310, Owner / Partner=320, Director=220, Senior=120) — the agent CANNOT guess these.\n- `FUNCTION` — LinkedIn job-function (`function` field). 1..26 (e.g. Sales=25, Engineering=8).\n- `COMPANY_HEADCOUNT` — employee-count ranges (`companyHeadcount`). Letter codes A=Self-employed, B=1-10, …, I=10,001+.\n- `COMPANY_TYPE` — public/private/etc (`companyType`).\n- `TENURE` — years-at-current-company / years-in-current-position / years-of-experience ranges (`tenure`, `yearsInCurrentPosition`, `yearsOfExperience`). 1..5.\n- `PROFILE_LANGUAGE` — ISO 639-1 codes (`profileLanguage`).\n- `CONNECTION_DEGREE` — `F`/`S`/`O`/`GROUP` (`connectionDegree`).\n- `FORTUNE` — Fortune list flags (account-search only).\n- `NUM_OF_FOLLOWERS` — follower-count buckets (account-search only).\n\nUsage example (closed-enum):\n```\nGET /search/linkedin/parameters?type=SENIORITY&keywords=CXO\n→ [{ id: '310', title: 'CXO', displayValue: 'CXO', type: 'SENIORITY' }]\nPOST /search/linkedin/sales-nav-people { keywords:'AI', seniority:['310'], function:['25'] }\n→ CXOs in Sales, matching 'AI'.\n```\n\nUsage example (entity):\n```\nGET /search/linkedin/parameters?type=GEO&keywords=Paris\n→ [{ id: '105015875', title: 'Paris, Île-de-France, France', type: 'GEO' }]\nPOST /search/linkedin/people { keywords:'engineer', location:['105015875'] }\n```\n\nIf the closed-enum returns no match for your keywords, the response includes a `hint` listing every canonical option — use that to pick the closest fit. The `aliasResolved` boolean is true when we resolved without hitting LinkedIn (closed-enum or curated alias map).","tags":["search"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"type","schema":{"type":"string","enum":["GEO","COMPANY","INDUSTRY","SCHOOL","CONNECTIONS","PEOPLE","SENIORITY","FUNCTION","COMPANY_HEADCOUNT","COMPANY_TYPE","TENURE","PROFILE_LANGUAGE","CONNECTION_DEGREE","FORTUNE","NUM_OF_FOLLOWERS"],"description":"Parameter type to resolve"},"required":true,"description":"Parameter type to resolve"},{"in":"query","name":"keywords","schema":{"type":"string","description":"Text to resolve into LinkedIn IDs. Omit (empty string) to list every option of a closed-enum type."},"required":true,"description":"Text to resolve into LinkedIn IDs. Omit (empty string) to list every option of a closed-enum type."},{"in":"query","name":"limit","schema":{"description":"Max results (default 10, max 50). Applies to entity-typeahead types only; closed-enum types always return all matches.","type":"integer","minimum":1,"maximum":50},"description":"Max results (default 10, max 50). Applies to entity-typeahead types only; closed-enum types always return all matches."}],"responses":{"200":{"description":"Resolved search parameter items","content":{"application/json":{"example":{"success":true,"items":[{"id":"103644278","title":"San Francisco Bay Area","type":"GEO"},{"id":"102277331","title":"San Francisco, California, United States","type":"GEO"}],"count":2,"creditsUsed":0,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"}},"required":["id","title","type"],"additionalProperties":false}},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","items","count","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/search/linkedin/sales-nav":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"],"resultShape":"list","excludeTool":true},"operationId":"searchSalesNav","x-speakeasy-name-override":"search","summary":"Sales Navigator Search — leads (people) & accounts (companies)","description":"# Sales Navigator Search\n\nSearch LinkedIn Sales Navigator for leads (people) or accounts (companies). Requires a LinkedIn account with an active Sales Navigator subscription.\n\n## Two ways to search\n1. **Structured**: pass `category` + optional `keywords` + filters\n2. **URL-based**: pass a Sales Navigator search `url` from your browser — filters are extracted automatically\n\n### Accepted `url` shapes\nSales Navigator is a SPA and writes its filter state into the **hash fragment** (`#query=...`), not the search string. The parser accepts both, plus several common paste artefacts:\n- `https://www.linkedin.com/sales/search/people#query=(...)&sessionId=...` — what the browser address bar shows (most common)\n- `https://www.linkedin.com/sales/search/people?query=(...)` — older / shared-link form\n- `/sales/search/lead` and `/sales/search/account` path aliases (LinkedIn uses both)\n- Protocol-less paste (`www.linkedin.com/sales/search/people#query=...`)\n- Surrounding whitespace, quotes/backticks, `&amp;` from rich-text paste\n\n**Rejected with a clear 400** so you don't get unfiltered results:\n- Saved-list URLs (`/sales/lists/people/...`) — these aren't searches; open the list and click \"Search\" to get a `/sales/search/...` URL\n- URLs with no query (`?sessionId=...` only) — copy the URL again **after** filters finish loading\n- URLs whose query has no keywords and no filters (`#query=(spellCorrectionEnabled:true)`) — same fix\n\n## Sales Navigator vs Classic search\nSales Navigator returns richer data than classic LinkedIn search:\n- **People**: tenure at company/role, premium status, open profile flag, pending invitation status, detailed positions\n- **Companies**: headcount (employee count)\n- More advanced filters: seniority, function, tenure, include/exclude for company & industry\n\n## Resolving filter IDs\nFilters like location, industry, company, and school require LinkedIn numeric IDs. Use `GET /search/linkedin/parameters` to convert text (e.g. \"San Francisco\") into IDs.\n\n## Pagination\nDefault page size: 25, max: 25. Use `start` (offset) and `count` to paginate. Check `hasMore` and `paging.total` in the response. When passing `url`, a `?page=N` (or `#…&page=N`) in the URL is honored — explicit `start` still wins if both are provided.\n\n## Credits\n\n\n## Profile URLs returned\nEach item carries `profileUrl` (public `/in/...`) and `salesNavUrl` (`/sales/...`).\nSales Navigator does not return canonical vanity slugs (e.g. `/in/john-doe`) — it returns LinkedIn's encrypted profile id, so `profileUrl` is `https://www.linkedin.com/in/<encrypted-id>` (e.g. `/in/ACwAAA0-26UB...`). These URLs are clickable and redirect to the canonical vanity URL when opened in a browser, and they are accepted anywhere our API takes a profile URL (visit, connect, message, etc.).\n\n### Upgrading to canonical vanity URLs (optional)\nTo resolve `/in/<encrypted-id>` → `/in/<vanity-slug>` (e.g. `/in/john-doe`), call `POST /resolve/linkedin/profiles` with the URLs, URNs, or raw encrypted ids. The endpoint returns `publicIdentifier` + a canonical `profileUrl`, and returns `publicIdentifier` + a canonical `profileUrl`.\n\n```json\nPOST /resolve/linkedin/profiles\n{\n  \"inputs\": [\n    \"https://www.linkedin.com/in/ACwAAA0-26UBSvneYv1dZ1sfAT_NZHjmOb5qk2s\",\n    \"urn:li:fsd_profile:ACwAAAaK0QIBxcI7cceYW8eas-3uVGwgOTW8s_k\"\n  ]\n}\n```","tags":["salesNav"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"category":"people","keywords":"developer","tenure":[{"min":3}],"profileLanguage":["en"],"count":25,"start":0},"schema":{"type":"object","properties":{"category":{"description":"Type of Sales Navigator search: 'people' (leads) or 'companies' (accounts). Required unless url is provided.","type":"string","enum":["people","companies"]},"url":{"description":"Sales Navigator search URL — paste directly from your browser. Category and filters are extracted automatically. Explicit params override URL-derived values. Example: https://www.linkedin.com/sales/search/people?query=...","type":"string"},"keywords":{"description":"Search keywords. Supports LinkedIn Boolean syntax: use double quotes for exact phrases, AND/OR/NOT operators (UPPERCASE), and parentheses for grouping.","type":"string"},"title":{"description":"Job title keywords (people only). Supports Boolean OR: 'CEO OR CTO OR Founder'.","type":"string"},"company":{"description":"Current-employer filter (people only). Accepts company names ('Stripe', 'Datadog') OR LinkedIn numeric ids. Server resolves names via typeahead.","type":"object","properties":{"include":{"description":"Labels OR numeric IDs to include. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}},"exclude":{"description":"Labels OR numeric IDs to exclude. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}}}},"industry":{"description":"Industry filter. Accepts industry names ('Software Development', 'Hospitals and Health Care') OR LinkedIn numeric ids. Server resolves.","type":"object","properties":{"include":{"description":"Labels OR numeric IDs to include. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}},"exclude":{"description":"Labels OR numeric IDs to exclude. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}}}},"location":{"description":"Geography filter (people & companies). Accepts location names ('France', 'San Francisco Bay Area', 'EMEA') OR LinkedIn geo ids. Server resolves via typeahead.","type":"array","items":{"type":"string"}},"locationExclude":{"description":"Geography filter to EXCLUDE. Same accepted shapes as `location`. Useful for 'all of Europe except Switzerland' patterns.","type":"array","items":{"type":"string"}},"seniority":{"description":"Seniority levels (people only). Accepts labels ('CXO', 'VP', 'Director', 'Owner / Partner', 'Senior', 'Entry Level', etc.) OR LinkedIn numeric ids. Server resolves labels to LinkedIn's 3-digit ids (CXO=310, etc.) — do NOT guess the ids.","type":"array","items":{"type":"string"}},"function":{"description":"Job function (people only). Accepts function names ('Sales', 'Engineering', 'Marketing', 'Finance', etc. — 26 canonical) OR LinkedIn numeric ids.","type":"array","items":{"type":"string"}},"tenure":{"description":"Years at current company (people only). Array of ranges, e.g. [{min:3}, {max:10}].","type":"array","items":{"type":"object","properties":{"min":{"description":"Minimum years","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"max":{"description":"Maximum years","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}}},"profileLanguage":{"description":"Profile language (people only). Accepts language names ('English', 'French') OR ISO 639-1 codes ('en', 'fr'). Server resolves.","type":"array","items":{"type":"string"}},"connectionDegree":{"description":"Network distance: 'F' (1st-degree), 'S' (2nd-degree), 'O' (3rd-degree and beyond), or 'GROUP'. The labels '1st degree', '2nd degree', '3rd degree' are also accepted.","type":"array","items":{"type":"string"}},"school":{"description":"School filter (people only). Accepts school names ('Stanford', 'HEC Paris') OR LinkedIn numeric ids. Server resolves via typeahead.","type":"array","items":{"type":"string"}},"yearsOfExperience":{"description":"Overall years of experience (people only). Accepts labels ('Less than 1 year', '1 to 2 years', '3 to 5 years', '6 to 10 years', 'More than 10 years') OR LinkedIn numeric ids 1-5.","type":"array","items":{"type":"string"}},"persona":{"description":"Buyer Persona IDs the user has configured on sales.linkedin.com home (combos of function+seniority+title+geo). Match the IDs from the URL filter ((type:PERSONA,values:List((id:<id>,…)))).","type":"array","items":{"type":"string"}},"recentlyChangedJobs":{"description":"Filter to leads who changed jobs in the last 90 days (LinkedIn buying-intent flag). True = include only job-changers; omit/false = no constraint.","type":"boolean"},"postedOnLinkedin":{"description":"Filter to leads who recently posted on LinkedIn (engagement signal — active posters reply more often). True = include only recent posters; omit/false = no constraint.","type":"boolean"},"sharedExperiences":{"description":"Filter to leads with shared experience with the searcher (same school / past employer / group). True = include only shared-experience matches; omit/false = no constraint.","type":"boolean"},"viewedYourProfile":{"description":"Filter to leads who recently viewed YOUR profile (LinkedIn flag VYP). Highest-intent engagement signal — they already showed interest. Requires Sales Nav seat that captures profile views.","type":"boolean"},"followsYourCompany":{"description":"Filter to leads who follow YOUR company page (LinkedIn flag CF). Warm-touch signal — they opted into your brand.","type":"boolean"},"connectionOf":{"description":"Filter to leads connected to a specific person. Values are LinkedIn ENCRYPTED member URN ids (e.g. 'ACwAAAim9ZcB…'), not numeric ids. Useful for 'find people connected to my champion at X' warm-intro patterns.","type":"array","items":{"type":"string"}},"pastCompany":{"description":"Past-employer filter (people only). Accepts company names ('Stripe') OR LinkedIn numeric ids. The server wraps numeric ids as 'urn:li:organization:<id>' (the wire shape Sales Nav requires) — callers can pass the bare id or the URN.","type":"object","properties":{"include":{"description":"Labels OR numeric IDs to include. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}},"exclude":{"description":"Labels OR numeric IDs to exclude. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}}}},"companyHeadquarters":{"description":"Where the lead's CURRENT employer is HQ'd (people only). Accepts location names ('France', 'United States') OR LinkedIn geo ids. Distinct from `location` which is the lead's own location — useful for 'sell to UK-headquartered companies regardless of where the buyer lives'.","type":"object","properties":{"include":{"description":"Labels OR numeric IDs to include. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}},"exclude":{"description":"Labels OR numeric IDs to exclude. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}}}},"yearsInCurrentPosition":{"description":"Years in current ROLE/POSITION (people only). Same accepted labels as `yearsOfExperience` ('Less than 1 year', '1 to 2 years', etc.). Distinct from `tenure` which counts years at current COMPANY.","type":"array","items":{"type":"string"}},"pastTitle":{"description":"Past job title keywords (people only). Free-text, supports Boolean OR. Finds leads who previously held a matching title.","type":"string"},"firstName":{"description":"First name (people only). Exact name filter.","type":"string"},"lastName":{"description":"Last name (people only). Exact name filter.","type":"string"},"groups":{"description":"LinkedIn Groups membership (people only). Accepts group names ('Digital Marketing') OR numeric group ids. Server resolves names via typeahead.","type":"array","items":{"type":"string"}},"pastColleague":{"description":"Filter to leads who are past colleagues of the searcher (worked at the same company, overlapping dates). True = include only past colleagues; omit/false = no constraint. Warm-intro signal.","type":"boolean"},"leadInteractions":{"description":"Filter by your past interaction with the lead (people only). Accepts labels ('Messaged') OR LinkedIn codes.","type":"array","items":{"type":"string"}},"savedLeadsAndAccounts":{"description":"Filter to your saved leads / accounts (people only). Accepts 'All my saved leads' / 'All my saved accounts' OR codes SL/SA.","type":"array","items":{"type":"string"}},"companyHeadcount":{"description":"Employee count (companies only). Accepts labels ('1-10', '11-50', '51-200', '201-500', '501-1,000', '1,001-5,000', '5,001-10,000', '10,001+', 'Self-employed') OR LinkedIn letter codes A-I.","type":"array","items":{"type":"string"}},"companyType":{"description":"Company type (companies only). Accepts labels ('Public Company', 'Privately Held', 'Non Profit', 'Educational Institution', 'Government Agency', 'Self-Employed', 'Self-Owned', 'Partnership') OR LinkedIn letter codes.","type":"array","items":{"type":"string"}},"annualRevenue":{"description":"Annual revenue ranges (companies only).","type":"array","items":{"type":"string"}},"numOfFollowers":{"description":"Company follower-count buckets (companies only). Accepts labels ('1-50', '51-100', '101-1,000', '1,001-5,000', '5,001+') OR ids 1-5.","type":"array","items":{"type":"string"}},"fortune":{"description":"Fortune-list membership (companies only). Accepts 'Fortune 50' / 'Fortune 100' / 'Fortune 250' / 'Fortune 500' OR codes FORTUNE_50/100/250/500.","type":"array","items":{"type":"string"}},"accountActivities":{"description":"Account buying-intent signals (companies only). Accepts labels ('Senior leadership changes in last 3 months', 'Funding events in past 12 months') OR codes SLC/RFE.","type":"array","items":{"type":"string"}},"jobOpportunities":{"description":"Account hiring signals (companies only). Accepts the LinkedIn hiring-signal labels OR codes.","type":"array","items":{"type":"string"}},"companyHeadcountGrowth":{"description":"Company headcount growth range (companies only), e.g. {min: 10} for companies growing 10%+ YoY.","type":"object","properties":{"min":{"description":"Minimum YoY headcount growth %.","type":"number"},"max":{"description":"Maximum YoY headcount growth %.","type":"number"}}},"departmentHeadcount":{"description":"Headcount of a specific department (companies only), e.g. {department:'Sales', min:20}.","type":"object","properties":{"department":{"type":"string","description":"Department name, e.g. 'Sales', 'Engineering'."},"min":{"type":"number"},"max":{"type":"number"}},"required":["department"]},"start":{"description":"Pagination offset (default 0).","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"description":"Results per page (default 25, max 25).","type":"integer","minimum":1,"maximum":25},"campaignSlug":{"description":"Campaign ID. Auto-adds discovered contacts to this campaign in background. Mandatory whenever a campaign is active.","type":"string"}}}}}},"responses":{"200":{"description":"Search results from Sales Navigator","content":{"application/json":{"example":{"success":true,"category":"people","items":[{"type":"PEOPLE","id":"ACwAAASNCJcBS2NERCgi0j_f7_oYqCSbTGsNYBc","name":"Jane Smith","firstName":"Jane","lastName":"Smith","memberUrn":"urn:li:member:76351639","profileUrn":"urn:li:fsd_profile:ACoAAASNCJcBS2NERCgi0j_f7_oYqCSbTGsNYBc","publicIdentifier":"jane-smith","profileUrl":"https://www.linkedin.com/in/jane-smith","salesNavUrl":"https://www.linkedin.com/sales/lead/ACwAAASNCJcBS2NERCgi0j_f7_oYqCSbTGsNYBc,NAME_SEARCH,NqOz","profilePicture":null,"headline":"Senior Software Engineer at Google","location":"San Francisco Bay Area","networkDistance":"DISTANCE_2","premium":true,"openProfile":false,"pendingInvitation":false,"currentPositions":[{"company":"Google","companyId":"1441","role":"Senior Software Engineer","description":null,"location":null,"tenureAtCompany":{"years":3},"tenureAtRole":{"years":2}}]}],"paging":{"start":0,"count":25,"total":1500},"hasMore":true,"creditsUsed":1,"retryAfter":0},"schema":{"anyOf":[{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"category":{"type":"string","enum":["people"]},"items":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["PEOPLE"]},"id":{"type":"string","description":"Sales Navigator lead ID"},"name":{"type":"string"},"firstName":{"nullable":true,"type":"string"},"lastName":{"nullable":true,"type":"string"},"memberUrn":{"nullable":true,"description":"LinkedIn member URN (e.g. urn:li:member:12345)","type":"string"},"profileUrn":{"nullable":true,"description":"Canonical profile URN (urn:li:fsd_profile:ACo...) derived from any ACoA id found in the payload. Null only when LinkedIn returns a bare numeric memberUrn with no ACoA trace.","type":"string"},"publicIdentifier":{"nullable":true,"description":"LinkedIn vanity URL slug","type":"string"},"profileUrl":{"nullable":true,"description":"Profile URL. 3-tier fallback: (1) real /in/<slug>, (2) synthesized /in/<encrypted-id> when only a URN is known — LinkedIn accepts both ACoA… and ACwA… encrypted ids as the slug (case-sensitive), (3) /sales/lead/<id> as last resort when neither is available. Tier 3 URLs are not persistable in Bereach — call POST /resolve/linkedin/profiles to upgrade them.","type":"string"},"salesNavUrl":{"nullable":true,"description":"Sales Navigator lead URL","type":"string"},"profilePicture":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"location":{"nullable":true,"type":"string"},"networkDistance":{"nullable":true,"description":"LinkedIn network distance: DISTANCE_1=connected, DISTANCE_2=2nd degree, DISTANCE_3=3rd degree, OUT_OF_NETWORK=not connected.","type":"string","enum":["DISTANCE_1","DISTANCE_2","DISTANCE_3","OUT_OF_NETWORK"]},"premium":{"nullable":true,"description":"True if the person has a LinkedIn Premium account.","type":"boolean"},"openProfile":{"nullable":true,"description":"True if the person has Open Profile — can be messaged without a connection.","type":"boolean"},"pendingInvitation":{"nullable":true,"description":"True if you have an outstanding connection invitation to this person.","type":"boolean"},"currentPositions":{"type":"array","items":{"type":"object","properties":{"company":{"nullable":true,"type":"string"},"companyId":{"nullable":true,"type":"string"},"role":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"location":{"nullable":true,"type":"string"},"tenureAtCompany":{"nullable":true,"type":"object","properties":{"years":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"months":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"additionalProperties":false},"tenureAtRole":{"nullable":true,"type":"object","properties":{"years":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"months":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"additionalProperties":false}},"required":["company","companyId","role","description","location","tenureAtCompany","tenureAtRole"],"additionalProperties":false},"description":"Current work positions for this profile."}},"required":["type","id","name","firstName","lastName","memberUrn","profileUrn","publicIdentifier","profileUrl","salesNavUrl","profilePicture","headline","location","networkDistance","premium","openProfile","pendingInvitation","currentPositions"],"additionalProperties":false}},"paging":{"type":"object","properties":{"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["start","count","total"],"additionalProperties":false},"hasMore":{"type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","category","items","paging","hasMore","creditsUsed","retryAfter"],"additionalProperties":false},{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"category":{"type":"string","enum":["companies"]},"items":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["COMPANY"]},"id":{"type":"string","description":"Sales Navigator company ID"},"name":{"type":"string"},"profileUrl":{"nullable":true,"description":"Sales Navigator company URL","type":"string"},"summary":{"nullable":true,"type":"string"},"industry":{"nullable":true,"type":"string"},"location":{"nullable":true,"type":"string"},"headcount":{"nullable":true,"description":"Employee count or range","type":"string"}},"required":["type","id","name","profileUrl","summary","industry","location","headcount"],"additionalProperties":false}},"paging":{"type":"object","properties":{"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["start","count","total"],"additionalProperties":false},"hasMore":{"type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","category","items","paging","hasMore","creditsUsed","retryAfter"],"additionalProperties":false}]}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/search/linkedin/sales-nav/people":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"],"resultShape":"list"},"operationId":"searchSalesNavPeople","x-speakeasy-name-override":"people","summary":"Sales Navigator People/Lead Search","description":"# Sales Navigator People Search\n\nSearch for leads in LinkedIn Sales Navigator with advanced filters. Returns enriched profile data including tenure, premium status, and open profile flag.\n\n## Available filters\n| Filter | Type | Description |\n|--------|------|-------------|\n| `keywords` | string | Search terms |\n| `title` | string | Job title keywords |\n| `company` | {include?, exclude?} | Company IDs with include/exclude |\n| `industry` | {include?, exclude?} | Industry IDs with include/exclude |\n| `location` | string[] | Geography IDs |\n| `seniority` | string[] | Seniority levels (1-10) |\n| `function` | string[] | Job function IDs |\n| `tenure` | {min?, max?}[] | Years at current company |\n| `profileLanguage` | string[] | Profile language codes |\n| `connectionDegree` | string[] | Network distance (1, 2, 3) |\n| `school` | string[] | School IDs |\n| `yearsOfExperience` | string[] | Experience ranges |\n\n## Response fields (per item)\n| Field | Type | Description |\n|-------|------|-------------|\n| `id` | string | Sales Navigator lead ID |\n| `name`, `firstName`, `lastName` | string | Name |\n| `memberUrn` | string | LinkedIn member URN |\n| `profileUrn` | string | Canonical profile URN (`urn:li:fsd_profile:ACoA...` or `urn:li:fsd_profile:ACwA...`) — use directly with visit/connect/message endpoints |\n| `profileUrl` | string | Public LinkedIn profile URL `https://www.linkedin.com/in/<encrypted-id>`. Sales Nav does not expose canonical vanity slugs — open in a browser and LinkedIn redirects to `/in/<vanity-name>`. To resolve programmatically, call `POST /resolve/linkedin/profiles`. |\n| `salesNavUrl` | string | Sales Navigator lead URL |\n| `networkDistance` | string | Connection degree |\n| `premium` | boolean | LinkedIn Premium subscriber |\n| `openProfile` | boolean | Accepts free InMail |\n| `pendingInvitation` | boolean | Connection request already sent |\n| `currentPositions` | array | With company, role, tenure details |\n\n## Credits\n\n\n## JSON validity (critical)\nEvery array field (seniority, function, location, companyHeadcount, companyType, annualRevenue, connectionDegree, yearsOfExperience, profileLanguage, school) MUST be a valid JSON array of double-quoted strings, e.g. `[\"Director\",\"Vice President\"]`. Never pipe-separated prose (`Director | Vice President`), never unquoted values (`United States`), never merge multiple options into one element. Malformed JSON means the filter is dropped and the search runs unfiltered.","tags":["salesNav"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"keywords":"developer","tenure":[{"min":5}],"profileLanguage":["en"]},"schema":{"type":"object","properties":{"category":{"description":"Type of Sales Navigator search: 'people' (leads) or 'companies' (accounts). Required unless url is provided.","type":"string","enum":["people","companies"]},"url":{"description":"Sales Navigator search URL — paste directly from your browser. Category and filters are extracted automatically. Explicit params override URL-derived values. Example: https://www.linkedin.com/sales/search/people?query=...","type":"string"},"keywords":{"description":"Search keywords. Supports LinkedIn Boolean syntax: use double quotes for exact phrases, AND/OR/NOT operators (UPPERCASE), and parentheses for grouping.","type":"string"},"title":{"description":"Job title keywords (people only). Supports Boolean OR: 'CEO OR CTO OR Founder'.","type":"string"},"company":{"description":"Current-employer filter (people only). Accepts company names ('Stripe', 'Datadog') OR LinkedIn numeric ids. Server resolves names via typeahead.","type":"object","properties":{"include":{"description":"Labels OR numeric IDs to include. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}},"exclude":{"description":"Labels OR numeric IDs to exclude. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}}}},"industry":{"description":"Industry filter. Accepts industry names ('Software Development', 'Hospitals and Health Care') OR LinkedIn numeric ids. Server resolves.","type":"object","properties":{"include":{"description":"Labels OR numeric IDs to include. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}},"exclude":{"description":"Labels OR numeric IDs to exclude. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}}}},"location":{"description":"Geography filter (people & companies). Accepts location names ('France', 'San Francisco Bay Area', 'EMEA') OR LinkedIn geo ids. Server resolves via typeahead.","type":"array","items":{"type":"string"}},"locationExclude":{"description":"Geography filter to EXCLUDE. Same accepted shapes as `location`. Useful for 'all of Europe except Switzerland' patterns.","type":"array","items":{"type":"string"}},"seniority":{"description":"Seniority levels (people only). Accepts labels ('CXO', 'VP', 'Director', 'Owner / Partner', 'Senior', 'Entry Level', etc.) OR LinkedIn numeric ids. Server resolves labels to LinkedIn's 3-digit ids (CXO=310, etc.) — do NOT guess the ids.","type":"array","items":{"type":"string"}},"function":{"description":"Job function (people only). Accepts function names ('Sales', 'Engineering', 'Marketing', 'Finance', etc. — 26 canonical) OR LinkedIn numeric ids.","type":"array","items":{"type":"string"}},"tenure":{"description":"Years at current company (people only). Array of ranges, e.g. [{min:3}, {max:10}].","type":"array","items":{"type":"object","properties":{"min":{"description":"Minimum years","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"max":{"description":"Maximum years","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}}},"profileLanguage":{"description":"Profile language (people only). Accepts language names ('English', 'French') OR ISO 639-1 codes ('en', 'fr'). Server resolves.","type":"array","items":{"type":"string"}},"connectionDegree":{"description":"Network distance: 'F' (1st-degree), 'S' (2nd-degree), 'O' (3rd-degree and beyond), or 'GROUP'. The labels '1st degree', '2nd degree', '3rd degree' are also accepted.","type":"array","items":{"type":"string"}},"school":{"description":"School filter (people only). Accepts school names ('Stanford', 'HEC Paris') OR LinkedIn numeric ids. Server resolves via typeahead.","type":"array","items":{"type":"string"}},"yearsOfExperience":{"description":"Overall years of experience (people only). Accepts labels ('Less than 1 year', '1 to 2 years', '3 to 5 years', '6 to 10 years', 'More than 10 years') OR LinkedIn numeric ids 1-5.","type":"array","items":{"type":"string"}},"persona":{"description":"Buyer Persona IDs the user has configured on sales.linkedin.com home (combos of function+seniority+title+geo). Match the IDs from the URL filter ((type:PERSONA,values:List((id:<id>,…)))).","type":"array","items":{"type":"string"}},"recentlyChangedJobs":{"description":"Filter to leads who changed jobs in the last 90 days (LinkedIn buying-intent flag). True = include only job-changers; omit/false = no constraint.","type":"boolean"},"postedOnLinkedin":{"description":"Filter to leads who recently posted on LinkedIn (engagement signal — active posters reply more often). True = include only recent posters; omit/false = no constraint.","type":"boolean"},"sharedExperiences":{"description":"Filter to leads with shared experience with the searcher (same school / past employer / group). True = include only shared-experience matches; omit/false = no constraint.","type":"boolean"},"viewedYourProfile":{"description":"Filter to leads who recently viewed YOUR profile (LinkedIn flag VYP). Highest-intent engagement signal — they already showed interest. Requires Sales Nav seat that captures profile views.","type":"boolean"},"followsYourCompany":{"description":"Filter to leads who follow YOUR company page (LinkedIn flag CF). Warm-touch signal — they opted into your brand.","type":"boolean"},"connectionOf":{"description":"Filter to leads connected to a specific person. Values are LinkedIn ENCRYPTED member URN ids (e.g. 'ACwAAAim9ZcB…'), not numeric ids. Useful for 'find people connected to my champion at X' warm-intro patterns.","type":"array","items":{"type":"string"}},"pastCompany":{"description":"Past-employer filter (people only). Accepts company names ('Stripe') OR LinkedIn numeric ids. The server wraps numeric ids as 'urn:li:organization:<id>' (the wire shape Sales Nav requires) — callers can pass the bare id or the URN.","type":"object","properties":{"include":{"description":"Labels OR numeric IDs to include. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}},"exclude":{"description":"Labels OR numeric IDs to exclude. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}}}},"companyHeadquarters":{"description":"Where the lead's CURRENT employer is HQ'd (people only). Accepts location names ('France', 'United States') OR LinkedIn geo ids. Distinct from `location` which is the lead's own location — useful for 'sell to UK-headquartered companies regardless of where the buyer lives'.","type":"object","properties":{"include":{"description":"Labels OR numeric IDs to include. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}},"exclude":{"description":"Labels OR numeric IDs to exclude. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}}}},"yearsInCurrentPosition":{"description":"Years in current ROLE/POSITION (people only). Same accepted labels as `yearsOfExperience` ('Less than 1 year', '1 to 2 years', etc.). Distinct from `tenure` which counts years at current COMPANY.","type":"array","items":{"type":"string"}},"pastTitle":{"description":"Past job title keywords (people only). Free-text, supports Boolean OR. Finds leads who previously held a matching title.","type":"string"},"firstName":{"description":"First name (people only). Exact name filter.","type":"string"},"lastName":{"description":"Last name (people only). Exact name filter.","type":"string"},"groups":{"description":"LinkedIn Groups membership (people only). Accepts group names ('Digital Marketing') OR numeric group ids. Server resolves names via typeahead.","type":"array","items":{"type":"string"}},"pastColleague":{"description":"Filter to leads who are past colleagues of the searcher (worked at the same company, overlapping dates). True = include only past colleagues; omit/false = no constraint. Warm-intro signal.","type":"boolean"},"leadInteractions":{"description":"Filter by your past interaction with the lead (people only). Accepts labels ('Messaged') OR LinkedIn codes.","type":"array","items":{"type":"string"}},"savedLeadsAndAccounts":{"description":"Filter to your saved leads / accounts (people only). Accepts 'All my saved leads' / 'All my saved accounts' OR codes SL/SA.","type":"array","items":{"type":"string"}},"numOfFollowers":{"description":"Company follower-count buckets (companies only). Accepts labels ('1-50', '51-100', '101-1,000', '1,001-5,000', '5,001+') OR ids 1-5.","type":"array","items":{"type":"string"}},"fortune":{"description":"Fortune-list membership (companies only). Accepts 'Fortune 50' / 'Fortune 100' / 'Fortune 250' / 'Fortune 500' OR codes FORTUNE_50/100/250/500.","type":"array","items":{"type":"string"}},"accountActivities":{"description":"Account buying-intent signals (companies only). Accepts labels ('Senior leadership changes in last 3 months', 'Funding events in past 12 months') OR codes SLC/RFE.","type":"array","items":{"type":"string"}},"jobOpportunities":{"description":"Account hiring signals (companies only). Accepts the LinkedIn hiring-signal labels OR codes.","type":"array","items":{"type":"string"}},"companyHeadcountGrowth":{"description":"Company headcount growth range (companies only), e.g. {min: 10} for companies growing 10%+ YoY.","type":"object","properties":{"min":{"description":"Minimum YoY headcount growth %.","type":"number"},"max":{"description":"Maximum YoY headcount growth %.","type":"number"}}},"departmentHeadcount":{"description":"Headcount of a specific department (companies only), e.g. {department:'Sales', min:20}.","type":"object","properties":{"department":{"type":"string","description":"Department name, e.g. 'Sales', 'Engineering'."},"min":{"type":"number"},"max":{"type":"number"}},"required":["department"]},"start":{"description":"Pagination offset (default 0).","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"description":"Results per page (default 25, max 25).","type":"integer","minimum":1,"maximum":25},"campaignSlug":{"description":"Campaign ID. Auto-adds discovered contacts to this campaign in background. Mandatory whenever a campaign is active.","type":"string"}}}}}},"responses":{"200":{"description":"Sales Navigator people search results","content":{"application/json":{"example":{"success":true,"category":"people","items":[{"type":"PEOPLE","id":"ACwAAASNCJcBS2NERCgi0j_f7_oYqCSbTGsNYBc","name":"Jane Smith","firstName":"Jane","lastName":"Smith","memberUrn":"urn:li:member:76351639","profileUrn":"urn:li:fsd_profile:ACoAAASNCJcBS2NERCgi0j_f7_oYqCSbTGsNYBc","publicIdentifier":"jane-smith","profileUrl":"https://www.linkedin.com/in/jane-smith","salesNavUrl":"https://www.linkedin.com/sales/lead/ACwAAASNCJcBS2NERCgi0j_f7_oYqCSbTGsNYBc,NAME_SEARCH,NqOz","profilePicture":null,"headline":"Senior Software Engineer at Google","location":"San Francisco Bay Area","networkDistance":"DISTANCE_2","premium":true,"openProfile":false,"pendingInvitation":false,"currentPositions":[{"company":"Google","companyId":"1441","role":"Senior Software Engineer","description":null,"location":null,"tenureAtCompany":{"years":3},"tenureAtRole":{"years":2}}]}],"paging":{"start":0,"count":25,"total":1500},"hasMore":true,"creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"category":{"type":"string","enum":["people"]},"items":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["PEOPLE"]},"id":{"type":"string","description":"Sales Navigator lead ID"},"name":{"type":"string"},"firstName":{"nullable":true,"type":"string"},"lastName":{"nullable":true,"type":"string"},"memberUrn":{"nullable":true,"description":"LinkedIn member URN (e.g. urn:li:member:12345)","type":"string"},"profileUrn":{"nullable":true,"description":"Canonical profile URN (urn:li:fsd_profile:ACo...) derived from any ACoA id found in the payload. Null only when LinkedIn returns a bare numeric memberUrn with no ACoA trace.","type":"string"},"publicIdentifier":{"nullable":true,"description":"LinkedIn vanity URL slug","type":"string"},"profileUrl":{"nullable":true,"description":"Profile URL. 3-tier fallback: (1) real /in/<slug>, (2) synthesized /in/<encrypted-id> when only a URN is known — LinkedIn accepts both ACoA… and ACwA… encrypted ids as the slug (case-sensitive), (3) /sales/lead/<id> as last resort when neither is available. Tier 3 URLs are not persistable in Bereach — call POST /resolve/linkedin/profiles to upgrade them.","type":"string"},"salesNavUrl":{"nullable":true,"description":"Sales Navigator lead URL","type":"string"},"profilePicture":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"location":{"nullable":true,"type":"string"},"networkDistance":{"nullable":true,"description":"LinkedIn network distance: DISTANCE_1=connected, DISTANCE_2=2nd degree, DISTANCE_3=3rd degree, OUT_OF_NETWORK=not connected.","type":"string","enum":["DISTANCE_1","DISTANCE_2","DISTANCE_3","OUT_OF_NETWORK"]},"premium":{"nullable":true,"description":"True if the person has a LinkedIn Premium account.","type":"boolean"},"openProfile":{"nullable":true,"description":"True if the person has Open Profile — can be messaged without a connection.","type":"boolean"},"pendingInvitation":{"nullable":true,"description":"True if you have an outstanding connection invitation to this person.","type":"boolean"},"currentPositions":{"type":"array","items":{"type":"object","properties":{"company":{"nullable":true,"type":"string"},"companyId":{"nullable":true,"type":"string"},"role":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"location":{"nullable":true,"type":"string"},"tenureAtCompany":{"nullable":true,"type":"object","properties":{"years":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"months":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"additionalProperties":false},"tenureAtRole":{"nullable":true,"type":"object","properties":{"years":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"months":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"additionalProperties":false}},"required":["company","companyId","role","description","location","tenureAtCompany","tenureAtRole"],"additionalProperties":false},"description":"Current work positions for this profile."}},"required":["type","id","name","firstName","lastName","memberUrn","profileUrn","publicIdentifier","profileUrl","salesNavUrl","profilePicture","headline","location","networkDistance","premium","openProfile","pendingInvitation","currentPositions"],"additionalProperties":false}},"paging":{"type":"object","properties":{"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["start","count","total"],"additionalProperties":false},"hasMore":{"type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","category","items","paging","hasMore","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/search/linkedin/sales-nav/companies":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"],"resultShape":"list"},"operationId":"searchSalesNavCompanies","x-speakeasy-name-override":"companies","summary":"Sales Navigator Company/Account Search","description":"# Sales Navigator Company Search\n\nSearch for accounts in LinkedIn Sales Navigator.\n\n## Available filters\n| Filter | Type | Description |\n|--------|------|-------------|\n| `keywords` | string | Search terms |\n| `industry` | {include?, exclude?} | Industry IDs with include/exclude |\n| `location` | string[] | Geography IDs |\n| `companyHeadcount` | string[] | Employee count ranges |\n| `companyType` | string[] | Company types |\n| `annualRevenue` | string[] | Revenue ranges |\n\n## Credits\n","tags":["salesNav"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"category":"companies","keywords":"SaaS","companyHeadcount":["C","D"]},"schema":{"type":"object","properties":{"category":{"description":"Type of Sales Navigator search: 'people' (leads) or 'companies' (accounts). Required unless url is provided.","type":"string","enum":["people","companies"]},"url":{"description":"Sales Navigator search URL — paste directly from your browser. Category and filters are extracted automatically. Explicit params override URL-derived values. Example: https://www.linkedin.com/sales/search/people?query=...","type":"string"},"keywords":{"description":"Search keywords. Supports LinkedIn Boolean syntax: use double quotes for exact phrases, AND/OR/NOT operators (UPPERCASE), and parentheses for grouping.","type":"string"},"industry":{"description":"Industry filter. Accepts industry names ('Software Development', 'Hospitals and Health Care') OR LinkedIn numeric ids. Server resolves.","type":"object","properties":{"include":{"description":"Labels OR numeric IDs to include. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}},"exclude":{"description":"Labels OR numeric IDs to exclude. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}}}},"location":{"description":"Geography filter (people & companies). Accepts location names ('France', 'San Francisco Bay Area', 'EMEA') OR LinkedIn geo ids. Server resolves via typeahead.","type":"array","items":{"type":"string"}},"locationExclude":{"description":"Geography filter to EXCLUDE. Same accepted shapes as `location`. Useful for 'all of Europe except Switzerland' patterns.","type":"array","items":{"type":"string"}},"persona":{"description":"Buyer Persona IDs the user has configured on sales.linkedin.com home (combos of function+seniority+title+geo). Match the IDs from the URL filter ((type:PERSONA,values:List((id:<id>,…)))).","type":"array","items":{"type":"string"}},"recentlyChangedJobs":{"description":"Filter to leads who changed jobs in the last 90 days (LinkedIn buying-intent flag). True = include only job-changers; omit/false = no constraint.","type":"boolean"},"postedOnLinkedin":{"description":"Filter to leads who recently posted on LinkedIn (engagement signal — active posters reply more often). True = include only recent posters; omit/false = no constraint.","type":"boolean"},"sharedExperiences":{"description":"Filter to leads with shared experience with the searcher (same school / past employer / group). True = include only shared-experience matches; omit/false = no constraint.","type":"boolean"},"viewedYourProfile":{"description":"Filter to leads who recently viewed YOUR profile (LinkedIn flag VYP). Highest-intent engagement signal — they already showed interest. Requires Sales Nav seat that captures profile views.","type":"boolean"},"followsYourCompany":{"description":"Filter to leads who follow YOUR company page (LinkedIn flag CF). Warm-touch signal — they opted into your brand.","type":"boolean"},"connectionOf":{"description":"Filter to leads connected to a specific person. Values are LinkedIn ENCRYPTED member URN ids (e.g. 'ACwAAAim9ZcB…'), not numeric ids. Useful for 'find people connected to my champion at X' warm-intro patterns.","type":"array","items":{"type":"string"}},"pastCompany":{"description":"Past-employer filter (people only). Accepts company names ('Stripe') OR LinkedIn numeric ids. The server wraps numeric ids as 'urn:li:organization:<id>' (the wire shape Sales Nav requires) — callers can pass the bare id or the URN.","type":"object","properties":{"include":{"description":"Labels OR numeric IDs to include. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}},"exclude":{"description":"Labels OR numeric IDs to exclude. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}}}},"companyHeadquarters":{"description":"Where the lead's CURRENT employer is HQ'd (people only). Accepts location names ('France', 'United States') OR LinkedIn geo ids. Distinct from `location` which is the lead's own location — useful for 'sell to UK-headquartered companies regardless of where the buyer lives'.","type":"object","properties":{"include":{"description":"Labels OR numeric IDs to include. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}},"exclude":{"description":"Labels OR numeric IDs to exclude. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}}}},"yearsInCurrentPosition":{"description":"Years in current ROLE/POSITION (people only). Same accepted labels as `yearsOfExperience` ('Less than 1 year', '1 to 2 years', etc.). Distinct from `tenure` which counts years at current COMPANY.","type":"array","items":{"type":"string"}},"pastTitle":{"description":"Past job title keywords (people only). Free-text, supports Boolean OR. Finds leads who previously held a matching title.","type":"string"},"firstName":{"description":"First name (people only). Exact name filter.","type":"string"},"lastName":{"description":"Last name (people only). Exact name filter.","type":"string"},"groups":{"description":"LinkedIn Groups membership (people only). Accepts group names ('Digital Marketing') OR numeric group ids. Server resolves names via typeahead.","type":"array","items":{"type":"string"}},"pastColleague":{"description":"Filter to leads who are past colleagues of the searcher (worked at the same company, overlapping dates). True = include only past colleagues; omit/false = no constraint. Warm-intro signal.","type":"boolean"},"leadInteractions":{"description":"Filter by your past interaction with the lead (people only). Accepts labels ('Messaged') OR LinkedIn codes.","type":"array","items":{"type":"string"}},"savedLeadsAndAccounts":{"description":"Filter to your saved leads / accounts (people only). Accepts 'All my saved leads' / 'All my saved accounts' OR codes SL/SA.","type":"array","items":{"type":"string"}},"companyHeadcount":{"description":"Employee count (companies only). Accepts labels ('1-10', '11-50', '51-200', '201-500', '501-1,000', '1,001-5,000', '5,001-10,000', '10,001+', 'Self-employed') OR LinkedIn letter codes A-I.","type":"array","items":{"type":"string"}},"companyType":{"description":"Company type (companies only). Accepts labels ('Public Company', 'Privately Held', 'Non Profit', 'Educational Institution', 'Government Agency', 'Self-Employed', 'Self-Owned', 'Partnership') OR LinkedIn letter codes.","type":"array","items":{"type":"string"}},"annualRevenue":{"description":"Annual revenue ranges (companies only).","type":"array","items":{"type":"string"}},"numOfFollowers":{"description":"Company follower-count buckets (companies only). Accepts labels ('1-50', '51-100', '101-1,000', '1,001-5,000', '5,001+') OR ids 1-5.","type":"array","items":{"type":"string"}},"fortune":{"description":"Fortune-list membership (companies only). Accepts 'Fortune 50' / 'Fortune 100' / 'Fortune 250' / 'Fortune 500' OR codes FORTUNE_50/100/250/500.","type":"array","items":{"type":"string"}},"accountActivities":{"description":"Account buying-intent signals (companies only). Accepts labels ('Senior leadership changes in last 3 months', 'Funding events in past 12 months') OR codes SLC/RFE.","type":"array","items":{"type":"string"}},"jobOpportunities":{"description":"Account hiring signals (companies only). Accepts the LinkedIn hiring-signal labels OR codes.","type":"array","items":{"type":"string"}},"companyHeadcountGrowth":{"description":"Company headcount growth range (companies only), e.g. {min: 10} for companies growing 10%+ YoY.","type":"object","properties":{"min":{"description":"Minimum YoY headcount growth %.","type":"number"},"max":{"description":"Maximum YoY headcount growth %.","type":"number"}}},"departmentHeadcount":{"description":"Headcount of a specific department (companies only), e.g. {department:'Sales', min:20}.","type":"object","properties":{"department":{"type":"string","description":"Department name, e.g. 'Sales', 'Engineering'."},"min":{"type":"number"},"max":{"type":"number"}},"required":["department"]},"start":{"description":"Pagination offset (default 0).","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"description":"Results per page (default 25, max 25).","type":"integer","minimum":1,"maximum":25},"campaignSlug":{"description":"Campaign ID. Auto-adds discovered contacts to this campaign in background. Mandatory whenever a campaign is active.","type":"string"}}}}}},"responses":{"200":{"description":"Sales Navigator company search results","content":{"application/json":{"example":{"success":true,"category":"companies","items":[{"type":"COMPANY","id":"1441","name":"Google","profileUrl":"https://www.linkedin.com/sales/company/1441","summary":"Organizing the world's information","industry":"Software Development","location":"Mountain View, CA","headcount":"10001+"}],"paging":{"start":0,"count":25,"total":200},"hasMore":true,"creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"category":{"type":"string","enum":["companies"]},"items":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["COMPANY"]},"id":{"type":"string","description":"Sales Navigator company ID"},"name":{"type":"string"},"profileUrl":{"nullable":true,"description":"Sales Navigator company URL","type":"string"},"summary":{"nullable":true,"type":"string"},"industry":{"nullable":true,"type":"string"},"location":{"nullable":true,"type":"string"},"headcount":{"nullable":true,"description":"Employee count or range","type":"string"}},"required":["type","id","name","profileUrl","summary","industry","location","headcount"],"additionalProperties":false}},"paging":{"type":"object","properties":{"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["start","count","total"],"additionalProperties":false},"hasMore":{"type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","category","items","paging","hasMore","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/search/linkedin/sales-nav/filters":{"get":{"x-bereach":{"cost":"free","agents":["lead_gen"],"resultShape":"list"},"operationId":"listSalesNavFilters","x-speakeasy-name-override":"listSalesNavFilters","summary":"List the Sales Navigator filters available for this seat","description":"Returns the Sales Navigator filter panel — every filter you can use, grouped, with how to supply each value.\n\nCall this ONCE at the start of a Sales Nav search task — like a human opening the filter panel. It tells you:\n- which filters exist (seat tiers differ — Core / Advanced / Advanced Plus expose different filters);\n- the BeReach `field` name to set on the search for each;\n- the `valueKind` (enum / entity / toggle / range / text) so you know how to supply the value;\n- `supportsExclude` and `available` (false = the seat tier does not have this filter — don't promise it to the user).\n\nRequires an active Sales Nav seat.","tags":["search"],"security":[{"token":[]}],"responses":{"200":{"description":"Available Sales Nav filters for this seat.","content":{"application/json":{"example":{"success":true,"filters":[{"name":"Seniority level","field":"seniority","group":"Role","valueKind":"enum","supportsExclude":true,"available":true},{"name":"Current company","field":"company","group":"Company","valueKind":"entity","supportsExclude":true,"available":true}],"count":2,"creditsUsed":0,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"filters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"User-facing filter name, e.g. 'Seniority level'."},"field":{"type":"string","description":"The BeReach schema field name to set on a search, e.g. 'seniority'."},"group":{"type":"string","description":"UI group: Company / Role / Personal / Buyer intent / Best path in / Workflow."},"valueKind":{"type":"string","enum":["enum","entity","toggle","range","text"],"description":"How to supply a value: 'enum' = pick a label; 'entity' = pass a name (company/school/etc); 'toggle' = boolean; 'range' = {min,max}; 'text' = free string."},"supportsExclude":{"type":"boolean","description":"Whether the filter accepts an exclude list."},"available":{"type":"boolean","description":"Whether THIS credential's Sales Nav seat tier exposes the filter."}},"required":["name","field","group","valueKind","supportsExclude","available"],"additionalProperties":false}},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","filters","count","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/search/linkedin/sales-nav/resolve-filter":{"get":{"x-bereach":{"cost":"read","agents":["lead_gen"]},"operationId":"resolveSalesNavFilter","x-speakeasy-name-override":"resolveSalesNavFilter","summary":"Resolve a Sales Navigator filter value (label → id)","description":"Call this when you need to LIST or EXPLORE the canonical options of a Sales Navigator filter (e.g. \"what seniority levels does LinkedIn support?\").\n\n**NOTE:** for normal search calls, you do NOT need to call this first. `search_sales_nav_people` / `search_sales_nav_companies` (and `preview_sales_nav_count`) automatically coerce human labels you pass in the filter fields (`seniority: [\"VP\",\"Director\"]`, `function: [\"Sales\"]`, `location: [\"France\"]`, `company: { include: [\"Stripe\"] }`) to LinkedIn ids server-side. Only call `resolve_sales_nav_filter` when:\n- The user's ICP is ambiguous (\"VP-ish people\") and you want to enumerate options before picking;\n- Your last search returned 0 results and you suspect a label couldn't be resolved — call with the same label to see the closest matches;\n- You want to pre-validate a label without issuing a search.\n\nSupported types (same as the generic `resolveParameters`, listed here for discoverability of the Sales Nav context):\n- Closed-enum (no LinkedIn round-trip, works without a seat): SENIORITY, FUNCTION, COMPANY_HEADCOUNT, COMPANY_TYPE, TENURE, PROFILE_LANGUAGE, CONNECTION_DEGREE, FORTUNE, NUM_OF_FOLLOWERS.\n- Entity (live LinkedIn typeahead, requires a credential): COMPANY, GEO, INDUSTRY, SCHOOL, PEOPLE, CONNECTIONS.\n\nPass an empty `keywords` to LIST every option of a closed-enum type.","tags":["search"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"type","schema":{"type":"string","enum":["GEO","COMPANY","INDUSTRY","SCHOOL","CONNECTIONS","PEOPLE","SENIORITY","FUNCTION","COMPANY_HEADCOUNT","COMPANY_TYPE","TENURE","PROFILE_LANGUAGE","CONNECTION_DEGREE","FORTUNE","NUM_OF_FOLLOWERS"],"description":"Parameter type to resolve"},"required":true,"description":"Parameter type to resolve"},{"in":"query","name":"keywords","schema":{"type":"string","description":"Text to resolve into LinkedIn IDs. Omit (empty string) to list every option of a closed-enum type."},"required":true,"description":"Text to resolve into LinkedIn IDs. Omit (empty string) to list every option of a closed-enum type."},{"in":"query","name":"limit","schema":{"description":"Max results (default 10, max 50). Applies to entity-typeahead types only; closed-enum types always return all matches.","type":"integer","minimum":1,"maximum":50},"description":"Max results (default 10, max 50). Applies to entity-typeahead types only; closed-enum types always return all matches."}],"responses":{"200":{"description":"Resolved Sales Nav filter values","content":{"application/json":{"example":{"success":true,"items":[{"id":"103644278","title":"San Francisco Bay Area","type":"GEO"},{"id":"102277331","title":"San Francisco, California, United States","type":"GEO"}],"count":2,"creditsUsed":0,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"}},"required":["id","title","type"],"additionalProperties":false}},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","items","count","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/search/linkedin/sales-nav/preview-count":{"post":{"x-bereach":{"cost":"free","agents":["lead_gen"],"resultShape":"list"},"operationId":"previewSalesNavCount","x-speakeasy-name-override":"previewSalesNavCount","summary":"Peek Sales Navigator result count without fetching profiles","description":"Returns ONLY the count of matching leads/companies for a Sales Navigator filter set — no profile data, no credit charged.\n\nUse this BEFORE `search_sales_nav_people` / `search_sales_nav_companies` to decide whether to broaden or narrow filters:\n- 0 results → labels may not resolve (check `warnings`), or filters are too restrictive — broaden one filter at a time.\n- 10–500 results → reasonable cohort — proceed to the full search.\n- Thousands → narrow with more filters (seniority, geography, industry) before committing.\n\nAccepts the SAME filter shape as the full search (labels OR ids — same auto-coercion). Use the same `category` ('people' or 'companies') you'd use in the search. URL-paste also works.","tags":["search"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Type of Sales Navigator search: 'people' (leads) or 'companies' (accounts). Required unless url is provided.","type":"string","enum":["people","companies"]},"url":{"description":"Sales Navigator search URL — paste directly from your browser. Category and filters are extracted automatically. Explicit params override URL-derived values. Example: https://www.linkedin.com/sales/search/people?query=...","type":"string"},"keywords":{"description":"Search keywords. Supports LinkedIn Boolean syntax: use double quotes for exact phrases, AND/OR/NOT operators (UPPERCASE), and parentheses for grouping.","type":"string"},"title":{"description":"Job title keywords (people only). Supports Boolean OR: 'CEO OR CTO OR Founder'.","type":"string"},"company":{"description":"Current-employer filter (people only). Accepts company names ('Stripe', 'Datadog') OR LinkedIn numeric ids. Server resolves names via typeahead.","type":"object","properties":{"include":{"description":"Labels OR numeric IDs to include. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}},"exclude":{"description":"Labels OR numeric IDs to exclude. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}}}},"industry":{"description":"Industry filter. Accepts industry names ('Software Development', 'Hospitals and Health Care') OR LinkedIn numeric ids. Server resolves.","type":"object","properties":{"include":{"description":"Labels OR numeric IDs to include. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}},"exclude":{"description":"Labels OR numeric IDs to exclude. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}}}},"location":{"description":"Geography filter (people & companies). Accepts location names ('France', 'San Francisco Bay Area', 'EMEA') OR LinkedIn geo ids. Server resolves via typeahead.","type":"array","items":{"type":"string"}},"locationExclude":{"description":"Geography filter to EXCLUDE. Same accepted shapes as `location`. Useful for 'all of Europe except Switzerland' patterns.","type":"array","items":{"type":"string"}},"seniority":{"description":"Seniority levels (people only). Accepts labels ('CXO', 'VP', 'Director', 'Owner / Partner', 'Senior', 'Entry Level', etc.) OR LinkedIn numeric ids. Server resolves labels to LinkedIn's 3-digit ids (CXO=310, etc.) — do NOT guess the ids.","type":"array","items":{"type":"string"}},"function":{"description":"Job function (people only). Accepts function names ('Sales', 'Engineering', 'Marketing', 'Finance', etc. — 26 canonical) OR LinkedIn numeric ids.","type":"array","items":{"type":"string"}},"tenure":{"description":"Years at current company (people only). Array of ranges, e.g. [{min:3}, {max:10}].","type":"array","items":{"type":"object","properties":{"min":{"description":"Minimum years","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"max":{"description":"Maximum years","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}}},"profileLanguage":{"description":"Profile language (people only). Accepts language names ('English', 'French') OR ISO 639-1 codes ('en', 'fr'). Server resolves.","type":"array","items":{"type":"string"}},"connectionDegree":{"description":"Network distance: 'F' (1st-degree), 'S' (2nd-degree), 'O' (3rd-degree and beyond), or 'GROUP'. The labels '1st degree', '2nd degree', '3rd degree' are also accepted.","type":"array","items":{"type":"string"}},"school":{"description":"School filter (people only). Accepts school names ('Stanford', 'HEC Paris') OR LinkedIn numeric ids. Server resolves via typeahead.","type":"array","items":{"type":"string"}},"yearsOfExperience":{"description":"Overall years of experience (people only). Accepts labels ('Less than 1 year', '1 to 2 years', '3 to 5 years', '6 to 10 years', 'More than 10 years') OR LinkedIn numeric ids 1-5.","type":"array","items":{"type":"string"}},"persona":{"description":"Buyer Persona IDs the user has configured on sales.linkedin.com home (combos of function+seniority+title+geo). Match the IDs from the URL filter ((type:PERSONA,values:List((id:<id>,…)))).","type":"array","items":{"type":"string"}},"recentlyChangedJobs":{"description":"Filter to leads who changed jobs in the last 90 days (LinkedIn buying-intent flag). True = include only job-changers; omit/false = no constraint.","type":"boolean"},"postedOnLinkedin":{"description":"Filter to leads who recently posted on LinkedIn (engagement signal — active posters reply more often). True = include only recent posters; omit/false = no constraint.","type":"boolean"},"sharedExperiences":{"description":"Filter to leads with shared experience with the searcher (same school / past employer / group). True = include only shared-experience matches; omit/false = no constraint.","type":"boolean"},"viewedYourProfile":{"description":"Filter to leads who recently viewed YOUR profile (LinkedIn flag VYP). Highest-intent engagement signal — they already showed interest. Requires Sales Nav seat that captures profile views.","type":"boolean"},"followsYourCompany":{"description":"Filter to leads who follow YOUR company page (LinkedIn flag CF). Warm-touch signal — they opted into your brand.","type":"boolean"},"connectionOf":{"description":"Filter to leads connected to a specific person. Values are LinkedIn ENCRYPTED member URN ids (e.g. 'ACwAAAim9ZcB…'), not numeric ids. Useful for 'find people connected to my champion at X' warm-intro patterns.","type":"array","items":{"type":"string"}},"pastCompany":{"description":"Past-employer filter (people only). Accepts company names ('Stripe') OR LinkedIn numeric ids. The server wraps numeric ids as 'urn:li:organization:<id>' (the wire shape Sales Nav requires) — callers can pass the bare id or the URN.","type":"object","properties":{"include":{"description":"Labels OR numeric IDs to include. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}},"exclude":{"description":"Labels OR numeric IDs to exclude. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}}}},"companyHeadquarters":{"description":"Where the lead's CURRENT employer is HQ'd (people only). Accepts location names ('France', 'United States') OR LinkedIn geo ids. Distinct from `location` which is the lead's own location — useful for 'sell to UK-headquartered companies regardless of where the buyer lives'.","type":"object","properties":{"include":{"description":"Labels OR numeric IDs to include. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}},"exclude":{"description":"Labels OR numeric IDs to exclude. Labels are resolved server-side (no need to call /parameters first).","type":"array","items":{"type":"string"}}}},"yearsInCurrentPosition":{"description":"Years in current ROLE/POSITION (people only). Same accepted labels as `yearsOfExperience` ('Less than 1 year', '1 to 2 years', etc.). Distinct from `tenure` which counts years at current COMPANY.","type":"array","items":{"type":"string"}},"pastTitle":{"description":"Past job title keywords (people only). Free-text, supports Boolean OR. Finds leads who previously held a matching title.","type":"string"},"firstName":{"description":"First name (people only). Exact name filter.","type":"string"},"lastName":{"description":"Last name (people only). Exact name filter.","type":"string"},"groups":{"description":"LinkedIn Groups membership (people only). Accepts group names ('Digital Marketing') OR numeric group ids. Server resolves names via typeahead.","type":"array","items":{"type":"string"}},"pastColleague":{"description":"Filter to leads who are past colleagues of the searcher (worked at the same company, overlapping dates). True = include only past colleagues; omit/false = no constraint. Warm-intro signal.","type":"boolean"},"leadInteractions":{"description":"Filter by your past interaction with the lead (people only). Accepts labels ('Messaged') OR LinkedIn codes.","type":"array","items":{"type":"string"}},"savedLeadsAndAccounts":{"description":"Filter to your saved leads / accounts (people only). Accepts 'All my saved leads' / 'All my saved accounts' OR codes SL/SA.","type":"array","items":{"type":"string"}},"companyHeadcount":{"description":"Employee count (companies only). Accepts labels ('1-10', '11-50', '51-200', '201-500', '501-1,000', '1,001-5,000', '5,001-10,000', '10,001+', 'Self-employed') OR LinkedIn letter codes A-I.","type":"array","items":{"type":"string"}},"companyType":{"description":"Company type (companies only). Accepts labels ('Public Company', 'Privately Held', 'Non Profit', 'Educational Institution', 'Government Agency', 'Self-Employed', 'Self-Owned', 'Partnership') OR LinkedIn letter codes.","type":"array","items":{"type":"string"}},"annualRevenue":{"description":"Annual revenue ranges (companies only).","type":"array","items":{"type":"string"}},"numOfFollowers":{"description":"Company follower-count buckets (companies only). Accepts labels ('1-50', '51-100', '101-1,000', '1,001-5,000', '5,001+') OR ids 1-5.","type":"array","items":{"type":"string"}},"fortune":{"description":"Fortune-list membership (companies only). Accepts 'Fortune 50' / 'Fortune 100' / 'Fortune 250' / 'Fortune 500' OR codes FORTUNE_50/100/250/500.","type":"array","items":{"type":"string"}},"accountActivities":{"description":"Account buying-intent signals (companies only). Accepts labels ('Senior leadership changes in last 3 months', 'Funding events in past 12 months') OR codes SLC/RFE.","type":"array","items":{"type":"string"}},"jobOpportunities":{"description":"Account hiring signals (companies only). Accepts the LinkedIn hiring-signal labels OR codes.","type":"array","items":{"type":"string"}},"companyHeadcountGrowth":{"description":"Company headcount growth range (companies only), e.g. {min: 10} for companies growing 10%+ YoY.","type":"object","properties":{"min":{"description":"Minimum YoY headcount growth %.","type":"number"},"max":{"description":"Maximum YoY headcount growth %.","type":"number"}}},"departmentHeadcount":{"description":"Headcount of a specific department (companies only), e.g. {department:'Sales', min:20}.","type":"object","properties":{"department":{"type":"string","description":"Department name, e.g. 'Sales', 'Engineering'."},"min":{"type":"number"},"max":{"type":"number"}},"required":["department"]}}}}}},"responses":{"200":{"description":"Filter result count + coercion warnings.","content":{"application/json":{"example":{"success":true,"total":1736,"category":"people","creditsUsed":0,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total result count Sales Nav would return for this filter set."},"category":{"type":"string","enum":["people","companies"],"description":"Echoes the resolved category (helpful when the caller passed a URL)."},"warnings":{"description":"Per-value coercion warnings: labels that failed to resolve, with closest-match hints. The search still ran on the resolved subset; check `total` against your expectation.","type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"required":["field","value","type","hint"],"additionalProperties":false}},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","total","category","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/search/linkedin/sales-nav/personas":{"get":{"x-bereach":{"cost":"free","agents":["lead_gen"],"resultShape":"list"},"operationId":"listSalesNavPersonas","x-speakeasy-name-override":"listSalesNavPersonas","summary":"List the user's saved Sales Navigator personas","description":"Returns the user's custom buyer-persona library from Sales Navigator home (`sales.linkedin.com/home`).\n\nCall this BEFORE setting the `persona` filter on a Sales Nav search. The agent has no way to guess persona ids — they are user-defined. Match the user's intent against the returned `name` + `criteriaSummary`.\n\nRequires an active Sales Nav seat (403 otherwise — same gate as the search tools).","tags":["search"],"security":[{"token":[]}],"responses":{"200":{"description":"User's saved personas.","content":{"application/json":{"example":{"success":true,"personas":[{"id":"12345","name":"VP Sales EMEA","description":null,"criteriaSummary":"VP+ in Sales function, EMEA region"}],"count":1,"creditsUsed":0,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"personas":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"nullable":true,"type":"string"},"criteriaSummary":{"nullable":true,"description":"Human-readable summary of the persona's filter criteria (e.g. 'VP+ in Sales, US/UK'). Use this to match the user's intent to a saved persona.","type":"string"}},"required":["id","name","description","criteriaSummary"],"additionalProperties":false}},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","personas","count","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/search/linkedin/sales-nav/saved-searches":{"get":{"x-bereach":{"cost":"free","agents":["lead_gen"],"resultShape":"list"},"operationId":"listSalesNavSavedSearches","x-speakeasy-name-override":"listSalesNavSavedSearches","summary":"List the user's saved Sales Navigator searches","description":"Returns the user's saved Sales Navigator searches.\n\nCall this at the start of a search task when the user references prior work (\"run my fintech search\", \"the usual list\"). Match the user's intent against the returned `name`, then pass the matching `savedSearchUrl` straight into `search_sales_nav_people` / `search_sales_nav_companies` via the `url` field — no filter assembly needed.\n\nRequires an active Sales Nav seat.","tags":["search"],"security":[{"token":[]}],"responses":{"200":{"description":"User's saved searches.","content":{"application/json":{"example":{"success":true,"savedSearches":[{"id":"987654","name":"Series B fintech CXOs","category":"people","savedSearchUrl":"https://www.linkedin.com/sales/search/people?query=(...)","newResultsCount":12,"lastUsedAt":"2026-05-10T09:00:00Z"}],"count":1,"creditsUsed":0,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"savedSearches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"category":{"nullable":true,"type":"string","enum":["people","companies"]},"savedSearchUrl":{"type":"string","description":"Full Sales Navigator search URL — pass straight into search_sales_nav_people/companies via the `url` field."},"newResultsCount":{"nullable":true,"description":"New matches since the user last viewed this saved search, if LinkedIn reports it.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastUsedAt":{"nullable":true,"type":"string"}},"required":["id","name","category","savedSearchUrl","newResultsCount","lastUsedAt"],"additionalProperties":false}},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","savedSearches","count","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/visit/linkedin/profile":{"post":{"x-bereach":{"cost":"read","agents":["orchestrator","lead_gen","outreach"],"resultShape":"post","guards":["contactTargetingBulk"]},"operationId":"visitProfile","x-speakeasy-name-override":"visitProfile","summary":"Visit LinkedIn profile and extract contact data","description":"Visit a LinkedIn profile and return contact data. Call this tool to fetch profile data before composing a DM.\n\nOptional enrichment flags (`includePosts`, `includeComments`, `includeAbout`) fetch additional data in parallel with minimal latency overhead. `includeAbout` fetches the About section and detailed position descriptions. `includeComments` returns posts the profile recently engaged with (topic + author), useful for personalization — note that the actual comment text is not available from this API.\n\n`followersCount` and `connectionsCount` are always included in the response.","tags":["scrapers"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"profile":"https://www.linkedin.com/in/alexandre-sarfati","campaignSlug":"lead-magnet-post-12345","includePosts":true,"includeComments":true},"schema":{"type":"object","properties":{"profile":{"type":"string","description":"LinkedIn profile identifier. Accepts full URLs (e.g. https://www.linkedin.com/in/username), vanity names (e.g. john-doe), or profile URNs (e.g. urn:li:fsd_profile:ACoAAA...)."},"campaignSlug":{"description":"Optional campaign identifier for tracking only. No dedup — visit always executes.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"},"actionSlug":{"deprecated":true,"description":"Deprecated. Use campaignSlug only.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"},"includePosts":{"description":"When true, fetches the last 5 posts from the profile (fetched in parallel with other enrichments). Defaults to false.","type":"boolean"},"includeComments":{"description":"When true, fetches the last 5 posts the profile recently engaged with via comments. Returns engagement context (target post text, author) but not the comment text itself. Fetched in parallel with includePosts. Defaults to false.","type":"boolean"},"includeAbout":{"description":"When true, fetches the profile's About section and detailed position descriptions via a supplementary API call (fetched in parallel). Defaults to false.","type":"boolean"}},"required":["profile"]}}}},"responses":{"200":{"description":"Profile contact data","content":{"application/json":{"example":{"success":true,"firstName":"Alexandre","lastName":"Sarfati","headline":"Building cool stuff","publicIdentifier":"alexandre-sarfati","profileUrl":"https://www.linkedin.com/in/alexandre-sarfati","profileUrn":"urn:li:fsd_profile:ACoAACu_x48BiQInPmqFR0eD-Ycao_BxynDwWgs","imageUrl":null,"email":"alexandre@example.com","location":"Paris, France","company":"PIMMS","position":"Founder","memberDistance":0,"followersCount":1234,"pendingConnection":"none","cached":false,"creditsUsed":1,"retryAfter":0,"positions":[{"companyName":"PIMMS","title":"Founder","companyUrl":"https://www.linkedin.com/company/getpimms/","companyLogo":null,"startDate":{"month":3,"year":2025},"endDate":null,"isCurrent":true}],"educations":[{"schoolName":"Sciences Po","degreeName":null,"fieldOfStudy":null,"schoolUrl":"https://www.linkedin.com/school/sciences-po/","schoolLogo":null,"startDate":null,"endDate":null}],"lastPosts":[{"postUrl":"https://www.linkedin.com/feed/update/urn:li:activity:7440057626605973504/","text":"Comment collecter des leads avec son agent IA ?","date":1773847967769,"likesCount":7,"commentsCount":4,"sharesCount":0,"postUrn":"urn:li:fsd_update:(urn:li:activity:7440057626605973504,MEMBER_SHARES,DEBUG_REASON,DEFAULT,false)","postId":"7440057626605973504","type":"activity"}],"lastComments":[{"type":"comment","activityUrn":"urn:li:fsd_update:(urn:li:activity:7437847690320855040,MEMBER_SHARES,DEBUG_REASON,DEFAULT,false)","text":null,"reactionType":null,"targetPostUrn":"urn:li:activity:7437847690320855040","targetPostText":"Mon associé m'a fait le coup de Steve Jobs ! C'est un génie, d'abord il me fait la démo de l'ajout de 70 endpoints...","targetPostAuthor":null,"timestamp":null,"actorName":"Benjamin Joseph Benoudis","actorUrn":null}]},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"firstName":{"type":"string"},"lastName":{"type":"string"},"headline":{"nullable":true,"type":"string"},"summary":{"nullable":true,"description":"The profile's 'About' section text. Only populated when includeAbout is true. Null when not requested or not filled in.","type":"string"},"publicIdentifier":{"type":"string"},"profileUrl":{"nullable":true,"description":"LinkedIn profile URL. Null when publicIdentifier is unavailable (restricted profiles).","type":"string"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN (e.g. 'urn:li:fsd_profile:ACoAAA...'). Use this for matching against inbox participants.","type":"string"},"imageUrl":{"nullable":true,"type":"string"},"email":{"nullable":true,"type":"string"},"phone":{"nullable":true,"description":"Phone number from LinkedIn profile (rarely available)","type":"string"},"location":{"nullable":true,"type":"string"},"company":{"nullable":true,"description":"Current company name (from most recent position)","type":"string"},"position":{"nullable":true,"description":"Current job title (from most recent position)","type":"string"},"memberDistance":{"nullable":true,"description":"Connection degree: 0 (self), 1 (direct connection), 2+ (2nd degree, 3rd degree, etc.), or null if unknown","type":"number"},"connectionsCount":{"nullable":true,"description":"Total number of connections. May be null for non-connected profiles or restricted visibility.","type":"number"},"followersCount":{"nullable":true,"description":"Total number of followers. Null for restricted profiles or when unavailable.","type":"number"},"isVerified":{"type":"boolean","description":"Whether the profile has a LinkedIn verification badge."},"pendingConnection":{"type":"string","enum":["pending","failed","none"],"description":"Connection request status: 'pending' if request was sent successfully, 'failed' if request failed today, 'none' if not tracked"},"positions":{"description":"Work experience positions","type":"array","items":{"type":"object","properties":{"companyName":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"description":{"description":"Position description / responsibilities text (only populated when includeAbout is true)","nullable":true,"type":"string"},"companyUrl":{"nullable":true,"type":"string"},"companyLogo":{"nullable":true,"type":"string"},"companyDescription":{"description":"Short description of the company (only populated when includeAbout is true)","nullable":true,"type":"string"},"startDate":{"nullable":true,"type":"object","properties":{"month":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"year":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["month","year"],"additionalProperties":false},"endDate":{"nullable":true,"type":"object","properties":{"month":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"year":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["month","year"],"additionalProperties":false},"isCurrent":{"type":"boolean"}},"required":["companyName","title","companyUrl","companyLogo","startDate","endDate","isCurrent"],"additionalProperties":false}},"educations":{"description":"Education entries","type":"array","items":{"type":"object","properties":{"schoolName":{"nullable":true,"type":"string"},"degreeName":{"nullable":true,"type":"string"},"fieldOfStudy":{"nullable":true,"type":"string"},"schoolUrl":{"nullable":true,"type":"string"},"schoolLogo":{"nullable":true,"type":"string"},"startDate":{"nullable":true,"type":"object","properties":{"month":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"year":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["month","year"],"additionalProperties":false},"endDate":{"nullable":true,"type":"object","properties":{"month":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"year":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["month","year"],"additionalProperties":false}},"required":["schoolName","degreeName","fieldOfStudy","schoolUrl","schoolLogo","startDate","endDate"],"additionalProperties":false}},"lastPosts":{"description":"Last 5 posts from the profile (only present when includePosts is true)","type":"array","items":{"type":"object","properties":{"postUrl":{"type":"string","description":"Public URL of the post."},"text":{"type":"string","description":"Post text content."},"date":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Post creation timestamp (Unix milliseconds)."},"likesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total reactions on this post."},"commentsCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total top-level comments on this post."},"sharesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total shares/reposts of this post."},"postUrn":{"type":"string","description":"LinkedIn internal URN for this post. Use with engagement tools (like, comment, collect_likes/comments)."},"postId":{"type":"string","description":"Numeric post identifier parsed from the URN."},"type":{"type":"string","enum":["activity","ugcPost","share"],"description":"LinkedIn post type: 'ugcPost' = standard post, 'share' = native share/repost, 'activity' = legacy format."},"isRepost":{"description":"True when the post is a repost/reshare of another post. Absent for original posts.","type":"boolean"},"media":{"description":"Media attached to the post (image, video, document, or article). Absent when the post is text-only.","type":"object","properties":{"type":{"type":"string","enum":["image","video","document","article"],"description":"Type of media attached to the post."},"urls":{"type":"array","items":{"type":"string"},"description":"Media URLs (image URLs for carousels, video streaming URL, article link, etc.)."},"title":{"description":"Title of the article or document, when available.","type":"string"},"thumbnailUrl":{"description":"Thumbnail URL for videos, articles, or document covers.","type":"string"}},"required":["type","urls"],"additionalProperties":false}},"required":["postUrl","text","date","likesCount","commentsCount","sharesCount","postUrn","postId","type"],"additionalProperties":false}},"lastComments":{"description":"Last 5 posts the profile recently commented on (only present when includeComments is true). Contains targetPostText and targetPostAuthor for engagement context.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["comment","reaction"],"description":"Activity type: 'comment' for posts the user commented on"},"activityUrn":{"type":"string","description":"URN of the feed update (post) the user engaged with"},"text":{"nullable":true,"description":"The user's comment text (null when not available from the API — this is a LinkedIn limitation)","type":"string"},"reactionType":{"nullable":true,"description":"Reaction type (e.g. 'LIKE', 'CELEBRATE'). Only set for reaction-type activities","type":"string"},"targetPostUrn":{"nullable":true,"description":"URN of the post the user commented on (e.g. 'urn:li:activity:1234567890')","type":"string"},"targetPostText":{"nullable":true,"description":"First ~200 chars of the post the user commented on. Use this to understand what topics they engage with","type":"string"},"targetPostAuthor":{"nullable":true,"description":"Name of the post author (the person whose post was commented on)","type":"string"},"timestamp":{"nullable":true,"description":"Unix timestamp in milliseconds when the activity occurred","type":"number"},"actorName":{"nullable":true,"description":"Name of the post author (same as targetPostAuthor when available)","type":"string"},"actorUrn":{"nullable":true,"description":"Profile URN of the post author","type":"string"}},"required":["type","activityUrn","text","reactionType","targetPostUrn","targetPostText","targetPostAuthor","timestamp","actorName","actorUrn"],"additionalProperties":false}},"aboutFetched":{"description":"true when includeAbout was requested and the About section was fetched. Used for cache invalidation.","type":"boolean"},"cached":{"type":"boolean","description":"true if this result was served from a local cache rather than a fresh LinkedIn API call."},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","firstName","lastName","headline","summary","publicIdentifier","profileUrl","profileUrn","imageUrl","email","phone","location","company","position","memberDistance","connectionsCount","followersCount","isVerified","pendingConnection","cached","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/visit/linkedin/profile/bulk":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"]},"operationId":"bulkVisitProfiles","x-speakeasy-name-override":"bulkVisitProfile","summary":"Queue bulk LinkedIn profile visits (fire-and-forget)","description":"Queue up to 50 LinkedIn profiles for background visit and CRM enrichment. Returns immediately (~100ms). Profiles that were recently visited are resolved instantly. Uncached profiles are processed via a durable background workflow that visits profiles sequentially. Multiple calls queue safely (no rejection). Use the batch status endpoint to check progress. Use campaignSlug to auto-add visited contacts to a campaign. For lightweight ID → vanity URL resolution without fetching full profile content, use POST /resolve/linkedin/profiles instead (cheaper and synchronous).","tags":["scrapers"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"profiles":["https://www.linkedin.com/in/john-doe","https://www.linkedin.com/in/jane-smith","alexandre-sarfati"],"campaignSlug":"lead-magnet-post-12345","includePosts":true},"schema":{"type":"object","properties":{"profiles":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string"},"description":"LinkedIn profile URLs, vanity names, or URNs (max 50). Duplicates are auto-removed."},"campaignSlug":{"description":"Auto-add each successfully visited contact to this campaign.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"},"includePosts":{"description":"Fetch last 5 posts per profile. Increases processing time.","type":"boolean"},"includeComments":{"description":"Fetch recent comments per profile. Increases processing time.","type":"boolean"},"includeAbout":{"description":"Fetch About section and detailed position descriptions per profile. Increases processing time.","type":"boolean"}},"required":["profiles"]}}}},"responses":{"202":{"description":"Batch accepted and queued for processing","content":{"application/json":{"example":{"accepted":true,"batchId":"bv_abc123","profileCount":3,"alreadyCached":1,"willVisit":2,"estimatedMinutes":0.3},"schema":{"type":"object","properties":{"accepted":{"type":"boolean","enum":[true]},"batchId":{"type":"string","description":"Unique batch identifier for status polling."},"profileCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total unique profiles in the batch (after dedup)."},"alreadyCached":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Profiles already available without a fresh LinkedIn API call."},"willVisit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Profiles queued for LinkedIn API visit."},"estimatedMinutes":{"type":"number","description":"Estimated processing time in minutes for queued profiles."}},"required":["accepted","batchId","profileCount","alreadyCached","willVisit","estimatedMinutes"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/visit/linkedin/profile/bulk/{batchId}":{"get":{"operationId":"bulkVisitBatchStatus","x-speakeasy-name-override":"bulkVisitBatchStatus","summary":"Get bulk visit batch status","description":"Retrieve the status and results of a bulk visit batch. Returns progress, per-profile results, and credits used.","tags":["scrapers"],"security":[{"token":[]}],"parameters":[{"name":"batchId","in":"path","required":true,"schema":{"type":"string"},"description":"Batch identifier returned by the bulk visit endpoint."}],"responses":{"200":{"description":"Batch status","content":{"application/json":{"schema":{"type":"object","properties":{"batchId":{"type":"string"},"status":{"type":"string","enum":["queued","processing","completed","partial","failed"]},"progress":{"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"visited":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"cached":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["total","visited","cached","failed","skipped","pending"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failureReason":{"nullable":true,"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"profile":{"type":"string"},"status":{"type":"string","enum":["visited","cached","failed","skipped","pending"]},"contactId":{"nullable":true,"type":"string"},"error":{"nullable":true,"type":"string"}},"required":["profile","status"],"additionalProperties":false}}},"required":["batchId","status","progress","creditsUsed"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/resolve/linkedin/profiles":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"]},"operationId":"resolveProfiles","x-speakeasy-name-override":"resolveProfiles","summary":"Resolve LinkedIn identifiers to canonical profile URLs + URNs","description":"# Resolve LinkedIn profile identifiers\n\nLightweight batch resolver. Converts any LinkedIn identifier — URL, URN, vanity name, ACoA id, or Sales Navigator deep link — into a canonical `/in/<slug>` URL and `urn:li:fsd_profile:ACo...` URN. Does **not** fetch profile content (use `/visit/linkedin/profile` or `/visit/linkedin/profile/bulk` for that).\n\n## When to use\n- Sales Navigator search returned a `profileUrl` that starts with `/sales/` (Tier 3 fallback) and you need the canonical `/in/` form to persist or act on.\n- You have only an ACoA id or URN and want to upgrade it to a vanity URL.\n- You want to bulk-normalize a list of mixed identifiers before downstream processing.\n\n## Status values\n| Status | Meaning |\n|--------|---------|\n| `resolved` | Canonical vanity `/in/<slug>` available. |\n| `acoa_only` | We have a URN + synthesized `/in/<ACoA>` URL but no vanity. Still persistable; LinkedIn accepts the ACoA id as the slug. |\n| `failed` | Could not resolve (see `error`). For `member_urn_requires_visit`, use `/visit/linkedin/profile` instead. |\n\n## Pacing\nRequests are paced automatically. Lookups run synchronously — most complete sub-second for identifiers already seen recently. Batch up to 50 identifiers per call.\n\n## Synchronous\nReturns when all items are resolved. Worst case (50 all-uncached vanity lookups) is ~100s. Most calls complete sub-second thanks to cache + ACoA fast path (no network).","tags":["scrapers"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"inputs":["https://www.linkedin.com/in/alexandre-sarfati","urn:li:fsd_profile:ACoAAAaZ1234567890abcdefghi","ACoAAAbX0987654321zyxwvutsrq","https://www.linkedin.com/sales/lead/ACoAAAcC11223344,NAME_SEARCH,Xyz9"]},"schema":{"type":"object","properties":{"inputs":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string"},"description":"Up to 50 LinkedIn identifiers to resolve. Accepts any mix of: full profile URLs (https://www.linkedin.com/in/username), vanity names (john-doe), profile URNs (urn:li:fsd_profile:ACoAAA...), bare ACoA ids, and Sales Navigator deep links. Duplicates are auto-removed."}},"required":["inputs"]}}}},"responses":{"200":{"description":"Per-input resolution results.","content":{"application/json":{"example":{"results":[{"input":"https://www.linkedin.com/in/alexandre-sarfati","profileUrl":"https://www.linkedin.com/in/alexandre-sarfati","profileUrn":"urn:li:fsd_profile:ACoAAAaZ1234567890abcdefghi","publicIdentifier":"alexandre-sarfati","status":"resolved","error":null,"cached":false},{"input":"urn:li:fsd_profile:ACoAAAaZ1234567890abcdefghi","profileUrl":"https://www.linkedin.com/in/ACoAAAaZ1234567890abcdefghi","profileUrn":"urn:li:fsd_profile:ACoAAAaZ1234567890abcdefghi","publicIdentifier":null,"status":"acoa_only","error":null,"cached":true}],"creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"input":{"type":"string","description":"Echo of the caller-submitted identifier."},"profileUrl":{"nullable":true,"description":"Canonical https://www.linkedin.com/in/<slug> URL when resolvable, else null.","type":"string"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN (urn:li:fsd_profile:ACo...) when resolvable, else null.","type":"string"},"publicIdentifier":{"nullable":true,"description":"Vanity slug (john-doe) when available. Null when only an ACoA id is known.","type":"string"},"status":{"type":"string","enum":["resolved","acoa_only","failed"],"description":"resolved = canonical vanity URL; acoa_only = only an ACoA id/URN (still persistable); failed = could not resolve (see error)."},"error":{"nullable":true,"description":"Machine-readable failure reason when status = failed (e.g. invalid_input, not_found, rate_limit_exceeded).","type":"string"},"cached":{"type":"boolean","description":"True when served from a local cache rather than a fresh LinkedIn API call."}},"required":["input","profileUrl","profileUrn","publicIdentifier","status","error","cached"],"additionalProperties":false}},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["results","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/visit/linkedin/company":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"]},"operationId":"visitCompany","x-speakeasy-name-override":"visitCompany","summary":"Visit LinkedIn company page and extract profile data","description":"Fetches a LinkedIn company profile by URL or universal name. Returns structured company data including description, industry, employee count, headquarters, logo, affiliated/similar companies, and more. Optionally enriches with workplace policy data (costs 1 extra credit per optional API call).","tags":["scrapers"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"companyUrl":"https://www.linkedin.com/company/openai","includeWorkplacePolicy":true},"schema":{"type":"object","properties":{"companyUrl":{"type":"string","description":"LinkedIn company URL (e.g., 'https://www.linkedin.com/company/openai') or universal name (e.g., 'openai')"},"includeWorkplacePolicy":{"description":"Include workplace policy data such as hybrid/remote status and benefits. Costs 1 extra credit (extra API call).","type":"boolean"}},"required":["companyUrl"]}}}},"responses":{"200":{"description":"Company profile data","content":{"application/json":{"example":{"success":true,"id":"11130470","universalName":"openai","name":"OpenAI","description":"OpenAI is an AI research and deployment company dedicated to ensuring that general-purpose artificial intelligence benefits all of humanity.","url":"https://www.linkedin.com/company/openai/","websiteUrl":"https://openai.com/","industry":"Research Services","employeeCount":7358,"employeeCountRange":{"start":201,"end":500},"headquarter":{"country":"US","geographicArea":"CA","city":"San Francisco","postalCode":"94110","line1":null,"line2":null},"logoUrl":"https://media.licdn.com/dms/image/v2/D560BAQHpzXbqSyR74A/company-logo_200_200/...","coverImageUrl":"https://media.licdn.com/dms/image/v2/D563DAQEiLbFUDLFr1g/image-scale_127_750/...","followerCount":10130271,"specialities":["artificial intelligence","machine learning"],"tagline":null,"isVerified":true,"foundedOn":null,"phone":null,"callToAction":{"type":"VIEW_WEBSITE","url":"https://openai.com/"},"hashtags":["ai","machinelearning","openai"],"affiliatedCompanies":[{"id":"111776577","universalName":"openai-devs","name":"OpenAI Developers","url":"https://www.linkedin.com/showcase/openai-devs/","logoUrl":null,"followerCount":7467,"industry":"Technology, Information and Internet"}],"similarCompanies":[{"id":"106863934","universalName":"claude","name":"Claude","url":"https://www.linkedin.com/showcase/claude/","logoUrl":null,"followerCount":445255,"industry":"Technology, Information and Internet"}],"workplacePolicy":{"title":"Hybrid workplace","description":"Our teams work collaboratively in our San Francisco HQ 2-3 days per week.","timeAtOnsite":"3 days per week","benefits":["Collaborative Working Space","Company Offsites","Free Meals"]},"creditsUsed":2,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"id":{"type":"string","description":"LinkedIn numeric company ID"},"universalName":{"type":"string","description":"Company URL slug"},"name":{"type":"string"},"description":{"nullable":true,"type":"string"},"url":{"type":"string","description":"LinkedIn company page URL"},"websiteUrl":{"nullable":true,"description":"External website URL","type":"string"},"industry":{"nullable":true,"type":"string"},"employeeCount":{"nullable":true,"description":"Exact employee count on LinkedIn","type":"number"},"employeeCountRange":{"nullable":true,"description":"Employee count range","type":"object","properties":{"start":{"type":"number"},"end":{"nullable":true,"type":"number"}},"required":["start","end"],"additionalProperties":false},"headquarter":{"nullable":true,"type":"object","properties":{"country":{"nullable":true,"type":"string"},"geographicArea":{"nullable":true,"type":"string"},"city":{"nullable":true,"type":"string"},"postalCode":{"nullable":true,"type":"string"},"line1":{"nullable":true,"type":"string"},"line2":{"nullable":true,"type":"string"}},"required":["country","geographicArea","city","postalCode","line1","line2"],"additionalProperties":false},"logoUrl":{"nullable":true,"type":"string"},"coverImageUrl":{"nullable":true,"type":"string"},"followerCount":{"nullable":true,"type":"number"},"specialities":{"type":"array","items":{"type":"string"}},"tagline":{"nullable":true,"type":"string"},"isVerified":{"type":"boolean"},"foundedOn":{"nullable":true,"type":"object","properties":{"year":{"type":"number"}},"required":["year"],"additionalProperties":false},"phone":{"nullable":true,"type":"string"},"callToAction":{"nullable":true,"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string"}},"required":["type","url"],"additionalProperties":false},"hashtags":{"type":"array","items":{"type":"string"}},"affiliatedCompanies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"universalName":{"type":"string"},"name":{"type":"string"},"url":{"nullable":true,"type":"string"},"logoUrl":{"nullable":true,"type":"string"},"followerCount":{"nullable":true,"type":"number"},"industry":{"nullable":true,"type":"string"}},"required":["id","universalName","name","url","logoUrl","followerCount","industry"],"additionalProperties":false},"description":"Showcase / affiliated pages"},"similarCompanies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"universalName":{"type":"string"},"name":{"type":"string"},"url":{"nullable":true,"type":"string"},"logoUrl":{"nullable":true,"type":"string"},"followerCount":{"nullable":true,"type":"number"},"industry":{"nullable":true,"type":"string"}},"required":["id","universalName","name","url","logoUrl","followerCount","industry"],"additionalProperties":false},"description":"Similar companies suggested by LinkedIn"},"workplacePolicy":{"nullable":true,"description":"Workplace policy (null when includeWorkplacePolicy is false or data unavailable)","type":"object","properties":{"title":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"timeAtOnsite":{"nullable":true,"type":"string"},"benefits":{"type":"array","items":{"type":"string"}}},"required":["title","description","timeAtOnsite","benefits"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","id","universalName","name","description","url","websiteUrl","industry","employeeCount","employeeCountRange","headquarter","logoUrl","coverImageUrl","followerCount","specialities","tagline","isVerified","foundedOn","phone","callToAction","hashtags","affiliatedCompanies","similarCompanies","workplacePolicy","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/connect/linkedin/profile":{"post":{"x-bereach":{"cost":"write","agents":["lead_gen","outreach"],"guards":["visitFirst","profileTargeting","contactTargetingBulk","warmupBlocked"]},"operationId":"connectProfile","x-speakeasy-name-override":"connectProfile","summary":"Send LinkedIn connection request","description":"Send a connection request to the specified LinkedIn profile. Optionally include a personalized message (max 300 chars).","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"profile":"https://www.linkedin.com/in/username","message":"Hi, I'd love to connect with you!"},"schema":{"type":"object","properties":{"profile":{"type":"string","description":"LinkedIn profile identifier. Accepts full URLs (e.g. https://www.linkedin.com/in/username), vanity names (e.g. john-doe), or profile URNs (e.g. urn:li:fsd_profile:ACoAAA...)."},"message":{"description":"Optional personalized message to include with the connection request. Maximum 300 characters.","type":"string","maxLength":300},"campaignSlug":{"description":"Campaign identifier for deduplication. Dedup by profile automatically.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"},"actionSlug":{"deprecated":true,"description":"Deprecated. Use campaignSlug only.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"}},"required":["profile"]}}}},"responses":{"200":{"description":"Connection request sent successfully","content":{"application/json":{"example":{"success":true,"message":"Connection request sent","creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"message":{"type":"string"},"duplicate":{"description":"True if a connection request was already successfully sent to this profile this week","type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","message","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/invitations/linkedin":{"post":{"x-bereach":{"cost":"read","agents":["outreach"]},"operationId":"listInvitations","x-speakeasy-name-override":"listInvitations","summary":"List received LinkedIn connection invitations","description":"Returns pending connection invitations received by the authenticated LinkedIn account. Each invitation includes the invitationId and sharedSecret needed to accept it via the accept endpoint.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":false,"content":{"application/json":{"example":{"start":0,"count":10},"schema":{"type":"object","properties":{"start":{"default":0,"description":"Pagination offset (0-based)","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"default":10,"description":"Number of invitations to return (max 100)","type":"integer","minimum":1,"maximum":100}}}}}},"responses":{"200":{"description":"List of pending invitations","content":{"application/json":{"example":{"success":true,"invitations":[{"invitationId":"7431723100481851393","sharedSecret":"x2mPswjA","entityUrn":"urn:li:fs_relInvitation:7431723100481851393","sentAt":"2026-02-20T14:30:00.000Z","senderProfileId":"ACoAAB6pI5sBCHuu-3EkvcRl3sgtG7ayAb9FiS0","senderFirstName":"Cindy","senderLastName":"Singer","message":null,"fromMember":{"name":"Cindy Singer","headline":"Marketing Director at Acme Corp","profileUrl":"https://www.linkedin.com/in/cindy-singer","profilePicture":"https://media.licdn.com/dms/image/v2/example.jpg","publicIdentifier":"cindy-singer","profileUrn":"urn:li:fsd_profile:ACoAAB6pI5sBCHuu"}}],"total":36,"start":0,"count":10,"creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"invitations":{"type":"array","items":{"type":"object","properties":{"invitationId":{"type":"string","description":"Invitation ID needed for accepting"},"sharedSecret":{"type":"string","description":"Shared secret needed for accepting"},"entityUrn":{"type":"string","description":"Full invitation URN"},"sentAt":{"nullable":true,"description":"ISO 8601 timestamp when invitation was sent","type":"string"},"message":{"nullable":true,"description":"Custom message included with the invitation","type":"string"},"senderProfileId":{"nullable":true,"description":"Sender's profile ID (pass to accept endpoint)","type":"string"},"senderFirstName":{"nullable":true,"description":"Sender's first name (pass to accept endpoint)","type":"string"},"senderLastName":{"nullable":true,"description":"Sender's last name (pass to accept endpoint)","type":"string"},"fromMember":{"nullable":true,"description":"Profile info of the person who sent the invitation","type":"object","properties":{"name":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"profilePicture":{"nullable":true,"type":"string"},"publicIdentifier":{"nullable":true,"type":"string"},"profileUrn":{"nullable":true,"type":"string"}},"required":["name","headline","profileUrl","profilePicture","publicIdentifier","profileUrn"],"additionalProperties":false}},"required":["invitationId","sharedSecret","entityUrn","sentAt","message","senderProfileId","senderFirstName","senderLastName","fromMember"],"additionalProperties":false}},"total":{"type":"number","description":"Total number of pending invitations"},"start":{"type":"number"},"count":{"type":"number"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","invitations","total","start","count","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/accept/linkedin/invitation":{"post":{"x-bereach":{"cost":"write","agents":["outreach"]},"operationId":"acceptInvitation","x-speakeasy-name-override":"acceptInvitation","summary":"Accept a LinkedIn connection invitation","description":"Accepts a pending connection invitation. Requires the invitationId and sharedSecret obtained from the list invitations endpoint. No daily/weekly cap — only a 5-second minimum interval between calls.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"invitationId":"7431723100481851393","sharedSecret":"x2mPswjA","senderProfileId":"ACoAAB6pI5sBCHuu-3EkvcRl3sgtG7ayAb9FiS0","firstName":"Cindy","lastName":"Singer"},"schema":{"type":"object","properties":{"invitationId":{"type":"string","description":"Invitation ID (from the list invitations endpoint)"},"sharedSecret":{"type":"string","description":"Shared secret / validation token (from the list invitations endpoint)"},"senderProfileId":{"description":"Sender's profile ID (from the list invitations endpoint, e.g. 'ACoAAB6pI5sB...'). Recommended for reliability.","type":"string"},"firstName":{"description":"Sender's first name (from the list invitations endpoint). Recommended for reliability.","type":"string"},"lastName":{"description":"Sender's last name (from the list invitations endpoint). Recommended for reliability.","type":"string"}},"required":["invitationId","sharedSecret"]}}}},"responses":{"200":{"description":"Invitation accepted successfully","content":{"application/json":{"example":{"success":true,"message":"Invitation accepted","creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"message":{"type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","message","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/message/linkedin":{"post":{"x-bereach":{"cost":"write","agents":["lead_gen","outreach"],"guards":["profileTargeting","contactTargetingBulk","warmupBlocked"]},"operationId":"sendMessage","x-speakeasy-name-override":"sendMessage","summary":"Send LinkedIn message","description":"Send a message to the specified LinkedIn recipient.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"profile":"https://www.linkedin.com/in/username","message":"Hi! I'd love to connect and learn more about your work.","campaignSlug":"lead-magnet-post-12345"},"schema":{"type":"object","properties":{"profile":{"description":"Accepts full LinkedIn profile URLs (e.g. https://www.linkedin.com/in/username), vanity names (e.g. john-doe), or profile URNs (e.g. urn:li:member:123456).","type":"string"},"conversationUrn":{"description":"LinkedIn conversation URN. When provided, bypasses profile URL lookup and replies to an existing conversation.","type":"string"},"message":{"type":"string","minLength":1,"description":"Message content to send"},"campaignSlug":{"description":"Campaign identifier for deduplication. Dedup by profile automatically.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"},"actionSlug":{"deprecated":true,"description":"Deprecated. Use campaignSlug only.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"}},"required":["message"]}}}},"responses":{"200":{"description":"Message sent successfully","content":{"application/json":{"example":{"success":true,"messageId":"message-sent","creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"messageId":{"type":"string"},"duplicate":{"description":"True if this action was already executed for the given campaignSlug + target.","type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","messageId","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/reply/linkedin/comment":{"post":{"x-bereach":{"cost":"write","agents":["orchestrator","outreach"],"guards":["profileTargeting","contactTargetingBulk"]},"operationId":"replyToComment","x-speakeasy-name-override":"replyToComment","summary":"Reply to a LinkedIn comment","description":"Sends a reply to a LinkedIn comment. Use the commentUrn returned by /collect/linkedin/comments directly — do NOT reconstruct it from hash fields.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"commentUrn":"urn:li:comment:(activity:7399026485694537728,7399230513867026433)","message":"Thank you for your comment!","campaignSlug":"lead-magnet-post-12345"},"schema":{"type":"object","properties":{"commentUrn":{"type":"string","minLength":1,"description":"LinkedIn comment URN (e.g., 'urn:li:comment:(activity:7399026485694537728,7399230513867026433)')"},"message":{"type":"string","minLength":1,"description":"Reply message text"},"campaignSlug":{"description":"Campaign identifier for deduplication. Dedup by commentUrn automatically.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"},"actionSlug":{"deprecated":true,"description":"Deprecated. Use campaignSlug only.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"}},"required":["commentUrn","message"]}}}},"responses":{"200":{"description":"Reply sent successfully","content":{"application/json":{"example":{"success":true,"replyUrn":"urn:li:comment:(activity:7399026485694537728,7399230513867026434)","creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"replyUrn":{"description":"URN of the created reply comment","type":"string"},"duplicate":{"description":"True if this action was already executed for the given campaignSlug + target.","type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/like/linkedin/comment":{"post":{"x-bereach":{"cost":"write","agents":["orchestrator","outreach"],"guards":["profileTargeting"]},"operationId":"likeComment","x-speakeasy-name-override":"likeComment","summary":"Like a LinkedIn comment","description":"Reacts to a LinkedIn comment. Use the commentUrn returned by /collect/linkedin/comments directly — do NOT reconstruct it from hash fields.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"commentUrn":"urn:li:comment:(activity:7399026485694537728,7399230513867026433)","reactionType":"LIKE","campaignSlug":"lead-magnet-post-12345"},"schema":{"type":"object","properties":{"commentUrn":{"type":"string","minLength":1,"description":"LinkedIn comment URN (e.g., 'urn:li:comment:(activity:7399026485694537728,7399230513867026433)')"},"reactionType":{"default":"LIKE","description":"Reaction type (default: LIKE)","type":"string","enum":["LIKE","LOVE","CELEBRATE","SUPPORT","FUNNY","INSIGHTFUL"]},"campaignSlug":{"description":"Campaign identifier for deduplication. Dedup by commentUrn automatically.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"},"actionSlug":{"deprecated":true,"description":"Deprecated. Use campaignSlug only.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"}},"required":["commentUrn"]}}}},"responses":{"200":{"description":"Comment liked successfully","content":{"application/json":{"example":{"success":true,"resourceKey":"urn:li:fsd_reaction:(urn:li:fsd_profile:ACoAACu_x48BiQInPmqFR0eD-Ycao_BxynDwWgs,urn:li:comment:(activity:7399026485694537728,7399230513867026433),0)","creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"resourceKey":{"description":"Resource key of the created reaction","type":"string"},"duplicate":{"description":"True if this action was already executed for the given campaignSlug + target.","type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/publish/linkedin/post":{"post":{"x-bereach":{"cost":"write"},"operationId":"publishPost","x-speakeasy-name-override":"publishPost","summary":"Publish or schedule a LinkedIn post","description":"Creates a new LinkedIn post. Supports instant publishing and scheduled posting. Optionally attach an image by providing its URL (imageUrl) or base64-encoded data (imageBase64).","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"text":"Excited to share our latest product update! Check it out.","mode":"instant","visibility":"ANYONE","campaignSlug":"product-launch-2026"},"schema":{"type":"object","properties":{"text":{"type":"string","minLength":1,"description":"Post commentary text"},"mode":{"type":"string","enum":["scheduled","instant"],"description":"Publish mode: 'instant' publishes immediately, 'scheduled' schedules for later"},"scheduledAt":{"description":"Timestamp in milliseconds for scheduled posts (required when mode='scheduled')","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"companyId":{"description":"If provided, post will be published as this company page (organization ID). User must be admin of the page.","type":"string"},"imageUrl":{"description":"URL of an image to attach to the post. Mutually exclusive with imageBase64.","type":"string","format":"uri"},"imageBase64":{"description":"Base64-encoded image data to attach to the post (e.g. data:image/png;base64,iVBOR... or raw base64). Mutually exclusive with imageUrl.","type":"string"},"imageFileName":{"description":"Filename for the uploaded image (e.g. 'banner.png'). Used with imageBase64. Defaults to 'image.jpg'.","type":"string"},"visibility":{"default":"ANYONE","description":"Post visibility","type":"string","enum":["ANYONE","CONNECTIONS"]},"mentions":{"description":"Profile mentions with text positions","type":"array","items":{"type":"object","properties":{"profileUrn":{"type":"string","description":"LinkedIn profile URN of the mentioned person (e.g., 'urn:li:fsd_profile:ACoAABZ0Qo4B...')"},"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Start character offset in the text where the mention begins"},"length":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Length of the mention text in characters"}},"required":["profileUrn","start","length"]}},"campaignSlug":{"description":"Campaign identifier for deduplication.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"},"actionSlug":{"deprecated":true,"description":"Deprecated. Use campaignSlug only.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"}},"required":["text","mode"]}}}},"responses":{"200":{"description":"Post published or scheduled successfully","content":{"application/json":{"example":{"success":true,"shareUrn":"urn:li:fsd_share:urn:li:share:7431487422175211520","activityUrn":"urn:li:activity:7431487422519062528","creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"shareUrn":{"type":"string","description":"URN of the created share (e.g., 'urn:li:fsd_share:urn:li:share:123...')"},"activityUrn":{"nullable":true,"description":"Activity URN (only available for instant mode)","type":"string"},"duplicate":{"description":"True if this action was already executed for the given campaignSlug + target.","type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","shareUrn","activityUrn","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/comment/linkedin/post":{"post":{"x-bereach":{"cost":"write","agents":["orchestrator","outreach"],"guards":["profileTargeting","contactTargetingBulk"]},"operationId":"commentOnPost","x-speakeasy-name-override":"createComment","summary":"Comment on a LinkedIn post","description":"Adds a top-level comment on a LinkedIn post. Supports deduplication via campaignSlug.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"postUrl":"https://www.linkedin.com/feed/update/urn:li:activity:7399026485694537728/","message":"Great insights! Thanks for sharing.","campaignSlug":"engagement-campaign-q1"},"schema":{"type":"object","properties":{"postUrl":{"type":"string","minLength":1,"description":"LinkedIn post URL (e.g., 'https://www.linkedin.com/feed/update/urn:li:activity:7399026485694537728/')"},"message":{"type":"string","minLength":1,"description":"Comment text"},"companyId":{"description":"If provided, comment will be posted as this company page (organization ID). User must be admin of the page.","type":"string"},"campaignSlug":{"description":"Campaign identifier for deduplication. Dedup by postUrl automatically.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"},"actionSlug":{"deprecated":true,"description":"Deprecated. Use campaignSlug only.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"}},"required":["postUrl","message"]}}}},"responses":{"200":{"description":"Comment posted successfully","content":{"application/json":{"example":{"success":true,"commentUrn":"urn:li:comment:(activity:7399026485694537728,7399230513867026433)","creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"commentUrn":{"description":"URN of the created comment (e.g., 'urn:li:comment:(activity:PARENT_ID,COMMENT_ID)')","type":"string"},"fsdCommentUrn":{"description":"FSD-format comment URN for use with the edit comment endpoint.","type":"string"},"duplicate":{"description":"True if this action was already executed for the given campaignSlug + target.","type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/like/linkedin/post":{"post":{"x-bereach":{"cost":"write","agents":["orchestrator","outreach"],"guards":["profileTargeting"]},"operationId":"likePost","x-speakeasy-name-override":"likePost","summary":"Like a LinkedIn post","description":"Reacts to a LinkedIn post. Accepts a post URL and an optional reaction type. Supports deduplication via campaignSlug.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"postUrl":"https://www.linkedin.com/feed/update/urn:li:activity:7399026485694537728/","reactionType":"LIKE","campaignSlug":"engagement-campaign-q1"},"schema":{"type":"object","properties":{"postUrl":{"type":"string","minLength":1,"description":"LinkedIn post URL (e.g., 'https://www.linkedin.com/feed/update/urn:li:activity:7399026485694537728/')"},"reactionType":{"default":"LIKE","description":"Reaction type (default: LIKE)","type":"string","enum":["LIKE","LOVE","CELEBRATE","SUPPORT","FUNNY","INSIGHTFUL"]},"companyId":{"description":"Act as a company page. Pass the numeric company ID from listCompanyPages. Requires admin access.","type":"string"},"campaignSlug":{"description":"Campaign identifier for deduplication. Dedup by postUrl automatically.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"},"actionSlug":{"deprecated":true,"description":"Deprecated. Use campaignSlug only.","type":"string","pattern":"^[a-zA-Z0-9_-]+$"}},"required":["postUrl"]}}}},"responses":{"200":{"description":"Post liked successfully","content":{"application/json":{"example":{"success":true,"resourceKey":"urn:li:fsd_reaction:(urn:li:fsd_profile:ACoAACu_x48BiQInPmqFR0eD-Ycao_BxynDwWgs,urn:li:activity:7399026485694537728,0)","creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"resourceKey":{"description":"Resource key of the created reaction","type":"string"},"duplicate":{"description":"True if this action was already executed for the given campaignSlug + target.","type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/me/linkedin":{"get":{"x-bereach":{"agents":["orchestrator","outreach"]},"operationId":"getProfile","x-speakeasy-name-override":"get","summary":"Get authenticated user's LinkedIn profile","description":"Returns the authenticated user's stored LinkedIn profile data from the database. No LinkedIn API call, Call /me/linkedin/refresh first to populate enriched data (positions, education, etc.).","tags":["profile"],"security":[{"token":[]}],"responses":{"200":{"description":"Stored LinkedIn profile data","content":{"application/json":{"example":{"success":true,"linkedinProfileId":"alexandre-sarfati","linkedinName":"Alexandre Sarfati","linkedinEmail":"alexandre@example.com","profileUrn":"urn:li:fsd_profile:ACoAACu_x48BiQInPmqFR0eD-Ycao_BxynDwWgs","headline":"Building cool stuff","profilePic":null,"profileUrl":"https://www.linkedin.com/in/alexandre-sarfati","positions":[{"companyName":"PIMMS","title":null,"companyUrl":"https://www.linkedin.com/company/getpimms/","companyLogo":"https://media.licdn.com/dms/image/v2/example/company-logo_200_200/0/example","startDate":{"month":3,"year":2025},"endDate":null,"isCurrent":true}],"educations":[{"schoolName":"Sciences Po","degreeName":null,"fieldOfStudy":null,"schoolUrl":"https://www.linkedin.com/school/sciences-po/","schoolLogo":"https://media.licdn.com/dms/image/v2/example/company-logo_200_200/0/example","startDate":null,"endDate":null}],"connectionsCount":3377,"location":{"countryCode":"fr","postalCode":"75001"},"isVerified":true,"creditsUsed":0,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"linkedinProfileId":{"nullable":true,"description":"LinkedIn vanity name (e.g., 'alexandre-sarfati')","type":"string"},"linkedinName":{"nullable":true,"description":"Full name from LinkedIn","type":"string"},"linkedinEmail":{"nullable":true,"description":"Email from LinkedIn profile","type":"string"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN","type":"string"},"headline":{"nullable":true,"description":"LinkedIn headline","type":"string"},"profilePic":{"nullable":true,"description":"Profile picture URL","type":"string"},"profileUrl":{"nullable":true,"description":"Full LinkedIn profile URL","type":"string"},"summary":{"description":"About section text (populated after /refresh with includeAbout)","nullable":true,"type":"string"},"positions":{"description":"Work positions (populated after /refresh)","type":"array","items":{"type":"object","properties":{"companyName":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"description":{"description":"Position description / responsibilities text (only populated when includeAbout is true)","nullable":true,"type":"string"},"companyUrl":{"nullable":true,"type":"string"},"companyLogo":{"nullable":true,"type":"string"},"companyDescription":{"description":"Short description of the company (only populated when includeAbout is true)","nullable":true,"type":"string"},"startDate":{"nullable":true,"type":"object","properties":{"month":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"year":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["month","year"],"additionalProperties":false},"endDate":{"nullable":true,"type":"object","properties":{"month":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"year":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["month","year"],"additionalProperties":false},"isCurrent":{"type":"boolean"}},"required":["companyName","title","companyUrl","companyLogo","startDate","endDate","isCurrent"],"additionalProperties":false}},"educations":{"description":"Education entries (populated after /refresh)","type":"array","items":{"type":"object","properties":{"schoolName":{"nullable":true,"type":"string"},"degreeName":{"nullable":true,"type":"string"},"fieldOfStudy":{"nullable":true,"type":"string"},"schoolUrl":{"nullable":true,"type":"string"},"schoolLogo":{"nullable":true,"type":"string"},"startDate":{"nullable":true,"type":"object","properties":{"month":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"year":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["month","year"],"additionalProperties":false},"endDate":{"nullable":true,"type":"object","properties":{"month":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"year":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["month","year"],"additionalProperties":false}},"required":["schoolName","degreeName","fieldOfStudy","schoolUrl","schoolLogo","startDate","endDate"],"additionalProperties":false}},"connectionsCount":{"nullable":true,"description":"Total LinkedIn connections","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"followersCount":{"description":"Total number of followers","nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"location":{"nullable":true,"description":"Profile location","type":"object","properties":{"countryCode":{"type":"string"},"postalCode":{"type":"string"}},"required":["countryCode"],"additionalProperties":false},"isVerified":{"nullable":true,"description":"LinkedIn verification status","type":"boolean"},"lastPosts":{"description":"Last 5 posts (populated when posts have been fetched via /me/linkedin/posts)","type":"array","items":{"type":"object","properties":{"postUrl":{"type":"string","description":"Public URL of the post."},"text":{"type":"string","description":"Post text content."},"date":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Post creation timestamp (Unix milliseconds)."},"likesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total reactions on this post."},"commentsCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total top-level comments on this post."},"sharesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total shares/reposts of this post."},"postUrn":{"type":"string","description":"LinkedIn internal URN for this post. Use with engagement tools (like, comment, collect_likes/comments)."},"postId":{"type":"string","description":"Numeric post identifier parsed from the URN."},"type":{"type":"string","enum":["activity","ugcPost","share"],"description":"LinkedIn post type: 'ugcPost' = standard post, 'share' = native share/repost, 'activity' = legacy format."},"isRepost":{"description":"True when the post is a repost/reshare of another post. Absent for original posts.","type":"boolean"},"media":{"description":"Media attached to the post (image, video, document, or article). Absent when the post is text-only.","type":"object","properties":{"type":{"type":"string","enum":["image","video","document","article"],"description":"Type of media attached to the post."},"urls":{"type":"array","items":{"type":"string"},"description":"Media URLs (image URLs for carousels, video streaming URL, article link, etc.)."},"title":{"description":"Title of the article or document, when available.","type":"string"},"thumbnailUrl":{"description":"Thumbnail URL for videos, articles, or document covers.","type":"string"}},"required":["type","urls"],"additionalProperties":false}},"required":["postUrl","text","date","likesCount","commentsCount","sharesCount","postUrn","postId","type"],"additionalProperties":false}},"lastComments":{"description":"Last 20 comments by the user (populated after /me/linkedin/activity?tabType=COMMENTS)","type":"array","items":{}},"lastReactions":{"description":"Last reactions by the user (populated after /me/linkedin/activity?tabType=REACTIONS)","type":"array","items":{}},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","linkedinProfileId","linkedinName","linkedinEmail","profileUrn","headline","profilePic","profileUrl","connectionsCount","location","isVerified","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/me/linkedin/accounts":{"get":{"x-bereach":{"agents":["orchestrator"]},"operationId":"listAccounts","x-speakeasy-name-override":"listAccounts","summary":"List all LinkedIn accounts for the authenticated user","description":"Returns all LinkedIn accounts connected by the user. Each account has credentials and profile info. The `isCurrent` flag indicates which account the current API token is bound to.","tags":["profile"],"security":[{"token":[]}],"responses":{"200":{"description":"List of LinkedIn accounts","content":{"application/json":{"example":{"success":true,"accounts":[{"id":"clxyz1234","label":"Personal","isDefault":true,"isCurrent":true,"linkedinProfileId":"john-doe","linkedinName":"John Doe","linkedinEmail":"john@example.com","profileUrl":"https://www.linkedin.com/in/john-doe","headline":"CEO at Acme Inc.","profilePic":null,"profileUrn":"urn:li:fsd_profile:ACoAAA...","isActive":true,"isValid":true,"createdAt":"2026-01-15T10:00:00.000Z","updatedAt":"2026-03-10T08:00:00.000Z"}],"total":1},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"nullable":true,"type":"string"},"isDefault":{"type":"boolean"},"isCurrent":{"type":"boolean","description":"Whether this account is the one used by the current API token."},"linkedinProfileId":{"nullable":true,"type":"string"},"linkedinName":{"nullable":true,"type":"string"},"linkedinEmail":{"nullable":true,"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"profilePic":{"nullable":true,"type":"string"},"profileUrn":{"nullable":true,"type":"string"},"isActive":{"type":"boolean"},"isValid":{"type":"boolean"},"accountPlan":{"nullable":true,"description":"Account plan tier (e.g. 'free', 'pro', 'team').","type":"string"},"isUnlimited":{"type":"boolean","description":"Whether this account has unlimited credits."},"creditsLimit":{"nullable":true,"description":"Monthly credit limit for this account. Null if unlimited.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits used in the current billing period."},"proxyConfig":{"nullable":true,"description":"Proxy status for this account. Full config is masked; only enabled flag is exposed.","type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"additionalProperties":false},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","label","isDefault","isCurrent","linkedinProfileId","linkedinName","linkedinEmail","profileUrl","headline","profilePic","profileUrn","isActive","isValid","accountPlan","isUnlimited","creditsLimit","creditsCount","proxyConfig","createdAt","updatedAt"],"additionalProperties":false}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","accounts","total","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAccount","x-speakeasy-name-override":"updateAccount","summary":"Update a LinkedIn account (label, default)","description":"Update account metadata. Setting `isDefault: true` clears the default flag from all other accounts.","tags":["profile"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"accountId":"clxyz1234","label":"Personal","isDefault":true},"schema":{"type":"object","properties":{"accountId":{"type":"string","description":"ID of the LinkedIn account to update."},"label":{"description":"User-facing label (e.g. 'Personal', 'Company SDR').","nullable":true,"type":"string"},"isDefault":{"description":"Set as the default account. Clears default from other accounts.","type":"boolean"},"proxyConfig":{"description":"Proxy config. Null = disable proxy. Object = enable with mode.","nullable":true,"oneOf":[{"type":"object","properties":{"mode":{"type":"string","enum":["residential"]},"country":{"description":"ISO 3166-1 alpha-2 country code.","type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Za-z]{2}$"},"city":{"description":"City for geo-targeting.","type":"string","maxLength":200},"rotationHours":{"default":1,"description":"Sticky IP rotation in hours (default 1).","type":"integer","minimum":1,"maximum":720}},"required":["mode","country"]},{"type":"object","properties":{"mode":{"type":"string","enum":["isp"]},"country":{"description":"ISO country code (reference only).","type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Za-z]{2}$"},"staticIp":{"type":"string","pattern":"^(\\d{1,3}\\.){3}\\d{1,3}$","description":"Dedicated ISP IPv4 address from Decodo."},"staticPort":{"type":"integer","minimum":1,"maximum":65535,"description":"Port for the static IP."}},"required":["mode","country","staticIp","staticPort"]}],"type":"object"}},"required":["accountId"]}}}},"responses":{"200":{"description":"Updated account","content":{"application/json":{"example":{"success":true,"account":{"id":"clxyz1234","label":"Personal","isDefault":true,"linkedinProfileId":"john-doe","linkedinName":"John Doe","headline":"CEO at Acme Inc.","profilePic":null,"isValid":true}},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"account":{"type":"object","properties":{"id":{"type":"string"},"label":{"nullable":true,"type":"string"},"isDefault":{"type":"boolean"},"linkedinProfileId":{"nullable":true,"type":"string"},"linkedinName":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"profilePic":{"nullable":true,"type":"string"},"isValid":{"type":"boolean"},"proxyConfig":{"nullable":true,"type":"object","properties":{"city":{"nullable":true,"type":"string"},"mode":{"nullable":true,"type":"string"},"country":{"nullable":true,"type":"string"},"rotationHours":{"nullable":true,"type":"number"}},"required":["city","mode","country","rotationHours"],"additionalProperties":false}},"required":["id","label","isDefault","linkedinProfileId","linkedinName","headline","profilePic","isValid","proxyConfig"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","account","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/me/linkedin/company-pages":{"post":{"x-bereach":{"cost":"read"},"operationId":"listCompanyPages","x-speakeasy-name-override":"list","summary":"List company pages the user administers","description":"Returns LinkedIn company pages where the authenticated user has admin access. Uses the Voyager organization admin API.","tags":["companyPages"],"security":[{"token":[]}],"responses":{"200":{"description":"List of managed company pages","content":{"application/json":{"example":{"success":true,"pages":[{"id":"12345678","universalName":"my-company","name":"My Company","url":"https://www.linkedin.com/company/my-company/","logoUrl":null,"followerCount":1500,"industry":"Technology, Information and Internet","employeeCount":25,"adminRole":"ADMINISTRATOR"}],"total":1,"creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"pages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"LinkedIn numeric company ID."},"universalName":{"type":"string","description":"Company URL slug (e.g. 'openai')."},"name":{"type":"string"},"url":{"type":"string"},"logoUrl":{"nullable":true,"type":"string"},"followerCount":{"nullable":true,"type":"number"},"industry":{"nullable":true,"type":"string"},"employeeCount":{"nullable":true,"type":"number"},"adminRole":{"nullable":true,"description":"Admin role (e.g. 'ADMINISTRATOR', 'CONTENT_ADMIN'). Null if role is unknown.","type":"string"}},"required":["id","universalName","name","url","logoUrl","followerCount","industry","employeeCount","adminRole"],"additionalProperties":false}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","pages","total","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/me/linkedin/company-pages/posts":{"post":{"x-bereach":{"cost":"read"},"operationId":"companyPagePosts","x-speakeasy-name-override":"posts","summary":"Get recent posts from a company page","description":"Fetch the most recent posts from a LinkedIn company page feed. Requires admin access to the company page.","tags":["companyPages"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"universalName":"my-company","count":10,"start":0},"schema":{"type":"object","properties":{"universalName":{"type":"string","description":"Company URL slug (e.g. 'openai'). Same value as returned by listCompanyPages."},"count":{"description":"Number of posts to return (max 50).","default":10,"type":"integer","minimum":1,"maximum":50},"start":{"description":"Pagination offset.","default":0,"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["universalName"]}}}},"responses":{"200":{"description":"Company page posts","content":{"application/json":{"example":{"success":true,"posts":[{"activityUrn":"urn:li:activity:7123456789","postUrl":"https://www.linkedin.com/feed/update/urn:li:activity:7123456789/","text":"Excited to announce our new product launch!","publishedAt":null,"numLikes":42,"numComments":5}],"total":15,"creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"posts":{"type":"array","items":{"type":"object","properties":{"activityUrn":{"type":"string","description":"LinkedIn activity URN for this post."},"postUrl":{"type":"string","description":"Direct URL to the post on LinkedIn."},"text":{"nullable":true,"description":"Post text content (null if media-only).","type":"string"},"publishedAt":{"nullable":true,"description":"Unix timestamp in milliseconds (null if unavailable).","type":"number"},"numLikes":{"nullable":true,"description":"Number of likes/reactions.","type":"number"},"numComments":{"nullable":true,"description":"Number of comments.","type":"number"}},"required":["activityUrn","postUrl","text","publishedAt","numLikes","numComments"],"additionalProperties":false}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total number of posts available."},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","posts","total","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/me/linkedin/company-pages/permissions":{"post":{"x-bereach":{"cost":"read"},"operationId":"companyPagePermissions","x-speakeasy-name-override":"getPermissions","summary":"Get admin permissions for a company page","description":"Returns the authenticated user's admin permissions on a given LinkedIn company page. Use this to check what actions (post, comment, like, message, analytics) are available before calling write endpoints.","tags":["companyPages"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"universalName":"my-company"},"schema":{"type":"object","properties":{"universalName":{"type":"string","description":"Company URL slug (e.g. 'openai'). Same value as returned by listCompanyPages."}},"required":["universalName"]}}}},"responses":{"200":{"description":"Company page admin permissions","content":{"application/json":{"example":{"success":true,"universalName":"my-company","permissions":{"role":"SUPER_ADMINISTRATOR","canCreateOrganicShare":true,"canCreateComment":true,"canCreateReaction":true,"canDeleteShare":true,"canPinShare":true,"canSendMessages":true,"canReadMessages":true,"canReadAdminDashboard":true,"canReadOrganizationUpdateAnalytics":true,"canReadOrganizationVisitorAnalytics":true,"canReadOrganizationFollowerAnalytics":true,"canReadOrganizationSearchAppearanceAnalytics":true,"canUpdateOrganizationProfile":true,"canEditAdministrators":true,"canDeactivateOrganization":true,"canEditEvents":true,"canReadEvents":true,"canSponsorShare":true,"canManageCareerPages":true,"canManageMessagingAccess":true,"canNotifyEmployees":true,"canExportLeads":true},"creditsUsed":1,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"universalName":{"type":"string"},"permissions":{"type":"object","properties":{"role":{"nullable":true,"description":"Admin role (e.g. 'SUPER_ADMINISTRATOR', 'ADMINISTRATOR', 'CONTENT_ADMIN').","type":"string"},"canCreateOrganicShare":{"type":"boolean","description":"Can post as the company page."},"canCreateComment":{"type":"boolean","description":"Can comment as the company page."},"canCreateReaction":{"type":"boolean","description":"Can like/react as the company page."},"canDeleteShare":{"type":"boolean","description":"Can delete company page posts."},"canPinShare":{"type":"boolean","description":"Can pin posts on the company page."},"canSendMessages":{"type":"boolean","description":"Can send messages from the company page inbox."},"canReadMessages":{"type":"boolean","description":"Can read the company page inbox."},"canReadAdminDashboard":{"type":"boolean","description":"Can access the admin analytics dashboard."},"canReadOrganizationUpdateAnalytics":{"type":"boolean","description":"Can view post/update analytics."},"canReadOrganizationVisitorAnalytics":{"type":"boolean","description":"Can view visitor analytics."},"canReadOrganizationFollowerAnalytics":{"type":"boolean","description":"Can view follower analytics."},"canReadOrganizationSearchAppearanceAnalytics":{"type":"boolean","description":"Can view search appearance analytics."},"canUpdateOrganizationProfile":{"type":"boolean","description":"Can edit the company page profile."},"canEditAdministrators":{"type":"boolean","description":"Can add/remove page admins."},"canDeactivateOrganization":{"type":"boolean","description":"Can deactivate the company page."},"canEditEvents":{"type":"boolean","description":"Can create/edit company events."},"canReadEvents":{"type":"boolean","description":"Can view company events."},"canSponsorShare":{"type":"boolean","description":"Can sponsor/boost posts."},"canManageCareerPages":{"type":"boolean","description":"Can manage the career page section."},"canManageMessagingAccess":{"type":"boolean","description":"Can manage messaging settings."},"canNotifyEmployees":{"type":"boolean","description":"Can notify employees about posts."},"canExportLeads":{"type":"boolean","description":"Can export lead-gen form leads."}},"required":["role","canCreateOrganicShare","canCreateComment","canCreateReaction","canDeleteShare","canPinShare","canSendMessages","canReadMessages","canReadAdminDashboard","canReadOrganizationUpdateAnalytics","canReadOrganizationVisitorAnalytics","canReadOrganizationFollowerAnalytics","canReadOrganizationSearchAppearanceAnalytics","canUpdateOrganizationProfile","canEditAdministrators","canDeactivateOrganization","canEditEvents","canReadEvents","canSponsorShare","canManageCareerPages","canManageMessagingAccess","canNotifyEmployees","canExportLeads"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","universalName","permissions","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/me/linkedin/company-pages/analytics":{"post":{"x-bereach":{"cost":"read"},"operationId":"companyPageAnalytics","x-speakeasy-name-override":"getAnalytics","summary":"Get company page overview analytics","description":"Returns overview analytics for a company page including visitor count, employee count, founding date, headquarters, description, and more. Requires `companyId` (numeric string, e.g. \"111652438\") in the request body.","tags":["companyPages"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"companyId":"111652438"},"schema":{"type":"object","properties":{"companyId":{"type":"string","description":"Company page ID (numeric, e.g. '111652438')"}},"required":["companyId"]}}}},"responses":{"200":{"description":"Company page overview analytics","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"analytics":{"type":"object","properties":{"name":{"type":"string"},"universalName":{"type":"string"},"followerCount":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"employeeCount":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"visitorsInPastMonthCount":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"isActive":{"type":"boolean"},"foundedOn":{"nullable":true,"type":"object","properties":{"year":{"type":"number"},"month":{"type":"number"},"day":{"type":"number"}},"required":["year"],"additionalProperties":false},"headquarter":{"nullable":true,"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"line1":{"type":"string"},"postalCode":{"type":"string"}},"required":["city","country"],"additionalProperties":false},"description":{"nullable":true,"type":"string"},"tagline":{"nullable":true,"type":"string"},"websiteUrl":{"nullable":true,"type":"string"},"organizationType":{"nullable":true,"type":"string"},"specialities":{"type":"array","items":{"type":"string"}},"industryUrns":{"type":"array","items":{"type":"string"}}},"required":["name","universalName","followerCount","employeeCount","visitorsInPastMonthCount","isActive","foundedOn","headquarter","description","tagline","websiteUrl","organizationType","specialities","industryUrns"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","analytics","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/me/linkedin/refresh":{"post":{"operationId":"refreshProfile","x-speakeasy-name-override":"refresh","summary":"Refresh authenticated user's LinkedIn profile","description":"Re-fetches the authenticated user's LinkedIn profile from the Voyager API and updates stored data (positions, education, location, connections count, verification status).","tags":["profile"],"security":[{"token":[]}],"responses":{"200":{"description":"Refreshed LinkedIn profile data","content":{"application/json":{"example":{"success":true,"linkedinProfileId":"alexandre-sarfati","linkedinName":"Alexandre Sarfati","linkedinEmail":"alexandre@example.com","profileUrn":"urn:li:fsd_profile:ACoAACu_x48BiQInPmqFR0eD-Ycao_BxynDwWgs","headline":"Building cool stuff","profilePic":null,"profileUrl":"https://www.linkedin.com/in/alexandre-sarfati","positions":[{"companyName":"PIMMS","title":null,"companyUrl":"https://www.linkedin.com/company/getpimms/","companyLogo":"https://media.licdn.com/dms/image/v2/example/company-logo_200_200/0/example","startDate":{"month":3,"year":2025},"endDate":null,"isCurrent":true}],"educations":[{"schoolName":"Sciences Po","degreeName":null,"fieldOfStudy":null,"schoolUrl":"https://www.linkedin.com/school/sciences-po/","schoolLogo":"https://media.licdn.com/dms/image/v2/example/company-logo_200_200/0/example","startDate":null,"endDate":null}],"connectionsCount":3377,"location":{"countryCode":"fr","postalCode":"75001"},"isVerified":true,"creditsUsed":0,"retryAfter":0,"refreshed":true},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"linkedinProfileId":{"nullable":true,"description":"LinkedIn vanity name (e.g., 'alexandre-sarfati')","type":"string"},"linkedinName":{"nullable":true,"description":"Full name from LinkedIn","type":"string"},"linkedinEmail":{"nullable":true,"description":"Email from LinkedIn profile","type":"string"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN","type":"string"},"headline":{"nullable":true,"description":"LinkedIn headline","type":"string"},"profilePic":{"nullable":true,"description":"Profile picture URL","type":"string"},"profileUrl":{"nullable":true,"description":"Full LinkedIn profile URL","type":"string"},"summary":{"description":"About section text (populated after /refresh with includeAbout)","nullable":true,"type":"string"},"positions":{"description":"Work positions (populated after /refresh)","type":"array","items":{"type":"object","properties":{"companyName":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"description":{"description":"Position description / responsibilities text (only populated when includeAbout is true)","nullable":true,"type":"string"},"companyUrl":{"nullable":true,"type":"string"},"companyLogo":{"nullable":true,"type":"string"},"companyDescription":{"description":"Short description of the company (only populated when includeAbout is true)","nullable":true,"type":"string"},"startDate":{"nullable":true,"type":"object","properties":{"month":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"year":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["month","year"],"additionalProperties":false},"endDate":{"nullable":true,"type":"object","properties":{"month":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"year":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["month","year"],"additionalProperties":false},"isCurrent":{"type":"boolean"}},"required":["companyName","title","companyUrl","companyLogo","startDate","endDate","isCurrent"],"additionalProperties":false}},"educations":{"description":"Education entries (populated after /refresh)","type":"array","items":{"type":"object","properties":{"schoolName":{"nullable":true,"type":"string"},"degreeName":{"nullable":true,"type":"string"},"fieldOfStudy":{"nullable":true,"type":"string"},"schoolUrl":{"nullable":true,"type":"string"},"schoolLogo":{"nullable":true,"type":"string"},"startDate":{"nullable":true,"type":"object","properties":{"month":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"year":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["month","year"],"additionalProperties":false},"endDate":{"nullable":true,"type":"object","properties":{"month":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"year":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["month","year"],"additionalProperties":false}},"required":["schoolName","degreeName","fieldOfStudy","schoolUrl","schoolLogo","startDate","endDate"],"additionalProperties":false}},"connectionsCount":{"nullable":true,"description":"Total LinkedIn connections","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"followersCount":{"description":"Total number of followers (populated during refresh)","nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"location":{"nullable":true,"description":"Profile location","type":"object","properties":{"countryCode":{"type":"string"},"postalCode":{"type":"string"}},"required":["countryCode"],"additionalProperties":false},"isVerified":{"nullable":true,"description":"LinkedIn verification status","type":"boolean"},"lastPosts":{"description":"Last 5 posts (populated when posts have been fetched via /me/linkedin/posts)","type":"array","items":{"type":"object","properties":{"postUrl":{"type":"string","description":"Public URL of the post."},"text":{"type":"string","description":"Post text content."},"date":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Post creation timestamp (Unix milliseconds)."},"likesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total reactions on this post."},"commentsCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total top-level comments on this post."},"sharesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total shares/reposts of this post."},"postUrn":{"type":"string","description":"LinkedIn internal URN for this post. Use with engagement tools (like, comment, collect_likes/comments)."},"postId":{"type":"string","description":"Numeric post identifier parsed from the URN."},"type":{"type":"string","enum":["activity","ugcPost","share"],"description":"LinkedIn post type: 'ugcPost' = standard post, 'share' = native share/repost, 'activity' = legacy format."},"isRepost":{"description":"True when the post is a repost/reshare of another post. Absent for original posts.","type":"boolean"},"media":{"description":"Media attached to the post (image, video, document, or article). Absent when the post is text-only.","type":"object","properties":{"type":{"type":"string","enum":["image","video","document","article"],"description":"Type of media attached to the post."},"urls":{"type":"array","items":{"type":"string"},"description":"Media URLs (image URLs for carousels, video streaming URL, article link, etc.)."},"title":{"description":"Title of the article or document, when available.","type":"string"},"thumbnailUrl":{"description":"Thumbnail URL for videos, articles, or document covers.","type":"string"}},"required":["type","urls"],"additionalProperties":false}},"required":["postUrl","text","date","likesCount","commentsCount","sharesCount","postUrn","postId","type"],"additionalProperties":false}},"lastComments":{"description":"Last 20 comments by the user (populated after /me/linkedin/activity?tabType=COMMENTS)","type":"array","items":{}},"lastReactions":{"description":"Last reactions by the user (populated after /me/linkedin/activity?tabType=REACTIONS)","type":"array","items":{}},"refreshed":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","linkedinProfileId","linkedinName","linkedinEmail","profileUrn","headline","profilePic","profileUrl","connectionsCount","location","isVerified","refreshed","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/me/linkedin/posts":{"post":{"x-bereach":{"agents":["orchestrator","lead_gen"],"resultShape":"post"},"operationId":"getOwnPosts","x-speakeasy-name-override":"posts","summary":"Get authenticated user's LinkedIn posts","description":"Returns paginated posts from the authenticated user's own LinkedIn profile. Requires valid LinkedIn credentials and a stored profileUrn (call /me/linkedin/refresh first if needed).","tags":["profile"],"security":[{"token":[]}],"requestBody":{"required":false,"content":{"application/json":{"example":{"count":20,"start":0},"schema":{"type":"object","properties":{"count":{"description":"Number of posts to fetch (default 20, max 100).","type":"integer","minimum":1,"maximum":100},"start":{"description":"Pagination offset (default 0).","type":"integer","minimum":0,"maximum":9007199254740991},"paginationToken":{"description":"Pagination token from a previous response to fetch the next page.","type":"string"}}}}}},"responses":{"200":{"description":"Paginated list of the user's own posts","content":{"application/json":{"example":{"success":true,"posts":[{"postUrl":"https://www.linkedin.com/posts/username_activity-1234567890","text":"My latest post content","date":1731547200000,"likesCount":50,"commentsCount":10,"sharesCount":5,"postUrn":"urn:li:activity:1234567890","postId":"1234567890","type":"activity"}],"count":1,"total":42,"start":0,"hasMore":true,"paginationToken":"abc123-pagination-token","creditsUsed":0,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"posts":{"type":"array","items":{"type":"object","properties":{"postUrl":{"type":"string","description":"Public URL of the post."},"text":{"type":"string","description":"Post text content."},"date":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Post creation timestamp (Unix milliseconds)."},"likesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total reactions on this post."},"commentsCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total top-level comments on this post."},"sharesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total shares/reposts of this post."},"postUrn":{"type":"string","description":"LinkedIn internal URN for this post. Use with engagement tools (like, comment, collect_likes/comments)."},"postId":{"type":"string","description":"Numeric post identifier parsed from the URN."},"type":{"type":"string","enum":["activity","ugcPost","share"],"description":"LinkedIn post type: 'ugcPost' = standard post, 'share' = native share/repost, 'activity' = legacy format."},"isRepost":{"description":"True when the post is a repost/reshare of another post. Absent for original posts.","type":"boolean"},"media":{"description":"Media attached to the post (image, video, document, or article). Absent when the post is text-only.","type":"object","properties":{"type":{"type":"string","enum":["image","video","document","article"],"description":"Type of media attached to the post."},"urls":{"type":"array","items":{"type":"string"},"description":"Media URLs (image URLs for carousels, video streaming URL, article link, etc.)."},"title":{"description":"Title of the article or document, when available.","type":"string"},"thumbnailUrl":{"description":"Thumbnail URL for videos, articles, or document covers.","type":"string"}},"required":["type","urls"],"additionalProperties":false}},"required":["postUrl","text","date","likesCount","commentsCount","sharesCount","postUrn","postId","type"],"additionalProperties":false}},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasMore":{"type":"boolean"},"paginationToken":{"nullable":true,"type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","posts","count","total","start","hasMore","paginationToken","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/me/linkedin/followers":{"post":{"x-bereach":{"agents":["orchestrator","lead_gen"]},"operationId":"getFollowers","x-speakeasy-name-override":"getFollowers","summary":"Get authenticated user's LinkedIn followers","description":"Returns a paginated list of the authenticated user's LinkedIn followers. Supports pagination. Requires valid LinkedIn credentials.","tags":["profile"],"security":[{"token":[]}],"requestBody":{"required":false,"content":{"application/json":{"example":{"start":0,"count":10},"schema":{"type":"object","properties":{"start":{"description":"Pagination offset (default 0).","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"description":"Number of followers to fetch per page (default 10, max 50).","type":"integer","minimum":1,"maximum":50}}}}}},"responses":{"200":{"description":"Paginated list of followers","content":{"application/json":{"example":{"success":true,"followers":[{"name":"Alex Doe","headline":"Growth Lead @ Example","profileUrl":"https://www.linkedin.com/in/alex-doe","profilePicture":"https://media.licdn.com/dms/image/v2/D4E03AQG1/profile-displayphoto-shrink_400_400/profile.jpg","followerCount":1250,"following":false,"publicIdentifier":"alex-doe","profileUrn":"urn:li:fsd_profile:ACoAAD5544332211"}],"count":1,"totalFollowers":3718,"start":0,"hasMore":true,"creditsUsed":0,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"followers":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"headline":{"nullable":true,"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"profilePicture":{"nullable":true,"type":"string"},"followerCount":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"following":{"type":"boolean","description":"Whether you follow this person back"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN (e.g. urn:li:fsd_profile:ACoAAA...) when available","type":"string"},"publicIdentifier":{"nullable":true,"description":"Vanity slug from profile URL (e.g. john-doe) when not URN-based","type":"string"}},"required":["name","headline","profileUrl","profilePicture","followerCount","following","profileUrn","publicIdentifier"],"additionalProperties":false}},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"totalFollowers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total reported by LinkedIn (capped at ~1000)"},"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasMore":{"type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","followers","count","totalFollowers","start","hasMore","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/me/limits":{"get":{"x-bereach":{"agents":["orchestrator","lead_gen","outreach"]},"operationId":"getLimits","x-speakeasy-name-override":"getLimits","summary":"Get current LinkedIn quota status","description":"Returns the current quota status for all LinkedIn action types. Includes current usage, effective quotas (with workspace multiplier applied), remaining capacity, minimum delay between actions in seconds, and next reset times.","tags":["profile"],"security":[{"token":[]}],"responses":{"200":{"description":"Rate limit status for all action types","content":{"application/json":{"example":{"success":true,"multiplier":1,"limits":{"connection_request":{"daily":{"current":5,"limit":50,"remaining":45},"weekly":null,"minIntervalSeconds":5,"nextResetDaily":"2026-02-24T00:00:00.000Z","nextResetWeekly":null},"message":{"daily":{"current":3,"limit":70,"remaining":67},"weekly":{"current":10,"limit":280,"remaining":270},"minIntervalSeconds":5,"nextResetDaily":"2026-02-24T00:00:00.000Z","nextResetWeekly":"2026-03-02T00:00:00.000Z"},"profile_visit":{"daily":{"current":0,"limit":300,"remaining":300},"weekly":{"current":0,"limit":1500,"remaining":1500},"minIntervalSeconds":2,"nextResetDaily":"2026-02-24T00:00:00.000Z","nextResetWeekly":"2026-03-02T00:00:00.000Z"},"scraping":{"daily":{"current":42,"limit":100,"remaining":58},"weekly":null,"minIntervalSeconds":2,"nextResetDaily":"2026-02-24T00:00:00.000Z","nextResetWeekly":null}},"creditsUsed":0,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"multiplier":{"type":"number","description":"Workspace limit multiplier applied to all base limits (default 1.0)"},"limits":{"type":"object","properties":{"connection_request":{"type":"object","properties":{"daily":{"nullable":true,"description":"Daily usage counter (resets at midnight UTC). Null if not configured for this action type.","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of actions used in this window"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Maximum allowed actions in this window (with multiplier applied)"},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Actions remaining before hitting the limit"}},"required":["current","limit","remaining"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Weekly usage counter (resets Monday 00:00 UTC). Null if no weekly cap for this action type.","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of actions used in this window"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Maximum allowed actions in this window (with multiplier applied)"},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Actions remaining before hitting the limit"}},"required":["current","limit","remaining"],"additionalProperties":false},"minIntervalSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minimum delay in seconds required between two consecutive actions of this type"},"nextResetDaily":{"nullable":true,"description":"ISO 8601 timestamp of the next daily counter reset. Null if not configured.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"nextResetWeekly":{"nullable":true,"description":"ISO 8601 timestamp of the next weekly counter reset. Null if no weekly cap.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["daily","weekly","minIntervalSeconds","nextResetDaily","nextResetWeekly"],"additionalProperties":false,"description":"Limits for sending LinkedIn connection requests"},"message":{"type":"object","properties":{"daily":{"nullable":true,"description":"Daily usage counter (resets at midnight UTC). Null if not configured for this action type.","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of actions used in this window"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Maximum allowed actions in this window (with multiplier applied)"},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Actions remaining before hitting the limit"}},"required":["current","limit","remaining"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Weekly usage counter (resets Monday 00:00 UTC). Null if no weekly cap for this action type.","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of actions used in this window"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Maximum allowed actions in this window (with multiplier applied)"},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Actions remaining before hitting the limit"}},"required":["current","limit","remaining"],"additionalProperties":false},"minIntervalSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minimum delay in seconds required between two consecutive actions of this type"},"nextResetDaily":{"nullable":true,"description":"ISO 8601 timestamp of the next daily counter reset. Null if not configured.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"nextResetWeekly":{"nullable":true,"description":"ISO 8601 timestamp of the next weekly counter reset. Null if no weekly cap.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["daily","weekly","minIntervalSeconds","nextResetDaily","nextResetWeekly"],"additionalProperties":false,"description":"Limits for sending DMs"},"profile_visit":{"type":"object","properties":{"daily":{"nullable":true,"description":"Daily usage counter (resets at midnight UTC). Null if not configured for this action type.","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of actions used in this window"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Maximum allowed actions in this window (with multiplier applied)"},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Actions remaining before hitting the limit"}},"required":["current","limit","remaining"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Weekly usage counter (resets Monday 00:00 UTC). Null if no weekly cap for this action type.","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of actions used in this window"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Maximum allowed actions in this window (with multiplier applied)"},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Actions remaining before hitting the limit"}},"required":["current","limit","remaining"],"additionalProperties":false},"minIntervalSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minimum delay in seconds required between two consecutive actions of this type"},"nextResetDaily":{"nullable":true,"description":"ISO 8601 timestamp of the next daily counter reset. Null if not configured.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"nextResetWeekly":{"nullable":true,"description":"ISO 8601 timestamp of the next weekly counter reset. Null if no weekly cap.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["daily","weekly","minIntervalSeconds","nextResetDaily","nextResetWeekly"],"additionalProperties":false,"description":"Limits for visiting LinkedIn profiles and company pages"},"scraping":{"type":"object","properties":{"daily":{"nullable":true,"description":"Daily usage counter (resets at midnight UTC). Null if not configured for this action type.","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of actions used in this window"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Maximum allowed actions in this window (with multiplier applied)"},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Actions remaining before hitting the limit"}},"required":["current","limit","remaining"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Weekly usage counter (resets Monday 00:00 UTC). Null if no weekly cap for this action type.","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of actions used in this window"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Maximum allowed actions in this window (with multiplier applied)"},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Actions remaining before hitting the limit"}},"required":["current","limit","remaining"],"additionalProperties":false},"minIntervalSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minimum delay in seconds required between two consecutive actions of this type"},"nextResetDaily":{"nullable":true,"description":"ISO 8601 timestamp of the next daily counter reset. Null if not configured.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"nextResetWeekly":{"nullable":true,"description":"ISO 8601 timestamp of the next weekly counter reset. Null if no weekly cap.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["daily","weekly","minIntervalSeconds","nextResetDaily","nextResetWeekly"],"additionalProperties":false,"description":"Limits for data collection: search, collecting posts/likes/comments, fetching followers, listing chats"},"post":{"description":"Limits for publishing LinkedIn posts","type":"object","properties":{"daily":{"nullable":true,"description":"Daily usage counter (resets at midnight UTC). Null if not configured for this action type.","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of actions used in this window"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Maximum allowed actions in this window (with multiplier applied)"},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Actions remaining before hitting the limit"}},"required":["current","limit","remaining"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Weekly usage counter (resets Monday 00:00 UTC). Null if no weekly cap for this action type.","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of actions used in this window"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Maximum allowed actions in this window (with multiplier applied)"},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Actions remaining before hitting the limit"}},"required":["current","limit","remaining"],"additionalProperties":false},"minIntervalSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minimum delay in seconds required between two consecutive actions of this type"},"nextResetDaily":{"nullable":true,"description":"ISO 8601 timestamp of the next daily counter reset. Null if not configured.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"nextResetWeekly":{"nullable":true,"description":"ISO 8601 timestamp of the next weekly counter reset. Null if no weekly cap.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["daily","weekly","minIntervalSeconds","nextResetDaily","nextResetWeekly"],"additionalProperties":false},"accept_invitation":{"description":"Limits for accepting connection invitations","type":"object","properties":{"daily":{"nullable":true,"description":"Daily usage counter (resets at midnight UTC). Null if not configured for this action type.","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of actions used in this window"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Maximum allowed actions in this window (with multiplier applied)"},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Actions remaining before hitting the limit"}},"required":["current","limit","remaining"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Weekly usage counter (resets Monday 00:00 UTC). Null if no weekly cap for this action type.","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of actions used in this window"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Maximum allowed actions in this window (with multiplier applied)"},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Actions remaining before hitting the limit"}},"required":["current","limit","remaining"],"additionalProperties":false},"minIntervalSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minimum delay in seconds required between two consecutive actions of this type"},"nextResetDaily":{"nullable":true,"description":"ISO 8601 timestamp of the next daily counter reset. Null if not configured.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"nextResetWeekly":{"nullable":true,"description":"ISO 8601 timestamp of the next weekly counter reset. Null if no weekly cap.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["daily","weekly","minIntervalSeconds","nextResetDaily","nextResetWeekly"],"additionalProperties":false},"comment_post":{"description":"Limits for commenting on posts","type":"object","properties":{"daily":{"nullable":true,"description":"Daily usage counter (resets at midnight UTC). Null if not configured for this action type.","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of actions used in this window"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Maximum allowed actions in this window (with multiplier applied)"},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Actions remaining before hitting the limit"}},"required":["current","limit","remaining"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Weekly usage counter (resets Monday 00:00 UTC). Null if no weekly cap for this action type.","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of actions used in this window"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Maximum allowed actions in this window (with multiplier applied)"},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Actions remaining before hitting the limit"}},"required":["current","limit","remaining"],"additionalProperties":false},"minIntervalSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minimum delay in seconds required between two consecutive actions of this type"},"nextResetDaily":{"nullable":true,"description":"ISO 8601 timestamp of the next daily counter reset. Null if not configured.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"nextResetWeekly":{"nullable":true,"description":"ISO 8601 timestamp of the next weekly counter reset. Null if no weekly cap.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["daily","weekly","minIntervalSeconds","nextResetDaily","nextResetWeekly"],"additionalProperties":false},"reply_comment":{"description":"Limits for replying to comments","type":"object","properties":{"daily":{"nullable":true,"description":"Daily usage counter (resets at midnight UTC). Null if not configured for this action type.","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of actions used in this window"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Maximum allowed actions in this window (with multiplier applied)"},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Actions remaining before hitting the limit"}},"required":["current","limit","remaining"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Weekly usage counter (resets Monday 00:00 UTC). Null if no weekly cap for this action type.","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of actions used in this window"},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Maximum allowed actions in this window (with multiplier applied)"},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Actions remaining before hitting the limit"}},"required":["current","limit","remaining"],"additionalProperties":false},"minIntervalSeconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minimum delay in seconds required between two consecutive actions of this type"},"nextResetDaily":{"nullable":true,"description":"ISO 8601 timestamp of the next daily counter reset. Null if not configured.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"nextResetWeekly":{"nullable":true,"description":"ISO 8601 timestamp of the next weekly counter reset. Null if no weekly cap.","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}},"required":["daily","weekly","minIntervalSeconds","nextResetDaily","nextResetWeekly"],"additionalProperties":false}},"required":["connection_request","message","profile_visit","scraping"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","multiplier","limits","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/me/credits":{"get":{"x-bereach":{"agents":["orchestrator","lead_gen","outreach"]},"operationId":"getCredits","x-speakeasy-name-override":"getCredits","summary":"Get current BeReach credit balance","description":"Returns the current credit balance for the workspace. Includes credits used, total limit, remaining credits, usage percentage, and whether credits are unlimited. When isUnlimited is true, limit and remaining are null — skip credit budgeting.","tags":["profile"],"security":[{"token":[]}],"responses":{"200":{"description":"Credit balance for the workspace","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"credits":{"type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of credits used in the current billing period"},"limit":{"nullable":true,"description":"Maximum credits available for the workspace, or null if unlimited","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"remaining":{"nullable":true,"description":"Credits remaining before hitting the limit, or null if unlimited","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"percentage":{"type":"number","description":"Percentage of credits used (0-100, capped at 100, rounded to 2 decimal places). 0 when unlimited"},"isUnlimited":{"type":"boolean","description":"Whether the workspace has unlimited credits (Pro plan). When true, limit and remaining are null"}},"required":["current","limit","remaining","percentage","isUnlimited"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","credits","creditsUsed","retryAfter"],"additionalProperties":false},"examples":{"free":{"summary":"Free plan (limited credits)","value":{"success":true,"credits":{"current":142,"limit":600,"remaining":458,"percentage":23.67,"isUnlimited":false},"creditsUsed":0,"retryAfter":0}},"unlimited":{"summary":"Pro plan (unlimited credits)","value":{"success":true,"credits":{"current":87,"limit":null,"remaining":null,"percentage":0,"isUnlimited":true},"creditsUsed":0,"retryAfter":0}}}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin":{"post":{"x-bereach":{"agents":["orchestrator","outreach"]},"operationId":"inboxList","x-speakeasy-name-override":"listInbox","summary":"List LinkedIn inbox conversations","description":"List inbox conversations for the authenticated user. Returns conversations with participants, last message, and read status. Use `count` to control the number of conversations returned (1-40, default 20). Paginate via nextCursor.","tags":["chat"],"security":[{"token":[]}],"requestBody":{"required":false,"content":{"application/json":{"example":{"count":10},"schema":{"type":"object","properties":{"nextCursor":{"description":"Pagination cursor from a previous response","type":"string"},"count":{"description":"Number of conversations to return (default 20, max 40)","type":"integer","minimum":1,"maximum":40}}}}}},"responses":{"200":{"description":"Inbox conversations","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"conversations":{"type":"array","items":{"type":"object","properties":{"conversationUrn":{"type":"string"},"conversationUrl":{"type":"string"},"lastActivityAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"read":{"type":"boolean"},"unreadCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"groupChat":{"type":"boolean"},"participants":{"type":"array","items":{"type":"object","properties":{"profileUrn":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"profilePicture":{"nullable":true,"type":"string"},"publicIdentifier":{"nullable":true,"type":"string"}},"required":["profileUrn","firstName","lastName","profileUrl","headline","profilePicture","publicIdentifier"],"additionalProperties":false}},"lastMessage":{"nullable":true,"type":"object","properties":{"text":{"nullable":true,"type":"string"},"deliveredAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"senderProfileUrn":{"type":"string"}},"required":["text","deliveredAt","senderProfileUrn"],"additionalProperties":false}},"required":["conversationUrn","conversationUrl","lastActivityAt","createdAt","read","unreadCount","groupChat","participants","lastMessage"],"additionalProperties":false}},"nextCursor":{"nullable":true,"description":"Cursor for fetching next page","type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","conversations","nextCursor","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin/search":{"get":{"x-bereach":{"agents":["outreach"]},"operationId":"inboxSearch","x-speakeasy-name-override":"searchConversations","summary":"Search LinkedIn conversations","description":"Search inbox conversations by keyword via query parameters. Returns matching conversations with participants and last message. Example: GET /chats/linkedin/search?keywords=project","tags":["chat"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"keywords","schema":{"type":"string","minLength":1,"description":"Search keywords"},"required":true,"description":"Search keywords"},{"in":"query","name":"nextCursor","schema":{"description":"Pagination cursor from a previous response","type":"string"},"description":"Pagination cursor from a previous response"}],"responses":{"200":{"description":"Matching conversations","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"conversations":{"type":"array","items":{"type":"object","properties":{"conversationUrn":{"type":"string"},"conversationUrl":{"type":"string"},"lastActivityAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"read":{"type":"boolean"},"unreadCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"groupChat":{"type":"boolean"},"participants":{"type":"array","items":{"type":"object","properties":{"profileUrn":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"profilePicture":{"nullable":true,"type":"string"},"publicIdentifier":{"nullable":true,"type":"string"}},"required":["profileUrn","firstName","lastName","profileUrl","headline","profilePicture","publicIdentifier"],"additionalProperties":false}},"lastMessage":{"nullable":true,"type":"object","properties":{"text":{"nullable":true,"type":"string"},"deliveredAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"senderProfileUrn":{"type":"string"}},"required":["text","deliveredAt","senderProfileUrn"],"additionalProperties":false}},"required":["conversationUrn","conversationUrl","lastActivityAt","createdAt","read","unreadCount","groupChat","participants","lastMessage"],"additionalProperties":false}},"nextCursor":{"nullable":true,"description":"Cursor for fetching next page","type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","conversations","nextCursor","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin/find":{"post":{"x-bereach":{"agents":["orchestrator","lead_gen","outreach"]},"operationId":"findConversation","x-speakeasy-name-override":"findConversation","summary":"Find a conversation with a specific person","description":"Find a conversation with a specific person by profile URL or URN. Optionally returns messages from the found conversation (`includeMessages: true`). When following up on a previously listed conversation, extract the profile URL or URN from the earlier result and pass it here — do NOT ask the user to re-type the name.","tags":["chat"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"profile":"https://linkedin.com/in/marie-sandre","includeMessages":true},"schema":{"type":"object","properties":{"profile":{"type":"string","minLength":1,"description":"Accepts full profile URLs, vanity names (e.g. marie-sandre), or profile URNs."},"includeMessages":{"description":"If true, also return the conversation's recent messages.","type":"boolean"}},"required":["profile"]}}}},"responses":{"200":{"description":"Conversation found (or not)","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"found":{"type":"boolean"},"conversation":{"nullable":true,"description":"Lightweight conversation reference (O(1) lookup returns URN only, not full details).","type":"object","properties":{"conversationUrn":{"type":"string"}},"required":["conversationUrn"],"additionalProperties":false},"messages":{"nullable":true,"type":"array","items":{"type":"object","properties":{"messageUrn":{"type":"string"},"text":{"nullable":true,"type":"string"},"deliveredAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"senderProfileUrn":{"type":"string"},"sender":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"profilePicture":{"nullable":true,"type":"string"},"publicIdentifier":{"nullable":true,"type":"string"},"profileUrn":{"nullable":true,"type":"string"}},"required":["firstName","lastName","profileUrl","headline","profilePicture","publicIdentifier","profileUrn"],"additionalProperties":false},"attachments":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["audio","shared_post","replied_message","image","file","unknown"]},"audioUrl":{"type":"string"},"audioDuration":{"type":"number"},"hostUrn":{"type":"string"},"repliedText":{"type":"string"},"repliedSenderName":{"type":"string"},"imageUrl":{"type":"string"},"fileName":{"type":"string"},"fileUrl":{"type":"string"}},"required":["type"],"additionalProperties":false}},"isOutbound":{"type":"boolean","description":"True if the authenticated user sent this message."}},"required":["messageUrn","text","deliveredAt","senderProfileUrn","sender","attachments","isOutbound"],"additionalProperties":false}},"prevCursor":{"description":"deliveredAt timestamp (ms) of the oldest message — pass as 'deliveredAt' to load older messages. Only present when includeMessages is true.","nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"userProfileUrn":{"description":"The authenticated user's profile URN. Useful for determining message direction.","type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","found","conversation","messages","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin/messages":{"get":{"x-bereach":{"agents":["orchestrator","outreach"]},"operationId":"inboxMessages","x-speakeasy-name-override":"getMessages","summary":"Read messages from a conversation","description":"Fetch messages from a specific LinkedIn conversation.\n\nPass the full `conversationUrn` as a query parameter, as returned by `/chats/linkedin` or `/chats/linkedin/search`. No parsing required — the server handles extraction internally.\n\nExample: `GET /chats/linkedin/messages?conversationUrn=urn:li:msg_conversation:(urn:li:fsd_profile:ACoAAXXX,2-YWUx...)`","tags":["chat"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"conversationUrn","schema":{"type":"string","minLength":1,"description":"Full conversation URN as returned by /chats/linkedin (e.g. 'urn:li:msg_conversation:(urn:li:fsd_profile:ACoAAXXX,2-YWUx...)')"},"required":true,"description":"Full conversation URN as returned by /chats/linkedin (e.g. 'urn:li:msg_conversation:(urn:li:fsd_profile:ACoAAXXX,2-YWUx...)')"},{"in":"query","name":"deliveredAt","schema":{"description":"Timestamp (ms) of the oldest message from previous page — pass this to load older messages","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"description":"Timestamp (ms) of the oldest message from previous page — pass this to load older messages"}],"responses":{"200":{"description":"Conversation messages","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"messages":{"type":"array","items":{"type":"object","properties":{"messageUrn":{"type":"string"},"text":{"nullable":true,"type":"string"},"deliveredAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"senderProfileUrn":{"type":"string"},"sender":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"profilePicture":{"nullable":true,"type":"string"},"publicIdentifier":{"nullable":true,"type":"string"},"profileUrn":{"nullable":true,"type":"string"}},"required":["firstName","lastName","profileUrl","headline","profilePicture","publicIdentifier","profileUrn"],"additionalProperties":false},"attachments":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["audio","shared_post","replied_message","image","file","unknown"]},"audioUrl":{"type":"string"},"audioDuration":{"type":"number"},"hostUrn":{"type":"string"},"repliedText":{"type":"string"},"repliedSenderName":{"type":"string"},"imageUrl":{"type":"string"},"fileName":{"type":"string"},"fileUrl":{"type":"string"}},"required":["type"],"additionalProperties":false}},"isOutbound":{"type":"boolean","description":"True if the authenticated user sent this message."}},"required":["messageUrn","text","deliveredAt","senderProfileUrn","sender","attachments","isOutbound"],"additionalProperties":false}},"prevCursor":{"nullable":true,"description":"deliveredAt timestamp (ms) of the oldest message — pass as 'deliveredAt' to load older messages. Null when no more messages.","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","messages","prevCursor","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin/mark-seen":{"post":{"x-bereach":{"cost":"paced-free","agents":["outreach"]},"operationId":"markSeen","x-speakeasy-name-override":"markSeen","summary":"Mark a conversation as read","description":"Mark a LinkedIn conversation as read/seen.","tags":["chat"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"conversationUrn":"urn:li:msg_conversation:(urn:li:fsd_profile:ACoAAXXX,2-YWUx...)"},"schema":{"type":"object","properties":{"conversationUrn":{"type":"string","minLength":1,"description":"Full conversation URN (e.g. 'urn:li:msg_conversation:(urn:li:fsd_profile:ACoAAXXX,2-YWUx...)')"}},"required":["conversationUrn"]}}}},"responses":{"200":{"description":"Conversation marked as read","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin/mark-all-read":{"post":{"x-bereach":{"cost":"paced-free","agents":["outreach"]},"operationId":"markAllRead","x-speakeasy-name-override":"markAllRead","summary":"Mark all conversations as read","description":"Mark all LinkedIn inbox conversations as read.","tags":["chat"],"security":[{"token":[]}],"requestBody":{"required":false,"content":{"application/json":{"example":{},"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"All conversations marked as read","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin/star":{"post":{"x-bereach":{"cost":"paced-free","agents":["outreach"]},"operationId":"starConversation","x-speakeasy-name-override":"star","summary":"Star a conversation","description":"Star/favorite a LinkedIn conversation.","tags":["chat"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"conversationUrn":"urn:li:msg_conversation:(urn:li:fsd_profile:ACoAAXXX,2-YWUx...)"},"schema":{"type":"object","properties":{"conversationUrn":{"type":"string","minLength":1,"description":"Full conversation URN"}},"required":["conversationUrn"]}}}},"responses":{"200":{"description":"Conversation starred","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin/unstar":{"post":{"x-bereach":{"cost":"paced-free","agents":["outreach"]},"operationId":"unstarConversation","x-speakeasy-name-override":"unstar","summary":"Unstar a conversation","description":"Remove star from a LinkedIn conversation.","tags":["chat"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"conversationUrn":"urn:li:msg_conversation:(urn:li:fsd_profile:ACoAAXXX,2-YWUx...)"},"schema":{"type":"object","properties":{"conversationUrn":{"type":"string","minLength":1,"description":"Full conversation URN"}},"required":["conversationUrn"]}}}},"responses":{"200":{"description":"Conversation unstarred","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin/starred":{"get":{"x-bereach":{"agents":["outreach"]},"operationId":"inboxStarred","x-speakeasy-name-override":"listStarred","summary":"List starred conversations","description":"List starred/favorited LinkedIn conversations. GET with optional nextCursor query parameter.","tags":["chat"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"nextCursor","schema":{"description":"Pagination cursor from a previous response","type":"string"},"description":"Pagination cursor from a previous response"}],"responses":{"200":{"description":"Starred conversations","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"conversations":{"type":"array","items":{"type":"object","properties":{"conversationUrn":{"type":"string"},"conversationUrl":{"type":"string"},"lastActivityAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"read":{"type":"boolean"},"unreadCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"groupChat":{"type":"boolean"},"participants":{"type":"array","items":{"type":"object","properties":{"profileUrn":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"profilePicture":{"nullable":true,"type":"string"},"publicIdentifier":{"nullable":true,"type":"string"}},"required":["profileUrn","firstName","lastName","profileUrl","headline","profilePicture","publicIdentifier"],"additionalProperties":false}},"lastMessage":{"nullable":true,"type":"object","properties":{"text":{"nullable":true,"type":"string"},"deliveredAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"senderProfileUrn":{"type":"string"}},"required":["text","deliveredAt","senderProfileUrn"],"additionalProperties":false}},"required":["conversationUrn","conversationUrl","lastActivityAt","createdAt","read","unreadCount","groupChat","participants","lastMessage"],"additionalProperties":false}},"nextCursor":{"nullable":true,"description":"Cursor for fetching next page","type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","conversations","nextCursor","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin/archive":{"post":{"x-bereach":{"cost":"paced-free","agents":["outreach"]},"operationId":"archiveConversation","x-speakeasy-name-override":"archive","summary":"Archive a conversation","description":"Move a LinkedIn conversation to the archive.","tags":["chat"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"conversationUrn":"urn:li:msg_conversation:(urn:li:fsd_profile:ACoAAXXX,2-YWUx...)"},"schema":{"type":"object","properties":{"conversationUrn":{"type":"string","minLength":1,"description":"Full conversation URN"}},"required":["conversationUrn"]}}}},"responses":{"200":{"description":"Conversation archived","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin/unarchive":{"post":{"x-bereach":{"cost":"paced-free","agents":["outreach"]},"operationId":"unarchiveConversation","x-speakeasy-name-override":"unarchive","summary":"Unarchive a conversation","description":"Move a LinkedIn conversation back from archive to inbox.","tags":["chat"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"conversationUrn":"urn:li:msg_conversation:(urn:li:fsd_profile:ACoAAXXX,2-YWUx...)"},"schema":{"type":"object","properties":{"conversationUrn":{"type":"string","minLength":1,"description":"Full conversation URN"}},"required":["conversationUrn"]}}}},"responses":{"200":{"description":"Conversation unarchived","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin/archived":{"get":{"x-bereach":{"agents":["outreach"]},"operationId":"inboxArchived","x-speakeasy-name-override":"listArchived","summary":"List archived conversations","description":"List archived LinkedIn conversations. GET with optional nextCursor query parameter.","tags":["chat"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"nextCursor","schema":{"description":"Pagination cursor from a previous response","type":"string"},"description":"Pagination cursor from a previous response"}],"responses":{"200":{"description":"Archived conversations","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"conversations":{"type":"array","items":{"type":"object","properties":{"conversationUrn":{"type":"string"},"conversationUrl":{"type":"string"},"lastActivityAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"read":{"type":"boolean"},"unreadCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"groupChat":{"type":"boolean"},"participants":{"type":"array","items":{"type":"object","properties":{"profileUrn":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"profilePicture":{"nullable":true,"type":"string"},"publicIdentifier":{"nullable":true,"type":"string"}},"required":["profileUrn","firstName","lastName","profileUrl","headline","profilePicture","publicIdentifier"],"additionalProperties":false}},"lastMessage":{"nullable":true,"type":"object","properties":{"text":{"nullable":true,"type":"string"},"deliveredAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"senderProfileUrn":{"type":"string"}},"required":["text","deliveredAt","senderProfileUrn"],"additionalProperties":false}},"required":["conversationUrn","conversationUrl","lastActivityAt","createdAt","read","unreadCount","groupChat","participants","lastMessage"],"additionalProperties":false}},"nextCursor":{"nullable":true,"description":"Cursor for fetching next page","type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","conversations","nextCursor","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin/react":{"post":{"x-bereach":{"cost":"paced-free","agents":["outreach"]},"operationId":"reactMessage","x-speakeasy-name-override":"react","summary":"React to a message with emoji","description":"Add an emoji reaction to a LinkedIn message.","tags":["chat"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"messageUrn":"urn:li:msg_message:(urn:li:fsd_profile:ACoAAXXX,2-MTcw...)","emoji":"👍","conversationUrn":"urn:li:msg_conversation:(urn:li:fsd_profile:ACoAAXXX,2-YWUx...)"},"schema":{"type":"object","properties":{"messageUrn":{"type":"string","minLength":1,"description":"Full message URN (e.g. 'urn:li:msg_message:(urn:li:fsd_profile:ACoAAXXX,2-MTcw...)')"},"emoji":{"type":"string","minLength":1,"description":"Emoji character to react with (e.g. '👍', '❤️', '😂')"},"conversationUrn":{"type":"string","minLength":1,"description":"Conversation URN for the thread to react in."}},"required":["messageUrn","emoji","conversationUrn"]}}}},"responses":{"200":{"description":"Reaction added","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin/unreact":{"post":{"x-bereach":{"cost":"paced-free","agents":["outreach"]},"operationId":"unreactMessage","x-speakeasy-name-override":"unreact","summary":"Remove emoji reaction from a message","description":"Remove an emoji reaction from a LinkedIn message.","tags":["chat"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"messageUrn":"urn:li:msg_message:(urn:li:fsd_profile:ACoAAXXX,2-MTcw...)","emoji":"👍","conversationUrn":"urn:li:msg_conversation:(urn:li:fsd_profile:ACoAAXXX,2-YWUx...)"},"schema":{"type":"object","properties":{"messageUrn":{"type":"string","minLength":1,"description":"Full message URN (e.g. 'urn:li:msg_message:(urn:li:fsd_profile:ACoAAXXX,2-MTcw...)')"},"emoji":{"type":"string","minLength":1,"description":"Emoji character to react with (e.g. '👍', '❤️', '😂')"},"conversationUrn":{"type":"string","minLength":1,"description":"Conversation URN for the thread to react in."}},"required":["messageUrn","emoji","conversationUrn"]}}}},"responses":{"200":{"description":"Reaction removed","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin/typing":{"post":{"x-bereach":{"cost":"paced-free","agents":["outreach"]},"operationId":"typingIndicator","x-speakeasy-name-override":"sendTypingIndicator","summary":"Send typing indicator","description":"Send a typing indicator to a LinkedIn conversation, simulating natural typing behavior.","tags":["chat"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"conversationUrn":"urn:li:msg_conversation:(urn:li:fsd_profile:ACoAAXXX,2-YWUx...)"},"schema":{"type":"object","properties":{"conversationUrn":{"type":"string","minLength":1,"description":"Full conversation URN"}},"required":["conversationUrn"]}}}},"responses":{"200":{"description":"Typing indicator sent","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin/unread":{"get":{"x-bereach":{"cost":"read","agents":["outreach"]},"operationId":"inboxUnreadCount","x-speakeasy-name-override":"getUnreadCount","summary":"Get unread message count","description":"Get the number of unread LinkedIn messages/conversations.","tags":["chat"],"security":[{"token":[]}],"responses":{"200":{"description":"Unread count","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"unreadCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of unread conversations/messages"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","unreadCount","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chats/linkedin/summary":{"get":{"x-bereach":{"agents":["outreach"]},"operationId":"getConversationSummary","x-speakeasy-name-override":"getConversationSummary","summary":"Get conversation summary for a contact","description":"Retrieve the saved conversation summary for a contact. Returns null if no summary exists or contact not found.","tags":["chat"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"profile","schema":{"type":"string","minLength":1,"description":"LinkedIn profile URL or vanity name of the contact"},"required":true,"description":"LinkedIn profile URL or vanity name of the contact"}],"responses":{"200":{"description":"Summary retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"found":{"type":"boolean","description":"Whether a contact with a saved summary was found"},"contactId":{"description":"Internal contact ID — present only when found is true","type":"string"},"summary":{"nullable":true,"description":"The saved conversation summary text, null if none exists","type":"string"},"summarizedAt":{"description":"ISO timestamp of when the summary was last saved — present only when found is true","nullable":true,"type":"string"},"messageCount":{"description":"Message count at the time of summarization — present only when found is true","nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"conversationUpdatedAt":{"description":"Timestamp of last conversation data update — present only when found is true","nullable":true,"type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","found","summary","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"put":{"x-bereach":{"agents":["outreach"]},"operationId":"saveConversationSummary","x-speakeasy-name-override":"saveConversationSummary","summary":"Save conversation summary for a contact","description":"Save a conversation summary for a contact. Creates the contact if it doesn't exist (auto-upsert by profile URL).","tags":["chat"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"profile":"https://www.linkedin.com/in/john-doe","summary":"Discussed partnership opportunities..."},"schema":{"type":"object","properties":{"profile":{"type":"string","minLength":1,"description":"LinkedIn profile URL or vanity name of the contact"},"summary":{"type":"string","minLength":1,"maxLength":10000,"description":"Conversation summary text to save"}},"required":["profile","summary"]}}}},"responses":{"200":{"description":"Summary saved","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"contactId":{"type":"string","description":"Internal contact ID (created if not found)"},"summarizedAt":{"type":"string","description":"ISO timestamp of when the summary was saved"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","contactId","summarizedAt","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/campaigns/{campaignSlug}/filter":{"get":{"x-bereach":{"excludeTool":true},"operationId":"filterCampaign","x-speakeasy-name-override":"filter","summary":"Check if campaign actions are completed","description":"Check if all provided actionSlugs are completed for a given campaignSlug. Used by n8n workflows to determine if a flow should be skipped.","tags":["campaigns"],"security":[{"token":[]}],"deprecated":true,"parameters":[{"name":"campaignSlug","in":"path","required":true,"description":"Unique identifier for the automation campaign (e.g., 'lead-magnet-post-12345', 'outreach-webinar-feb')","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$"}},{"name":"actionSlugs","in":"query","required":true,"description":"Comma-separated list of action slugs to check (e.g., 'send-mp-john-doe,like-comment-abc123')","schema":{"type":"string"}}],"responses":{"200":{"description":"Filter status with checked slugs","content":{"application/json":{"example":{"filtered":false,"checkedSlugs":[{"actionSlug":"send-mp-john-doe","completed":true},{"actionSlug":"like-comment-abc123","completed":false},{"actionSlug":"reply-to-xyz456","completed":true}],"creditsUsed":0,"retryAfter":0},"schema":{"type":"object","properties":{"filtered":{"type":"boolean","description":"True if all actionSlugs have been completed for this campaign, meaning the entire flow can be skipped"},"checkedSlugs":{"type":"array","items":{"type":"object","properties":{"actionSlug":{"type":"string"},"completed":{"type":"boolean"}},"required":["actionSlug","completed"],"additionalProperties":false},"description":"Status of each action slug — completed means the action was already executed for this campaign"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for campaign queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for campaign queries)."}},"required":["filtered","checkedSlugs","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/campaigns/{campaignSlug}/status":{"post":{"x-bereach":{"agents":["orchestrator"]},"operationId":"campaignStatus","x-speakeasy-name-override":"getStatus","summary":"Query per-profile action status within a campaign","description":"Returns which actions (message, reply, like, visit, connect) have been completed for each profile within a campaign. Replaces the slug-based filter endpoint — query by profile URLs instead of building slug lists.","tags":["campaigns"],"security":[{"token":[]}],"parameters":[{"name":"campaignSlug","in":"path","required":true,"description":"Campaign identifier","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"example":{"profiles":["https://www.linkedin.com/in/john-doe","https://www.linkedin.com/in/jane-smith"]},"schema":{"type":"object","properties":{"profiles":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string"},"description":"LinkedIn profile URLs or URNs to check status for within this campaign."}},"required":["profiles"]}}}},"responses":{"200":{"description":"Per-profile action completion status","content":{"application/json":{"example":{"success":true,"profiles":[{"profile":"https://www.linkedin.com/in/john-doe","message":true,"reply":true,"like":true,"visit":true,"connect":true},{"profile":"https://www.linkedin.com/in/jane-smith","message":false,"reply":false,"like":false,"visit":false,"connect":false}],"creditsUsed":0,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"profiles":{"type":"array","items":{"type":"object","properties":{"profile":{"type":"string"},"message":{"type":"boolean"},"reply":{"type":"boolean"},"like":{"type":"boolean"},"visit":{"type":"boolean"},"connect":{"type":"boolean"}},"required":["profile","message","reply","like","visit","connect"],"additionalProperties":false}},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for campaign queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for campaign queries)."}},"required":["success","profiles","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/campaigns/{campaignSlug}/sync":{"post":{"operationId":"campaignSync","x-speakeasy-name-override":"sync","summary":"Mark actions as completed without performing them","description":"Manually mark actions as completed for profiles within a campaign. Use when actions were performed outside the API (e.g. manual DMs) and need to be synced.","tags":["campaigns"],"security":[{"token":[]}],"parameters":[{"name":"campaignSlug","in":"path","required":true,"description":"Campaign identifier","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"example":{"profiles":[{"profile":"https://www.linkedin.com/in/john-doe","actions":["message","reply"]}]},"schema":{"type":"object","properties":{"profiles":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"object","properties":{"profile":{"type":"string","description":"LinkedIn profile URL or URN"},"actions":{"minItems":1,"type":"array","items":{"type":"string","enum":["message","reply","like","visit","connect"]},"description":"Action types to mark as completed"}},"required":["profile","actions"]},"description":"Profiles and actions to mark as completed without performing them on LinkedIn."}},"required":["profiles"]}}}},"responses":{"200":{"description":"Actions marked as completed","content":{"application/json":{"example":{"success":true,"synced":[{"profile":"https://www.linkedin.com/in/john-doe","actions":{"message":true,"reply":true}}],"creditsUsed":0,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"synced":{"type":"array","items":{"type":"object","properties":{"profile":{"type":"string"},"actions":{"type":"object","additionalProperties":{"type":"boolean"},"required":["message","reply","like","visit","connect"]}},"required":["profile","actions"],"additionalProperties":false}},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for campaign queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for campaign queries)."}},"required":["success","synced","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/campaigns/{campaignSlug}/stats":{"get":{"x-bereach":{"agents":["orchestrator"]},"operationId":"campaignStats","x-speakeasy-name-override":"stats","summary":"Get aggregate campaign statistics","description":"Returns per-action counts, unique profile count, and total credits used for a campaign.","tags":["campaigns"],"security":[{"token":[]}],"parameters":[{"name":"campaignSlug","in":"path","required":true,"description":"Campaign identifier","schema":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$"}}],"responses":{"200":{"description":"Aggregate campaign statistics","content":{"application/json":{"example":{"success":true,"stats":{"message":45,"reply":120,"like":130,"visit":200,"connect":5},"totalProfiles":210,"creditsUsed":500,"retryAfter":0},"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"stats":{"type":"object","additionalProperties":{"type":"number"},"description":"Per-action-type counts (e.g. message: 45, reply: 120)"},"totalProfiles":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Unique profiles processed in this campaign"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total credits consumed by this campaign (sum of action counts). Also serves as the per-call creditsUsed (always 0 for this endpoint)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for campaign queries)."}},"required":["success","stats","totalProfiles","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/decline/linkedin/invitation":{"post":{"x-bereach":{"cost":"write","agents":["outreach"]},"operationId":"declineInvitation","x-speakeasy-name-override":"declineInvitation","summary":"Decline a connection invitation","description":"Decline a pending LinkedIn connection invitation. Both invitationId and sharedSecret are required (obtained from the list invitations endpoint).","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"invitationId":"7431723100481851393","sharedSecret":"abc123"},"schema":{"type":"object","properties":{"invitationId":{"type":"string","minLength":1,"description":"Invitation ID from the list invitations endpoint"},"sharedSecret":{"type":"string","minLength":1,"description":"Shared secret / validation token from the list invitations endpoint"},"senderProfileId":{"description":"Sender's profile ID (optional, improves accuracy)","type":"string"}},"required":["invitationId","sharedSecret"]}}}},"responses":{"200":{"description":"Invitation declined","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"message":{"type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","message","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/invitations/linkedin/sent":{"post":{"x-bereach":{"cost":"read"},"operationId":"listSentInvitations","x-speakeasy-name-override":"listSentInvitations","summary":"List sent connection invitations","description":"List sent (pending) LinkedIn connection invitations.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"start":0,"count":10},"schema":{"type":"object","properties":{"start":{"default":0,"description":"Pagination offset","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"default":10,"description":"Number of invitations to return","type":"integer","minimum":1,"maximum":100}}}}}},"responses":{"200":{"description":"Sent invitations","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"invitations":{"type":"array","items":{"type":"object","properties":{"invitationId":{"type":"string"},"invitationUrn":{"type":"string"},"entityUrn":{"type":"string"},"sentAt":{"nullable":true,"type":"string"},"message":{"nullable":true,"type":"string"},"targetProfileId":{"nullable":true,"type":"string"},"targetFirstName":{"nullable":true,"type":"string"},"targetLastName":{"nullable":true,"type":"string"},"toMember":{"nullable":true,"type":"object","properties":{"name":{"type":"string"},"headline":{"nullable":true,"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"profilePicture":{"nullable":true,"type":"string"},"publicIdentifier":{"nullable":true,"type":"string"},"profileUrn":{"nullable":true,"type":"string"}},"required":["name","headline","profileUrl","profilePicture","publicIdentifier","profileUrn"],"additionalProperties":false}},"required":["invitationId","invitationUrn","entityUrn","sentAt","message","targetProfileId","targetFirstName","targetLastName","toMember"],"additionalProperties":false}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","invitations","total","start","count","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/withdraw/linkedin/invitation":{"post":{"x-bereach":{"cost":"write","agents":["outreach"]},"operationId":"withdrawInvitation","x-speakeasy-name-override":"withdrawInvitation","summary":"Withdraw a sent connection invitation","description":"Withdraw a pending sent connection invitation. Only works for CONNECTION type invitations. Returns bad_request if invitation not found, already withdrawn, or accepted. Returns bad_request if invitation expired.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"invitationUrn":"urn:li:fs_relInvitation:7431723100481851393"},"schema":{"type":"object","properties":{"invitationUrn":{"type":"string","minLength":1,"description":"Full invitation URN (e.g. urn:li:fs_relInvitation:123) or numeric invitation ID"}},"required":["invitationUrn"]}}}},"responses":{"200":{"description":"Invitation withdrawn","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"message":{"type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","message","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/follow/linkedin/profile":{"post":{"x-bereach":{"cost":"write","agents":["orchestrator","outreach"],"guards":["profileTargeting"]},"operationId":"followProfile","x-speakeasy-name-override":"followProfile","summary":"Follow a profile","description":"Follow a LinkedIn profile without connecting. Accepts profile URL (linkedin.com/in/username), full URN, or vanity name.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"profile":"https://www.linkedin.com/in/username"},"schema":{"type":"object","properties":{"profile":{"type":"string","minLength":1,"description":"Accepts full LinkedIn profile URLs (e.g. linkedin.com/in/username), vanity names (e.g. john-doe), or profile URNs (e.g. urn:li:fsd_profile:ACoAAA...)."}},"required":["profile"]}}}},"responses":{"200":{"description":"Profile followed","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"message":{"type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","message","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/unfollow/linkedin/profile":{"post":{"x-bereach":{"cost":"write","agents":["outreach"]},"operationId":"unfollowProfile","x-speakeasy-name-override":"unfollowProfile","summary":"Unfollow a profile","description":"Unfollow a LinkedIn profile. Same input formats as follow.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"profile":"https://www.linkedin.com/in/username"},"schema":{"type":"object","properties":{"profile":{"type":"string","minLength":1,"description":"Accepts full LinkedIn profile URLs (e.g. linkedin.com/in/username), vanity names (e.g. john-doe), or profile URNs (e.g. urn:li:fsd_profile:ACoAAA...)."}},"required":["profile"]}}}},"responses":{"200":{"description":"Profile unfollowed","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"message":{"type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","message","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/edit/linkedin/post":{"post":{"x-bereach":{"cost":"write"},"operationId":"editPost","x-speakeasy-name-override":"editPost","summary":"Edit a post","description":"Edit the text content of an existing LinkedIn post. Only text can be changed; media, visibility, and other properties are preserved. Requires resolving the shareUrn from the activityUrn. Only works for posts in the user's recent feed. Returns bad_request if shareUrn cannot be resolved.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"postUrl":"https://www.linkedin.com/feed/update/urn:li:activity:123","text":"Updated post text"},"schema":{"type":"object","properties":{"postUrl":{"type":"string","minLength":1,"description":"LinkedIn post URL or URN"},"text":{"type":"string","minLength":1,"description":"New text content for the post"}},"required":["postUrl","text"]}}}},"responses":{"200":{"description":"Post edited","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/edit/linkedin/comment":{"post":{"x-bereach":{"cost":"write"},"operationId":"editComment","x-speakeasy-name-override":"editComment","summary":"Edit a comment","description":"Edit the text of an existing LinkedIn comment. Provide either fsdCommentUrn (preferred, from comment API response) or the legacy commentUrn format. Returns not_found if the comment does not exist or URN is malformed, forbidden if it's not your comment.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fsdCommentUrn":{"description":"urn:li:fsd_comment:(COMMENT_ID,urn:li:ugcPost:POST_ID) - from comment API response","type":"string"},"commentUrn":{"description":"Legacy comment URN format","type":"string"},"text":{"type":"string","minLength":1,"description":"New comment text"}},"required":["text"]},"examples":{"fsdCommentUrn":{"value":{"fsdCommentUrn":"urn:li:fsd_comment:(123,urn:li:ugcPost:456)","text":"Updated comment"}},"commentUrn":{"value":{"commentUrn":"urn:li:comment:(activity:123,456)","text":"Updated comment"}}}}}},"responses":{"200":{"description":"Comment edited","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/edit/linkedin/profile":{"patch":{"x-bereach":{"cost":"write"},"operationId":"editProfile","x-speakeasy-name-override":"editProfile","summary":"Edit LinkedIn profile headline/summary","description":"Edit the authenticated user's LinkedIn headline and/or about summary. At least one field is required.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"headline":"Senior Software Engineer | AI Enthusiast"},"schema":{"type":"object","properties":{"headline":{"description":"New LinkedIn headline (max 220 chars)","type":"string","maxLength":220},"summary":{"description":"New LinkedIn about/summary section (max 2600 chars)","type":"string","maxLength":2600}}}}}},"responses":{"200":{"description":"Profile updated","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"updated":{"type":"array","items":{"type":"string"},"description":"Fields that were updated on LinkedIn"},"synced":{"type":"array","items":{"type":"string"},"description":"Fields that were synced back to the local database"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","updated","synced","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/repost/linkedin/post":{"post":{"x-bereach":{"cost":"write"},"operationId":"repostPost","x-speakeasy-name-override":"repostPost","summary":"Repost / share a post","description":"Repost/share a LinkedIn post with quote text. Text is required by LinkedIn. Returns shareUrn on success. Returns bad_request if post URL is invalid.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"postUrl":"https://www.linkedin.com/feed/update/urn:li:activity:123","text":"Great insights on this topic!"},"schema":{"type":"object","properties":{"postUrl":{"type":"string","minLength":1,"description":"LinkedIn post URL to repost"},"text":{"type":"string","minLength":1,"description":"Quote text for the repost (required by LinkedIn)"}},"required":["postUrl","text"]}}}},"responses":{"200":{"description":"Post reposted","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"shareUrn":{"type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","shareUrn","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/unlike/linkedin/post":{"post":{"x-bereach":{"cost":"paced-free","agents":["outreach"]},"operationId":"unlikePost","x-speakeasy-name-override":"unlikePost","summary":"Unlike a post","description":"Remove your reaction from a LinkedIn post using GraphQL mutation. Idempotent if post is not liked. Returns bad_request if post URL is invalid.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"postUrl":"https://www.linkedin.com/feed/update/urn:li:activity:123"},"schema":{"type":"object","properties":{"postUrl":{"type":"string","minLength":1,"description":"LinkedIn post URL or URN to unlike"}},"required":["postUrl"]}}}},"responses":{"200":{"description":"Reaction removed","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/unlike/linkedin/comment":{"post":{"x-bereach":{"cost":"paced-free","agents":["outreach"]},"operationId":"unlikeComment","x-speakeasy-name-override":"unlikeComment","summary":"Unlike a comment","description":"Remove your reaction from a LinkedIn comment using GraphQL mutation. Accepts both 'urn:li:comment:(urn:li:activity:X,Y)' and 'urn:li:comment:(activity:X,Y)' formats. Also supports ugcPost and share types.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"commentUrn":"urn:li:comment:(urn:li:activity:123,456)"},"schema":{"type":"object","properties":{"commentUrn":{"type":"string","minLength":1,"description":"Full comment URN to unlike (e.g. urn:li:comment:(urn:li:activity:123,456))"}},"required":["commentUrn"]}}}},"responses":{"200":{"description":"Reaction removed","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/delete/linkedin/comment":{"post":{"x-bereach":{"cost":"write","agents":["orchestrator","outreach"]},"operationId":"deleteComment","x-speakeasy-name-override":"deleteComment","summary":"Delete one of your LinkedIn comments","description":"Permanently delete a comment you posted (or one on your own post). LinkedIn checks ownership server-side and returns 403 otherwise. Idempotent — already-deleted comments return success with alreadyGone=true. Pass the full comment URN in 'urn:li:comment:(activity:POST_ID,COMMENT_ID)' shape (ugcPost / share also accepted).","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"commentUrn":"urn:li:comment:(activity:7327726660852629504,7460399586222727168)"},"schema":{"type":"object","properties":{"commentUrn":{"type":"string","minLength":1,"description":"Full comment URN to delete (e.g. urn:li:comment:(activity:7327726660852629504,7460399586222727168))"}},"required":["commentUrn"]}}}},"responses":{"200":{"description":"Comment deleted (or already gone)","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"deleted":{"type":"object","properties":{"type":{"type":"string","enum":["activity","ugcPost","share"]},"parentId":{"type":"string"},"commentId":{"type":"string"},"alreadyGone":{"type":"boolean"}},"required":["type","parentId","commentId","alreadyGone"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","deleted","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/save/linkedin/post":{"post":{"x-bereach":{"cost":"paced-free"},"operationId":"savePost","x-speakeasy-name-override":"savePost","summary":"Save a post","description":"Save a LinkedIn post to bookmarks. Idempotent — saving an already-saved post is a no-op.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"postUrl":"https://www.linkedin.com/feed/update/urn:li:activity:123"},"schema":{"type":"object","properties":{"postUrl":{"type":"string","minLength":1,"description":"LinkedIn post URL or URN to save/unsave"}},"required":["postUrl"]}}}},"responses":{"200":{"description":"Post saved","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/unsave/linkedin/post":{"post":{"x-bereach":{"cost":"paced-free"},"operationId":"unsavePost","x-speakeasy-name-override":"unsavePost","summary":"Unsave a post","description":"Remove a LinkedIn post from bookmarks. Idempotent — unsaving a non-saved post is a no-op.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"postUrl":"https://www.linkedin.com/feed/update/urn:li:activity:123"},"schema":{"type":"object","properties":{"postUrl":{"type":"string","minLength":1,"description":"LinkedIn post URL or URN to save/unsave"}},"required":["postUrl"]}}}},"responses":{"200":{"description":"Post unsaved","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/collect/linkedin/saved":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"]},"operationId":"collectSavedPosts","x-speakeasy-name-override":"listSavedPosts","summary":"List saved posts","description":"List posts saved to bookmarks.","tags":["scrapers"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"start":0,"count":20},"schema":{"type":"object","properties":{"start":{"default":0,"description":"Pagination offset","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"default":20,"description":"Number of posts to return","type":"integer","minimum":1,"maximum":50}}}}}},"responses":{"200":{"description":"Saved posts","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"posts":{"type":"array","items":{"type":"object","properties":{"postUrl":{"type":"string","description":"Public URL of the post."},"postUrn":{"type":"string","description":"LinkedIn internal URN for this post. Use with engagement tools."},"postId":{"type":"string","description":"Numeric post identifier parsed from the URN."},"text":{"type":"string","description":"Post text content."},"date":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Post creation timestamp (Unix milliseconds)."},"likesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total reactions on this post."},"commentsCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total top-level comments on this post."},"sharesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total shares/reposts of this post."},"author":{"type":"object","properties":{"name":{"type":"string","description":"Author's display name."},"profileUrl":{"nullable":true,"description":"Author's LinkedIn profile URL.","type":"string"},"publicIdentifier":{"nullable":true,"description":"Vanity slug from the author's profile URL.","type":"string"},"profileUrn":{"nullable":true,"description":"Author's LinkedIn profile URN.","type":"string"}},"required":["name","profileUrl","publicIdentifier","profileUrn"],"additionalProperties":false},"media":{"type":"object","properties":{"type":{"type":"string","enum":["image","video","document","article"],"description":"Type of media attached to the post."},"urls":{"type":"array","items":{"type":"string"},"description":"Media URLs (image URLs for carousels, video streaming URL, article link, etc.)."},"title":{"description":"Title of the article or document, when available.","type":"string"},"thumbnailUrl":{"description":"Thumbnail URL for videos, articles, or document covers.","type":"string"}},"required":["type","urls"],"additionalProperties":false}},"required":["postUrl","postUrn","postId","text","date","likesCount","commentsCount","sharesCount","author"],"additionalProperties":false}},"total":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasMore":{"type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","posts","total","hasMore","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/analytics/linkedin/profile-views":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"]},"operationId":"getProfileViews","x-speakeasy-name-override":"views","summary":"Get profile views","description":"Get who viewed your LinkedIn profile with viewer details (name, headline, company, profileUrl). Returns views array and total count. Requires Premium for full viewer details.","tags":["profile"],"security":[{"token":[]}],"requestBody":{"required":false,"content":{"application/json":{"example":{},"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"Profile viewers","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"views":{"type":"array","items":{"type":"object","properties":{"entityUrn":{"type":"string"},"viewedAt":{"nullable":true,"anyOf":[{"type":"number"},{"type":"string"}]},"viewer":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"navigationUrl":{"nullable":true,"type":"string"}},"required":["entityUrn","viewedAt","viewer","headline","navigationUrl"],"additionalProperties":false}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","views","total","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/analytics/linkedin/search-appearances":{"post":{"x-bereach":{"cost":"read"},"operationId":"searchAppearances","x-speakeasy-name-override":"getSearchAppearances","summary":"Get search appearances","description":"Get how many times you appeared in LinkedIn search results and the top keywords that led to your profile. Returns search count, top keywords, and searcher demographics.","tags":["profile"],"security":[{"token":[]}],"requestBody":{"required":false,"content":{"application/json":{"example":{},"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"Search appearance stats","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"appearances":{"type":"object","properties":{"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"keywords":{"type":"array","items":{},"description":"Top search keywords that led to your profile"},"companies":{"type":"array","items":{},"description":"Companies of people who found you"},"raw":{"description":"Raw LinkedIn API response (included when available)"}},"required":["count","keywords","companies"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","appearances","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/analytics/linkedin/post":{"post":{"x-bereach":{"cost":"read"},"operationId":"postAnalytics","x-speakeasy-name-override":"getPostAnalytics","summary":"Get post analytics","description":"Get reactions and comments data for a LinkedIn post. Returns reaction counts, comment count, and post URN. Returns bad_request for invalid post URL.","tags":["profile"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"postUrl":"https://www.linkedin.com/feed/update/urn:li:activity:123"},"schema":{"type":"object","properties":{"postUrl":{"type":"string","minLength":1,"description":"LinkedIn post URL or URN"}},"required":["postUrl"]}}}},"responses":{"200":{"description":"Post analytics","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"analytics":{"type":"object","properties":{"reactions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total reactions on this post."},"comments":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total comments on this post."},"postUrn":{"type":"string","description":"LinkedIn internal URN for this post."}},"required":["reactions","comments","postUrn"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","analytics","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/analytics/linkedin/followers":{"post":{"x-bereach":{"cost":"read"},"operationId":"followerAnalytics","x-speakeasy-name-override":"getFollowerAnalytics","summary":"Get follower analytics","description":"Get follower demographics and growth data for your LinkedIn profile. Returns follower count, growth trends, and demographic breakdowns.","tags":["profile"],"security":[{"token":[]}],"requestBody":{"required":false,"content":{"application/json":{"example":{},"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"Follower analytics","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"analytics":{"type":"object","properties":{"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["count"],"additionalProperties":{},"description":"Follower count and optional growth/demographics data from LinkedIn"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","analytics","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/feed/linkedin":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"],"resultShape":"post"},"operationId":"getFeed","x-speakeasy-name-override":"getFeed","summary":"Get home feed","description":"Get posts from the LinkedIn home feed using GraphQL. Supports algorithmic (RELEVANCE) or chronological (REV_CHRON) sorting. Returns parsed post objects with author info, text, engagement counts. No pagination token support currently.","tags":["scrapers"],"security":[{"token":[]}],"requestBody":{"required":false,"content":{"application/json":{"example":{"count":20,"sortOrder":"RELEVANCE"},"schema":{"type":"object","properties":{"count":{"default":20,"description":"Number of feed items to return (1-50, default 20)","type":"integer","minimum":1,"maximum":50},"sortOrder":{"default":"RELEVANCE","description":"Sort order: RELEVANCE (default, algorithmic) or REV_CHRON (most recent first)","type":"string","enum":["RELEVANCE","REV_CHRON"]}}}}}},"responses":{"200":{"description":"Feed posts","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"posts":{"type":"array","items":{"type":"object","properties":{"postUrl":{"type":"string","description":"Public URL of the post."},"text":{"type":"string","description":"Post text content."},"date":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Post creation timestamp (Unix milliseconds)."},"likesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total reactions on this post."},"commentsCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total top-level comments on this post."},"sharesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total shares/reposts of this post."},"postUrn":{"type":"string","description":"LinkedIn internal URN for this post. Use with engagement tools (like, comment, collect_likes/comments)."},"postId":{"type":"string","description":"Numeric post identifier parsed from the URN."},"type":{"type":"string","enum":["activity","ugcPost","share"],"description":"LinkedIn post type: 'ugcPost' = standard post, 'share' = native share/repost, 'activity' = legacy format."},"isRepost":{"description":"True when the post is a repost/reshare of another post. Absent for original posts.","type":"boolean"},"media":{"description":"Media attached to the post (image, video, document, or article). Absent when the post is text-only.","type":"object","properties":{"type":{"type":"string","enum":["image","video","document","article"],"description":"Type of media attached to the post."},"urls":{"type":"array","items":{"type":"string"},"description":"Media URLs (image URLs for carousels, video streaming URL, article link, etc.)."},"title":{"description":"Title of the article or document, when available.","type":"string"},"thumbnailUrl":{"description":"Thumbnail URL for videos, articles, or document covers.","type":"string"}},"required":["type","urls"],"additionalProperties":false}},"required":["postUrl","text","date","likesCount","commentsCount","sharesCount","postUrn","postId","type"],"additionalProperties":false}},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","posts","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/follow/linkedin/company":{"post":{"x-bereach":{"cost":"paced-free"},"operationId":"followCompany","x-speakeasy-name-override":"followCompany","summary":"Follow a company","description":"Follow a LinkedIn company page.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"company":"https://www.linkedin.com/company/google"},"schema":{"type":"object","properties":{"company":{"type":"string","description":"LinkedIn company URL or URN"}},"required":["company"]}}}},"responses":{"200":{"description":"Company followed","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/unfollow/linkedin/company":{"post":{"x-bereach":{"cost":"paced-free"},"operationId":"unfollowCompany","x-speakeasy-name-override":"unfollowCompany","summary":"Unfollow a company","description":"Unfollow a LinkedIn company page.","tags":["actions"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"company":"https://www.linkedin.com/company/google"},"schema":{"type":"object","properties":{"company":{"type":"string","description":"LinkedIn company URL or URN"}},"required":["company"]}}}},"responses":{"200":{"description":"Company unfollowed","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/collect/linkedin/hashtag":{"post":{"x-bereach":{"cost":"read","agents":["lead_gen"],"resultShape":"post","guards":["omitData"]},"operationId":"collectHashtagPosts","x-speakeasy-name-override":"collectHashtagPosts","summary":"Collect posts from a hashtag","description":"Collect posts from a LinkedIn hashtag feed. Pass hashtag name without # prefix. Supports pagination with start/count. Returns parsed post objects.","tags":["scrapers"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"hashtag":"AI","count":20},"schema":{"type":"object","properties":{"hashtag":{"type":"string","minLength":1,"description":"Hashtag to collect posts from (without #)"},"start":{"default":0,"description":"Pagination offset","type":"integer","minimum":0,"maximum":9007199254740991},"count":{"default":20,"description":"Number of posts","type":"integer","minimum":1,"maximum":50},"omitData":{"description":"When true, returns only the total count (no posts array). Data is still saved to DB.","type":"boolean"}},"required":["hashtag"]}}}},"responses":{"200":{"description":"Hashtag posts","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"posts":{"type":"array","items":{"type":"object","properties":{"postUrl":{"type":"string","description":"Public URL of the post."},"postUrn":{"type":"string","description":"LinkedIn internal URN for this post. Use with engagement tools."},"text":{"type":"string","description":"Post text content."},"date":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Post creation timestamp (Unix milliseconds)."},"likesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total reactions on this post."},"commentsCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total top-level comments on this post."},"sharesCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total shares/reposts of this post."},"author":{"type":"object","properties":{"name":{"type":"string","description":"Author's display name."},"profileUrl":{"nullable":true,"description":"Author's LinkedIn profile URL.","type":"string"},"publicIdentifier":{"nullable":true,"description":"Vanity slug from the author's profile URL.","type":"string"},"profileUrn":{"nullable":true,"description":"Author's LinkedIn profile URN.","type":"string"}},"required":["name","profileUrl","publicIdentifier","profileUrn"],"additionalProperties":false},"media":{"type":"object","properties":{"type":{"type":"string","enum":["image","video","document","article"],"description":"Type of media attached to the post."},"urls":{"type":"array","items":{"type":"string"},"description":"Media URLs (image URLs for carousels, video streaming URL, article link, etc.)."},"title":{"description":"Title of the article or document, when available.","type":"string"},"thumbnailUrl":{"description":"Thumbnail URL for videos, articles, or document covers.","type":"string"}},"required":["type","urls"],"additionalProperties":false}},"required":["postUrl","postUrn","text","date","likesCount","commentsCount","sharesCount","author"],"additionalProperties":false}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasMore":{"type":"boolean"},"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Current pagination offset"},"nextStart":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Offset for next page of results"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","posts","total","hasMore","start","nextStart","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/activities":{"get":{"operationId":"globalActivities","x-speakeasy-name-override":"globalActivities","summary":"Global activity log","description":"Returns activities across all contacts for the authenticated user, most recent first. Supports filtering by type, campaign, and date range..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"type","schema":{"description":"Comma-separated activity types to filter (e.g. 'message,connection_request')","type":"string"},"description":"Comma-separated activity types to filter (e.g. 'message,connection_request')"},{"in":"query","name":"campaignId","schema":{"description":"Filter activities to contacts in this campaign","type":"string"},"description":"Filter activities to contacts in this campaign"},{"in":"query","name":"from","schema":{"description":"ISO date/time lower bound for createdAt","type":"string"},"description":"ISO date/time lower bound for createdAt"},{"in":"query","name":"to","schema":{"description":"ISO date/time upper bound for createdAt","type":"string"},"description":"ISO date/time upper bound for createdAt"},{"in":"query","name":"limit","schema":{"default":50,"description":"Results per page (max 200)","type":"integer","minimum":1,"maximum":200},"description":"Results per page (max 200)"},{"in":"query","name":"offset","schema":{"default":0,"description":"Pagination offset","type":"integer","minimum":0,"maximum":9007199254740991},"description":"Pagination offset"}],"responses":{"200":{"description":"Activities list","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"activities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"content":{"nullable":true,"type":"string"},"metadata":{"nullable":true},"success":{"nullable":true,"type":"boolean"},"error":{"nullable":true,"type":"string"},"createdAt":{"type":"string"},"contactId":{"type":"string"},"contactName":{"nullable":true,"type":"string"},"contactLinkedinUrl":{"nullable":true,"type":"string"}},"required":["id","type","content","metadata","success","error","createdAt","contactId","contactName","contactLinkedinUrl"],"additionalProperties":false}},"pagination":{"type":"object","properties":{"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"offset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["limit","offset","total"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","activities","pagination","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/contacts":{"post":{"x-bereach":{"agents":["lead_gen"]},"operationId":"contactsUpsert","x-speakeasy-name-override":"upsert","summary":"Create or upsert contacts (no campaign required)","description":"Save contacts organically without creating a campaign first. Upserts by LinkedIn URL — if the contact already exists for this user, it updates the name and optional fields. Returns full contact objects with IDs so the AI agent can immediately log activities and update lifecycle stages..","tags":["contacts"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"contacts":[{"linkedinUrl":"https://linkedin.com/in/johndoe","name":"John Doe","source":"search_results"},{"linkedinUrl":"https://linkedin.com/in/janesmith","name":"Jane Smith","source":"likes","sourceAngle":"competitor-engagement","lifecycleStage":"lead","hotScore":75}]},"schema":{"type":"object","properties":{"contacts":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"object","properties":{"linkedinUrl":{"type":"string","description":"LinkedIn profile URL, URN, or bare vanity name"},"profileUrn":{"description":"LinkedIn profile URN (e.g. urn:li:fsd_profile:ACoAAA...). Improves dedup when provided alongside a vanity URL.","nullable":true,"type":"string"},"publicIdentifier":{"description":"LinkedIn vanity slug (e.g. joshuaau). Improves dedup when provided alongside a URN.","nullable":true,"type":"string"},"name":{"type":"string","description":"Profile name"},"source":{"default":"manual_import","description":"How this contact was found. Optional for organic creation (defaults to manual_import), required for campaign-based addition. Unknown values default to manual_import.","type":"string","enum":["likes","comments","reposts","posts","company_followers","search_results","manual_import","event_attendees","group_members","engagement_scraping","content_search","followers_mining","people_search","job_search","company_search","network_expansion","bulk_visit","hubspot_import","salesforce_import","external_crm"]},"sourceAngle":{"description":"Which lead-gen angle found this (e.g., 'vp-sales-france')","type":"string"},"lifecycleStage":{"description":"Lifecycle stage. Defaults to 'contact' on creation. Omit when adding existing contacts to avoid downgrading their stage.","type":"string","enum":["contact","lead","qualified","approved","rejected"]},"hotScore":{"description":"Contact quality score (0-100)","type":"integer","minimum":0,"maximum":100},"qualificationNotes":{"description":"Agent reasoning for qualification decision","type":"string"},"leadBrief":{"description":"Human-readable lead summary for sales prep (2-3 sentences)","type":"string"},"notes":{"type":"string"}},"required":["linkedinUrl","name","source"]},"description":"Contacts to add (single or bulk)"}},"required":["contacts"]}}}},"responses":{"201":{"description":"Contacts created or updated","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"results":{"type":"object","properties":{"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"updated":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"errors":{"type":"array","items":{"type":"string"}}},"required":["created","updated","skipped","errors"],"additionalProperties":false},"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"linkedinUrl":{"type":"string"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN (e.g. urn:li:fsd_profile:ACoAAA...)","type":"string"},"publicIdentifier":{"nullable":true,"description":"LinkedIn vanity slug (e.g. joshuaau)","type":"string"},"name":{"type":"string"},"lifecycleStage":{"type":"string"},"hotScore":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"qualificationNotes":{"nullable":true,"type":"string"},"leadBrief":{"nullable":true,"type":"string"},"notes":{"nullable":true,"type":"string"},"stageChangedAt":{"nullable":true,"type":"string"},"profileData":{"nullable":true},"profileUpdatedAt":{"nullable":true,"type":"string"},"conversationData":{"nullable":true},"conversationUpdatedAt":{"nullable":true,"type":"string"},"outreachStatus":{"type":"string"},"lastContactedAt":{"nullable":true,"type":"string"},"lastRepliedAt":{"nullable":true,"type":"string"},"nextFollowUpAt":{"nullable":true,"type":"string"},"doNotContact":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","linkedinUrl","profileUrn","publicIdentifier","name","lifecycleStage","hotScore","qualificationNotes","leadBrief","notes","stageChangedAt","profileData","profileUpdatedAt","conversationData","conversationUpdatedAt","outreachStatus","lastContactedAt","lastRepliedAt","nextFollowUpAt","doNotContact","tags","createdAt","updatedAt"],"additionalProperties":false},"description":"Full contact objects with IDs for immediate use"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","results","contacts","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/contacts/search":{"get":{"x-bereach":{"agents":["orchestrator","lead_gen","outreach"],"guards":["omitData"]},"operationId":"contactsSearch","x-speakeasy-name-override":"search","summary":"Search and filter contacts","description":"Search contacts with flexible filters: name, LinkedIn URL, lifecycle stage, outreach status, tags, hot score, follow-up date, campaign membership, and more. Supports pagination and sorting..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"linkedinUrl","schema":{"description":"Filter by LinkedIn URL (exact match)","type":"string"},"description":"Filter by LinkedIn URL (exact match)"},{"in":"query","name":"name","schema":{"description":"Filter by name (partial match)","type":"string"},"description":"Filter by name (partial match)"},{"in":"query","name":"lifecycleStage","schema":{"type":"string","enum":["contact","lead","qualified","approved","rejected"]}},{"in":"query","name":"sortBy","schema":{"description":"Sort field (e.g. 'hotScore', 'createdAt', 'nextFollowUpAt')","type":"string"},"description":"Sort field (e.g. 'hotScore', 'createdAt', 'nextFollowUpAt')"},{"in":"query","name":"minHotScore","schema":{"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"outreachStatus","schema":{"type":"string","enum":["none","connection_sent","connected","dm_sent","followed_up","replied","in_conversation","meeting_booked","converted","not_interested"]}},{"in":"query","name":"tag","schema":{"description":"Filter by tag","type":"string"},"description":"Filter by tag"},{"in":"query","name":"followUpBefore","schema":{"description":"ISO date: contacts with nextFollowUpAt before this date","type":"string"},"description":"ISO date: contacts with nextFollowUpAt before this date"},{"in":"query","name":"doNotContact","schema":{"type":"string","enum":["true","false"]}},{"in":"query","name":"hasProfileData","schema":{"type":"string","enum":["true","false"]}},{"in":"query","name":"campaignId","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":50,"type":"integer","minimum":1,"maximum":200}},{"in":"query","name":"offset","schema":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Matching contacts","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"linkedinUrl":{"type":"string"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN (e.g. urn:li:fsd_profile:ACoAAA...)","type":"string"},"publicIdentifier":{"nullable":true,"description":"LinkedIn vanity slug (e.g. joshuaau)","type":"string"},"name":{"type":"string"},"lifecycleStage":{"type":"string"},"hotScore":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"qualificationNotes":{"nullable":true,"type":"string"},"leadBrief":{"nullable":true,"type":"string"},"notes":{"nullable":true,"type":"string"},"stageChangedAt":{"nullable":true,"type":"string"},"profileData":{"nullable":true},"profileUpdatedAt":{"nullable":true,"type":"string"},"conversationData":{"nullable":true},"conversationUpdatedAt":{"nullable":true,"type":"string"},"outreachStatus":{"type":"string"},"lastContactedAt":{"nullable":true,"type":"string"},"lastRepliedAt":{"nullable":true,"type":"string"},"nextFollowUpAt":{"nullable":true,"type":"string"},"doNotContact":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"campaigns":{"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string"},"campaignName":{"type":"string"},"campaignStatus":{"type":"string","description":"Campaign status (e.g. 'active', 'paused', 'completed')."},"source":{"type":"string"},"sourceAngle":{"nullable":true,"type":"string"},"addedAt":{"type":"string"}},"required":["campaignId","campaignName","campaignStatus","source","sourceAngle","addedAt"],"additionalProperties":false}}},"required":["id","linkedinUrl","profileUrn","publicIdentifier","name","lifecycleStage","hotScore","qualificationNotes","leadBrief","notes","stageChangedAt","profileData","profileUpdatedAt","conversationData","conversationUpdatedAt","outreachStatus","lastContactedAt","lastRepliedAt","nextFollowUpAt","doNotContact","tags","createdAt","updatedAt","campaigns"],"additionalProperties":false}},"pagination":{"type":"object","properties":{"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"offset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["limit","offset","total"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","contacts","pagination","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/contacts/{id}":{"get":{"x-bereach":{"agents":["orchestrator","lead_gen","outreach"]},"operationId":"contactsGetFull","x-speakeasy-name-override":"get","summary":"Get a single contact with activities and campaigns","description":"Get full contact details including activities and campaign memberships..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Contact ID"}],"responses":{"200":{"description":"Contact details","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"contact":{"type":"object","properties":{"id":{"type":"string"},"linkedinUrl":{"type":"string"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN (e.g. urn:li:fsd_profile:ACoAAA...)","type":"string"},"publicIdentifier":{"nullable":true,"description":"LinkedIn vanity slug (e.g. joshuaau)","type":"string"},"name":{"type":"string"},"lifecycleStage":{"type":"string"},"hotScore":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"qualificationNotes":{"nullable":true,"type":"string"},"leadBrief":{"nullable":true,"type":"string"},"notes":{"nullable":true,"type":"string"},"stageChangedAt":{"nullable":true,"type":"string"},"profileData":{"nullable":true},"profileUpdatedAt":{"nullable":true,"type":"string"},"conversationData":{"nullable":true},"conversationUpdatedAt":{"nullable":true,"type":"string"},"outreachStatus":{"type":"string"},"lastContactedAt":{"nullable":true,"type":"string"},"lastRepliedAt":{"nullable":true,"type":"string"},"nextFollowUpAt":{"nullable":true,"type":"string"},"doNotContact":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"activities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"content":{"nullable":true,"type":"string"},"metadata":{"nullable":true},"createdAt":{"type":"string"}},"required":["id","type","content","metadata","createdAt"],"additionalProperties":false}},"campaigns":{"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string"},"campaignName":{"type":"string"},"campaignStatus":{"type":"string"},"source":{"type":"string"},"sourceAngle":{"nullable":true,"type":"string"},"addedAt":{"type":"string"}},"required":["campaignId","campaignName","campaignStatus","source","sourceAngle","addedAt"],"additionalProperties":false}}},"required":["id","linkedinUrl","profileUrn","publicIdentifier","name","lifecycleStage","hotScore","qualificationNotes","leadBrief","notes","stageChangedAt","profileData","profileUpdatedAt","conversationData","conversationUpdatedAt","outreachStatus","lastContactedAt","lastRepliedAt","nextFollowUpAt","doNotContact","tags","createdAt","updatedAt","activities","campaigns"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","contact","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"patch":{"x-bereach":{"agents":["lead_gen","outreach"]},"operationId":"contactsUpdate","x-speakeasy-name-override":"update","summary":"Update a contact","description":"Update lifecycle stage, hot score, notes, outreach status, follow-up date, tags, or profile data for a contact..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Contact ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"lifecycleStage":{"description":"Promote to new stage (forward-only, except rejected)","type":"string","enum":["contact","lead","qualified","approved","rejected"]},"hotScore":{"type":"integer","minimum":0,"maximum":100},"qualificationNotes":{"type":"string"},"leadBrief":{"description":"Human-readable lead summary for sales prep","type":"string"},"notes":{"type":"string"},"name":{"description":"Update contact name","type":"string"},"profileData":{"description":"Full LinkedIn profile snapshot (JSON)"},"profileUpdatedAt":{"description":"When profileData was last refreshed","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"conversationData":{"description":"DM history (JSON: historySummary + recentMessages)"},"conversationUpdatedAt":{"description":"When conversationData was last synced","type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"outreachStatus":{"description":"Manual outreach status override","type":"string","enum":["none","connection_sent","connected","dm_sent","followed_up","replied","in_conversation","meeting_booked","converted","not_interested"]},"nextFollowUpAt":{"description":"When agent should follow up (null to clear)","nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"doNotContact":{"description":"Flag contact as do-not-contact","type":"boolean"},"tags":{"description":"Add/remove/set tags","anyOf":[{"type":"object","properties":{"add":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":100}},"remove":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":100}}},"required":["add"]},{"type":"object","properties":{"add":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":100}},"remove":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":100}}},"required":["remove"]},{"type":"object","properties":{"set":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":100}}},"required":["set"]}]}}}}}},"responses":{"200":{"description":"Updated contact","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"contact":{"type":"object","properties":{"id":{"type":"string"},"linkedinUrl":{"type":"string"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN (e.g. urn:li:fsd_profile:ACoAAA...)","type":"string"},"publicIdentifier":{"nullable":true,"description":"LinkedIn vanity slug (e.g. joshuaau)","type":"string"},"name":{"type":"string"},"lifecycleStage":{"type":"string"},"hotScore":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"qualificationNotes":{"nullable":true,"type":"string"},"leadBrief":{"nullable":true,"type":"string"},"notes":{"nullable":true,"type":"string"},"stageChangedAt":{"nullable":true,"type":"string"},"profileData":{"nullable":true},"profileUpdatedAt":{"nullable":true,"type":"string"},"conversationData":{"nullable":true},"conversationUpdatedAt":{"nullable":true,"type":"string"},"outreachStatus":{"type":"string"},"lastContactedAt":{"nullable":true,"type":"string"},"lastRepliedAt":{"nullable":true,"type":"string"},"nextFollowUpAt":{"nullable":true,"type":"string"},"doNotContact":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","linkedinUrl","profileUrn","publicIdentifier","name","lifecycleStage","hotScore","qualificationNotes","leadBrief","notes","stageChangedAt","profileData","profileUpdatedAt","conversationData","conversationUpdatedAt","outreachStatus","lastContactedAt","lastRepliedAt","nextFollowUpAt","doNotContact","tags","createdAt","updatedAt"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","contact","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/contacts/{id}/activities":{"get":{"x-bereach":{"agents":["orchestrator","lead_gen","outreach"]},"operationId":"contactsGetActivities","x-speakeasy-name-override":"listActivities","summary":"List activities for a contact","description":"Get paginated activity log for a SPECIFIC contact. Requires contact id (path param) — cannot list activities for all contacts. Call contacts_search first to get the contact id, then call this with that id.","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"type","schema":{"description":"Filter by activity type","type":"string"},"description":"Filter by activity type"},{"in":"query","name":"limit","schema":{"default":50,"type":"integer","minimum":1,"maximum":200}},{"in":"query","name":"offset","schema":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Contact ID"}],"responses":{"200":{"description":"Contact activities","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"activities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"content":{"nullable":true,"type":"string"},"metadata":{"nullable":true},"createdAt":{"type":"string"}},"required":["id","type","content","metadata","createdAt"],"additionalProperties":false}},"pagination":{"type":"object","properties":{"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"offset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["limit","offset","total"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","activities","pagination","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"post":{"x-bereach":{"agents":["lead_gen","outreach"]},"operationId":"contactsLogActivity","x-speakeasy-name-override":"addActivities","summary":"Log activities for a contact","description":"Log one or more activities (e.g. message_sent, profile_visited, post_liked) for a contact. Max 100 per request..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Contact ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"activities":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["connection_request","message","follow_up","reply_received","connection_accepted","profile_view","engagement_observed","post_interaction","search_found","qualification","stage_change","message_received","user_interest","meeting_booked","meeting_completed","meeting_cancelled","do_not_contact"],"description":"Activity type"},"content":{"description":"Human-readable description of what happened","type":"string"},"metadata":{"description":"Structured data: postUrl, postAuthor, angle, distance, etc."}},"required":["type"]},"description":"Activities to log"}},"required":["activities"]}}}},"responses":{"200":{"description":"Activities logged","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","created","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/contacts/bulk":{"patch":{"x-bereach":{"agents":["lead_gen"]},"operationId":"contactsBulkUpdate","x-speakeasy-name-override":"bulkUpdate","summary":"Bulk update contacts","description":"Update multiple contacts at once. Same fields as single update. Max 500 contacts per request..","tags":["contacts"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contactIds":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string"},"description":"Contact IDs to update"},"update":{"type":"object","properties":{"lifecycleStage":{"type":"string","enum":["contact","lead","qualified","approved","rejected"]},"hotScore":{"type":"integer","minimum":0,"maximum":100},"qualificationNotes":{"type":"string"},"leadBrief":{"type":"string"},"notes":{"type":"string"},"outreachStatus":{"type":"string","enum":["none","connection_sent","connected","dm_sent","followed_up","replied","in_conversation","meeting_booked","converted","not_interested"]},"nextFollowUpAt":{"nullable":true,"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"doNotContact":{"type":"boolean"},"tags":{"anyOf":[{"type":"object","properties":{"add":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":100}},"remove":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":100}}},"required":["add"]},{"type":"object","properties":{"add":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":100}},"remove":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":100}}},"required":["remove"]},{"type":"object","properties":{"set":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":100}}},"required":["set"]}],"description":"Tag operations: { add, remove } or { set }"}},"description":"Fields to update on all matching contacts"}},"required":["contactIds","update"]}}}},"responses":{"200":{"description":"Bulk update results","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"updated":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"errors":{"type":"array","items":{"type":"string"}},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","updated","skipped","errors","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/contacts/stats":{"get":{"x-bereach":{"agents":["orchestrator","lead_gen","outreach"]},"operationId":"contactsStats","x-speakeasy-name-override":"stats","summary":"Get contact funnel statistics","description":"Get aggregated contact statistics: funnel breakdown by lifecycle stage, source, source angle, campaign, and daily trends..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"campaignId","schema":{"description":"Filter stats by campaign","type":"string"},"description":"Filter stats by campaign"}],"responses":{"200":{"description":"Contact statistics","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"funnel":{"type":"object","properties":{"contact":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lead":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"qualified":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["contact","lead","qualified","approved","rejected"],"additionalProperties":false},"bySource":{"type":"object","additionalProperties":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"bySourceAngle":{"type":"object","additionalProperties":{"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"contact":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lead":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"qualified":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["total","contact","lead","qualified","approved","rejected"],"additionalProperties":false}},"byCampaign":{"type":"object","additionalProperties":{"type":"object","properties":{"name":{"type":"string"},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"contact":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lead":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"qualified":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["name","total","contact","lead","qualified","approved","rejected"],"additionalProperties":false}},"daily":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["date","created"],"additionalProperties":false}},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","funnel","bySource","bySourceAngle","byCampaign","daily","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/agent-state":{"get":{"x-bereach":{"agents":["lead_gen"]},"operationId":"stateList","x-speakeasy-name-override":"listAgentStates","summary":"List all agent state entries","description":"List all key-value state entries for the current workspace. Pass keysOnly=true to return only keys and timestamps without the data payload..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"keysOnly","schema":{"description":"When 'true', omits the data payload and returns only keys + timestamps. Useful for state overview without transferring large payloads.","type":"string","enum":["true","false"]},"description":"When 'true', omits the data payload and returns only keys + timestamps. Useful for state overview without transferring large payloads."}],"responses":{"200":{"description":"All state entries","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"states":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"data":{"description":"Full state object"},"updatedAt":{"nullable":true,"type":"string"}},"required":["key","data","updatedAt"],"additionalProperties":false}},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","states","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/agent-state/{key}":{"get":{"x-bereach":{"agents":["lead_gen","outreach"]},"operationId":"stateGet","x-speakeasy-name-override":"getAgentState","summary":"Get agent state by key","description":"Read a key-value state entry for the current agent/workspace..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"},"description":"State key"}],"responses":{"200":{"description":"State entry","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"key":{"type":"string"},"data":{"description":"Full state object"},"updatedAt":{"nullable":true,"type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","key","data","updatedAt","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"put":{"x-bereach":{"agents":["lead_gen","outreach"]},"operationId":"stateSet","x-speakeasy-name-override":"setAgentState","summary":"Set agent state by key","description":"Create or overwrite a key-value state entry..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"},"description":"State key"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"Full state object to store"}},"required":["data"]}}}},"responses":{"200":{"description":"State saved","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"key":{"type":"string"},"data":{"description":"Full state object"},"updatedAt":{"nullable":true,"type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","key","data","updatedAt","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"patch":{"x-bereach":{"agents":["lead_gen","outreach"]},"operationId":"statePatch","x-speakeasy-name-override":"patchAgentState","summary":"Merge-update agent state by key","description":"Merge partial fields into an existing state entry..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"},"description":"State key"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{},"description":"Partial state fields to merge"}},"required":["data"]}}}},"responses":{"200":{"description":"State merged","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"key":{"type":"string"},"data":{"description":"Full state object"},"updatedAt":{"nullable":true,"type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","key","data","updatedAt","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"delete":{"x-bereach":{"agents":["lead_gen"]},"operationId":"stateDelete","x-speakeasy-name-override":"deleteAgentState","summary":"Delete agent state by key","description":"Delete a key-value state entry..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"},"description":"State key"}],"responses":{"200":{"description":"State deleted","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"key":{"type":"string","description":"The key that was deleted"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","key","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/contacts/campaigns":{"get":{"x-bereach":{"agents":["orchestrator","lead_gen","outreach"]},"operationId":"contactsListCampaigns","x-speakeasy-name-override":"listCampaigns","summary":"List campaigns","description":"List campaigns with optional filters and stage counts..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"type","schema":{"type":"string","enum":["outreach","lead_gen","lead_magnet"]}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":50,"type":"integer","minimum":1,"maximum":100}},{"in":"query","name":"offset","schema":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Campaigns list","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"campaigns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Campaign unique ID (nanoid). Use this as campaignSlug in API calls."},"name":{"type":"string","description":"Human-readable campaign name."},"slug":{"description":"URL-safe slug auto-generated from name.","nullable":true,"type":"string"},"description":{"nullable":true,"description":"Optional user-facing campaign description.","type":"string"},"context":{"nullable":true,"description":"Serialized JSON blob of saved contexts (ICP, playbook, etc.). Parse to inspect individual context keys.","type":"string"},"type":{"type":"string","description":"Campaign type (e.g. 'outreach', 'engagement', 'inbox')."},"status":{"type":"string","description":"Campaign status: running, paused, offline, broken, or completed."},"totalContacts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total contacts added to this campaign across all lifecycle stages."},"scheduledStartTime":{"description":"Daily start time (HH:MM)","nullable":true,"type":"string"},"scheduledStopTime":{"description":"Daily stop time (HH:MM)","nullable":true,"type":"string"},"timezone":{"description":"IANA timezone","nullable":true,"type":"string"},"runDays":{"description":"Days to run (e.g. ['monday','tuesday'])","nullable":true,"type":"array","items":{"type":"string"}},"dailyActionLimit":{"description":"Max actions per day","nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startedAt":{"description":"When campaign was first started","nullable":true,"type":"string"},"completedAt":{"description":"When campaign was completed","nullable":true,"type":"string"},"draftMode":{"description":"review: all agent actions create drafts for approval. autopilot: agent sends directly.","type":"string","enum":["review","autopilot"]},"aiEnabled":{"description":"Whether LLM-backed agent tasks are allowed on this campaign. When false, only deterministic work runs.","type":"boolean"},"stageCounts":{"type":"object","properties":{"contact":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lead":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"qualified":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["contact","lead","qualified","approved","rejected"],"additionalProperties":false},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","description","context","type","status","totalContacts","createdAt","updatedAt"],"additionalProperties":false}},"pagination":{"type":"object","properties":{"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"offset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["limit","offset","total"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","campaigns","pagination","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"post":{"x-bereach":{"agents":["orchestrator","lead_gen"]},"operationId":"contactsCreateCampaign","x-speakeasy-name-override":"createCampaign","summary":"Create a lead-gen campaign","description":"Create a campaign with optional agent context (markdown brief)..","tags":["contacts"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"Human-readable campaign name. Use a clear, descriptive title. Do NOT use slugs or technical IDs."},"description":{"description":"Optional campaign description","type":"string","maxLength":1000},"context":{"description":"Full agent instructions in markdown","type":"string"},"draftMode":{"description":"autopilot (default for new campaigns): agent sends directly without per-draft approval. review: agent creates drafts that the user must approve in the Drafts tab before they ship — choose this only when the user explicitly asked to review messages first.","type":"string","enum":["review","autopilot"]},"language":{"description":"ISO 639-1 language code (e.g. 'fr', 'en'). Overrides ASCII heuristic for AI task language.","type":"string","maxLength":10},"aiEnabled":{"default":false,"description":"Opt in to LLM-backed agent tasks (drafting, qualification, inbox replies, …) on this campaign. For CHAT / interactive campaigns → ALWAYS pass `aiEnabled: true` so the agent tasks (qualify, draft, reply) actually run. Omit or pass `false` ONLY when the caller is an API integration handling dispatch itself (deterministic action-only mode).","type":"boolean"},"force":{"description":"Bypass the duplicate-name guard. Normally the endpoint returns 409 with a `suggested` existing campaign when `name` is within Levenshtein 2 of one. Pass `force: true` after the agent has surfaced the suggestion to the user and they explicitly confirmed they want a second campaign with a similar name. Default: false.","type":"boolean"}},"required":["name"]}}}},"responses":{"201":{"description":"Campaign created","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"campaign":{"type":"object","properties":{"id":{"type":"string","description":"Campaign unique ID (nanoid). Use this as campaignSlug in API calls."},"name":{"type":"string","description":"Human-readable campaign name."},"slug":{"description":"URL-safe slug auto-generated from name.","nullable":true,"type":"string"},"description":{"nullable":true,"description":"Optional user-facing campaign description.","type":"string"},"context":{"nullable":true,"description":"Serialized JSON blob of saved contexts (ICP, playbook, etc.). Parse to inspect individual context keys.","type":"string"},"type":{"type":"string","description":"Campaign type (e.g. 'outreach', 'engagement', 'inbox')."},"status":{"type":"string","description":"Campaign status: running, paused, offline, broken, or completed."},"totalContacts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total contacts added to this campaign across all lifecycle stages."},"scheduledStartTime":{"description":"Daily start time (HH:MM)","nullable":true,"type":"string"},"scheduledStopTime":{"description":"Daily stop time (HH:MM)","nullable":true,"type":"string"},"timezone":{"description":"IANA timezone","nullable":true,"type":"string"},"runDays":{"description":"Days to run (e.g. ['monday','tuesday'])","nullable":true,"type":"array","items":{"type":"string"}},"dailyActionLimit":{"description":"Max actions per day","nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startedAt":{"description":"When campaign was first started","nullable":true,"type":"string"},"completedAt":{"description":"When campaign was completed","nullable":true,"type":"string"},"draftMode":{"description":"review: all agent actions create drafts for approval. autopilot: agent sends directly.","type":"string","enum":["review","autopilot"]},"aiEnabled":{"description":"Whether LLM-backed agent tasks are allowed on this campaign. When false, only deterministic work runs.","type":"boolean"},"stageCounts":{"type":"object","properties":{"contact":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lead":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"qualified":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["contact","lead","qualified","approved","rejected"],"additionalProperties":false},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","description","context","type","status","totalContacts","createdAt","updatedAt"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","campaign","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/contacts/campaigns/{campaignId}":{"get":{"x-bereach":{"agents":["orchestrator"]},"operationId":"contactsGetCampaign","x-speakeasy-name-override":"getCampaign","summary":"Get a single campaign","description":"Get a campaign by ID with full details..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Campaign ID"}],"responses":{"200":{"description":"Campaign details","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"campaign":{"type":"object","properties":{"id":{"type":"string","description":"Campaign unique ID (nanoid). Use this as campaignSlug in API calls."},"name":{"type":"string","description":"Human-readable campaign name."},"slug":{"description":"URL-safe slug auto-generated from name.","nullable":true,"type":"string"},"description":{"nullable":true,"description":"Optional user-facing campaign description.","type":"string"},"context":{"nullable":true,"description":"Serialized JSON blob of saved contexts (ICP, playbook, etc.). Parse to inspect individual context keys.","type":"string"},"type":{"type":"string","description":"Campaign type (e.g. 'outreach', 'engagement', 'inbox')."},"status":{"type":"string","description":"Campaign status: running, paused, offline, broken, or completed."},"totalContacts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total contacts added to this campaign across all lifecycle stages."},"scheduledStartTime":{"description":"Daily start time (HH:MM)","nullable":true,"type":"string"},"scheduledStopTime":{"description":"Daily stop time (HH:MM)","nullable":true,"type":"string"},"timezone":{"description":"IANA timezone","nullable":true,"type":"string"},"runDays":{"description":"Days to run (e.g. ['monday','tuesday'])","nullable":true,"type":"array","items":{"type":"string"}},"dailyActionLimit":{"description":"Max actions per day","nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startedAt":{"description":"When campaign was first started","nullable":true,"type":"string"},"completedAt":{"description":"When campaign was completed","nullable":true,"type":"string"},"draftMode":{"description":"review: all agent actions create drafts for approval. autopilot: agent sends directly.","type":"string","enum":["review","autopilot"]},"aiEnabled":{"description":"Whether LLM-backed agent tasks are allowed on this campaign. When false, only deterministic work runs.","type":"boolean"},"stageCounts":{"type":"object","properties":{"contact":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lead":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"qualified":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["contact","lead","qualified","approved","rejected"],"additionalProperties":false},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","description","context","type","status","totalContacts","createdAt","updatedAt"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","campaign","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"patch":{"x-bereach":{"agents":["orchestrator","lead_gen"]},"operationId":"contactsUpdateCampaign","x-speakeasy-name-override":"updateCampaign","summary":"Update campaign settings","description":"Update campaign name, description, context, schedule, limits, or daily targets. NEVER pass `status` here — the server rejects it; use campaign_transition for start/pause/resume/complete/reset..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Campaign ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"description":{"type":"string","maxLength":1000},"context":{"type":"string"},"status":{"type":"string","enum":["draft","scheduled","running","paused","completed","failed"]},"scheduledStartTime":{"type":"string"},"scheduledStopTime":{"type":"string"},"timezone":{"type":"string"},"runDays":{"minItems":1,"type":"array","items":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"description":"Days the dispatcher fires user-action tasks. Lowercase English day names; pick at least one."},"dailyActionLimit":{"nullable":true,"type":"integer","minimum":0,"maximum":9007199254740991},"dailyTarget":{"nullable":true,"type":"integer","minimum":1,"maximum":9007199254740991},"totalTarget":{"nullable":true,"type":"integer","minimum":1,"maximum":9007199254740991},"taskOverrides":{"type":"object","additionalProperties":{"type":"object","properties":{"maxRunsPerDay":{"nullable":true,"type":"integer","minimum":1,"maximum":1000},"minIntervalMinutes":{"type":"number","minimum":0,"maximum":1440},"defaultBatchSize":{"type":"integer","minimum":1,"maximum":100},"maxCreditsPerRun":{"type":"integer","minimum":0,"maximum":100},"timeoutSeconds":{"type":"integer","minimum":30,"maximum":3600},"jitterMinutes":{"type":"number","minimum":0,"maximum":60},"priority":{"type":"integer","minimum":0,"maximum":100}}}},"handoverMode":{"description":"When agent hands over conversation to human. on_reply (default): stop on first reply. on_goal: keep going until meeting booked or converted. manual: never auto-stop.","type":"string","enum":["on_reply","on_goal","manual"]},"disabledTaskTypes":{"description":"Task types to stop dispatching (e.g. ['discover-search']). Set to [] to re-enable all.","type":"array","items":{"type":"string"}},"draftMode":{"description":"review: all agent actions create drafts for user approval. autopilot: agent sends directly without review.","type":"string","enum":["review","autopilot"]},"aiEnabled":{"description":"Flip LLM-backed agent tasks on or off for this campaign. false blocks the cron from dispatching any AI task even if the user has keys configured.","type":"boolean"},"language":{"description":"ISO 639-1 language code (e.g. 'fr', 'en'). Overrides ASCII heuristic for AI task language.","type":"string","maxLength":10},"qualifyThreshold":{"type":"integer","minimum":0,"maximum":100}}}}}},"responses":{"200":{"description":"Campaign updated","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"campaign":{"type":"object","properties":{"id":{"type":"string","description":"Campaign unique ID (nanoid). Use this as campaignSlug in API calls."},"name":{"type":"string","description":"Human-readable campaign name."},"slug":{"description":"URL-safe slug auto-generated from name.","nullable":true,"type":"string"},"description":{"nullable":true,"description":"Optional user-facing campaign description.","type":"string"},"context":{"nullable":true,"description":"Serialized JSON blob of saved contexts (ICP, playbook, etc.). Parse to inspect individual context keys.","type":"string"},"type":{"type":"string","description":"Campaign type (e.g. 'outreach', 'engagement', 'inbox')."},"status":{"type":"string","description":"Campaign status: running, paused, offline, broken, or completed."},"totalContacts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total contacts added to this campaign across all lifecycle stages."},"scheduledStartTime":{"description":"Daily start time (HH:MM)","nullable":true,"type":"string"},"scheduledStopTime":{"description":"Daily stop time (HH:MM)","nullable":true,"type":"string"},"timezone":{"description":"IANA timezone","nullable":true,"type":"string"},"runDays":{"description":"Days to run (e.g. ['monday','tuesday'])","nullable":true,"type":"array","items":{"type":"string"}},"dailyActionLimit":{"description":"Max actions per day","nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startedAt":{"description":"When campaign was first started","nullable":true,"type":"string"},"completedAt":{"description":"When campaign was completed","nullable":true,"type":"string"},"draftMode":{"description":"review: all agent actions create drafts for approval. autopilot: agent sends directly.","type":"string","enum":["review","autopilot"]},"aiEnabled":{"description":"Whether LLM-backed agent tasks are allowed on this campaign. When false, only deterministic work runs.","type":"boolean"},"stageCounts":{"type":"object","properties":{"contact":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lead":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"qualified":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["contact","lead","qualified","approved","rejected"],"additionalProperties":false},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","description","context","type","status","totalContacts","createdAt","updatedAt"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","campaign","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"contactsDeleteCampaign","x-speakeasy-name-override":"deleteCampaign","summary":"Delete a campaign","description":"Delete a campaign. Campaign contacts are cascade-deleted but contacts themselves survive..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Campaign ID"}],"responses":{"200":{"description":"Campaign deleted","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/contacts/campaigns/{campaignId}/status":{"post":{"x-bereach":{"agents":["orchestrator"]},"operationId":"campaignTransition","x-speakeasy-name-override":"campaignStatusTransition","summary":"Campaign state transition","description":"Transition a campaign between states: activate, start, pause, resume, complete, reset..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Campaign ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["play","pause","complete","reset"]},"scheduledStartTime":{"type":"string"},"scheduledStopTime":{"type":"string"},"timezone":{"type":"string"},"runDays":{"minItems":1,"type":"array","items":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"description":"Days the dispatcher fires user-action tasks. Lowercase English day names; pick at least one."},"dailyActionLimit":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["action"]}}}},"responses":{"200":{"description":"Status updated","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"campaign":{"type":"object","properties":{"id":{"type":"string","description":"Campaign unique ID (nanoid). Use this as campaignSlug in API calls."},"name":{"type":"string","description":"Human-readable campaign name."},"slug":{"description":"URL-safe slug auto-generated from name.","nullable":true,"type":"string"},"description":{"nullable":true,"description":"Optional user-facing campaign description.","type":"string"},"context":{"nullable":true,"description":"Serialized JSON blob of saved contexts (ICP, playbook, etc.). Parse to inspect individual context keys.","type":"string"},"type":{"type":"string","description":"Campaign type (e.g. 'outreach', 'engagement', 'inbox')."},"status":{"type":"string","description":"Campaign status: running, paused, offline, broken, or completed."},"totalContacts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total contacts added to this campaign across all lifecycle stages."},"scheduledStartTime":{"description":"Daily start time (HH:MM)","nullable":true,"type":"string"},"scheduledStopTime":{"description":"Daily stop time (HH:MM)","nullable":true,"type":"string"},"timezone":{"description":"IANA timezone","nullable":true,"type":"string"},"runDays":{"description":"Days to run (e.g. ['monday','tuesday'])","nullable":true,"type":"array","items":{"type":"string"}},"dailyActionLimit":{"description":"Max actions per day","nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"startedAt":{"description":"When campaign was first started","nullable":true,"type":"string"},"completedAt":{"description":"When campaign was completed","nullable":true,"type":"string"},"draftMode":{"description":"review: all agent actions create drafts for approval. autopilot: agent sends directly.","type":"string","enum":["review","autopilot"]},"aiEnabled":{"description":"Whether LLM-backed agent tasks are allowed on this campaign. When false, only deterministic work runs.","type":"boolean"},"stageCounts":{"type":"object","properties":{"contact":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lead":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"qualified":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["contact","lead","qualified","approved","rejected"],"additionalProperties":false},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","description","context","type","status","totalContacts","createdAt","updatedAt"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","campaign","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/contacts/campaigns/{campaignId}/pending-summary":{"get":{"operationId":"contactsPendingSummary","x-speakeasy-name-override":"pendingSummary","summary":"Pending actions summary","description":"Live counts of pending work on a campaign: scheduled sends, drafts awaiting review, sending/in-flight tasks. Used by the UI to render the cancel-pending confirmation modal..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Campaign ID"}],"responses":{"200":{"description":"Pending counts","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"nullable":true,"type":"string"},"status":{"type":"string"}},"required":["id","name","slug","status"],"additionalProperties":false},"agentTasks":{"type":"integer","minimum":0,"maximum":9007199254740991},"drafts":{"type":"integer","minimum":0,"maximum":9007199254740991},"scheduled":{"type":"integer","minimum":0,"maximum":9007199254740991},"sending":{"type":"integer","minimum":0,"maximum":9007199254740991},"totalPending":{"type":"integer","minimum":0,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["campaign","agentTasks","drafts","scheduled","sending","totalPending","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/contacts/campaigns/{campaignId}/cancel-pending":{"post":{"operationId":"campaignCancelActions","x-speakeasy-name-override":"cancelCampaignActions","summary":"Cancel all pending actions on a campaign","description":"Cancels scheduled sends, drafts awaiting review, and in-flight background tasks for a campaign. Does NOT change campaign status — orthogonal to pause. Destructive..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Campaign ID"}],"responses":{"200":{"description":"Pending actions cancelled","content":{"application/json":{"schema":{"type":"object","properties":{"cancelled":{"type":"boolean","enum":[true]},"agentTasksCancelled":{"type":"integer","minimum":0,"maximum":9007199254740991},"scheduledMessagesCancelled":{"type":"integer","minimum":0,"maximum":9007199254740991},"draftsCancelled":{"type":"integer","minimum":0,"maximum":9007199254740991},"workflowsCancelled":{"type":"integer","minimum":0,"maximum":9007199254740991},"campaign":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"nullable":true,"type":"string"}},"required":["id","name","slug"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["cancelled","agentTasksCancelled","scheduledMessagesCancelled","draftsCancelled","workflowsCancelled","campaign","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/contacts/campaigns/{campaignId}/contacts":{"get":{"x-bereach":{"agents":["orchestrator","lead_gen","outreach"]},"operationId":"contactsList","x-speakeasy-name-override":"listByCampaign","summary":"List contacts in a campaign","description":"List contacts in a campaign with optional filters..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"lifecycleStage","schema":{"type":"string","enum":["contact","lead","qualified","approved","rejected"]}},{"in":"query","name":"source","schema":{"type":"string"}},{"in":"query","name":"sourceAngle","schema":{"type":"string"}},{"in":"query","name":"minHotScore","schema":{"type":"integer","minimum":0,"maximum":100}},{"in":"query","name":"limit","schema":{"default":50,"type":"integer","minimum":1,"maximum":200}},{"in":"query","name":"offset","schema":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991}},{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Campaign ID"}],"responses":{"200":{"description":"Campaign contacts","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"linkedinUrl":{"type":"string"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN (e.g. urn:li:fsd_profile:ACoAAA...)","type":"string"},"publicIdentifier":{"nullable":true,"description":"LinkedIn vanity slug (e.g. joshuaau)","type":"string"},"name":{"type":"string"},"lifecycleStage":{"type":"string"},"hotScore":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"qualificationNotes":{"nullable":true,"type":"string"},"leadBrief":{"nullable":true,"type":"string"},"notes":{"nullable":true,"type":"string"},"stageChangedAt":{"nullable":true,"type":"string"},"profileData":{"nullable":true},"profileUpdatedAt":{"nullable":true,"type":"string"},"conversationData":{"nullable":true},"conversationUpdatedAt":{"nullable":true,"type":"string"},"outreachStatus":{"type":"string"},"lastContactedAt":{"nullable":true,"type":"string"},"lastRepliedAt":{"nullable":true,"type":"string"},"nextFollowUpAt":{"nullable":true,"type":"string"},"doNotContact":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"source":{"type":"string"},"sourceAngle":{"nullable":true,"type":"string"},"addedAt":{"type":"string"}},"required":["id","linkedinUrl","profileUrn","publicIdentifier","name","lifecycleStage","hotScore","qualificationNotes","leadBrief","notes","stageChangedAt","profileData","profileUpdatedAt","conversationData","conversationUpdatedAt","outreachStatus","lastContactedAt","lastRepliedAt","nextFollowUpAt","doNotContact","tags","createdAt","updatedAt","source","sourceAngle","addedAt"],"additionalProperties":false}},"pagination":{"type":"object","properties":{"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"offset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["limit","offset","total"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","contacts","pagination","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"post":{"x-bereach":{"agents":["orchestrator","lead_gen"]},"operationId":"contactsAdd","x-speakeasy-name-override":"addToCampaign","summary":"Add contacts to a campaign","description":"Add contacts to a campaign (up to 500). Deduplicates by LinkedIn URL..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string"},"description":"Campaign ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contacts":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"object","properties":{"linkedinUrl":{"type":"string","description":"LinkedIn profile URL, URN, or bare vanity name"},"profileUrn":{"description":"LinkedIn profile URN (e.g. urn:li:fsd_profile:ACoAAA...). Improves dedup when provided alongside a vanity URL.","nullable":true,"type":"string"},"publicIdentifier":{"description":"LinkedIn vanity slug (e.g. joshuaau). Improves dedup when provided alongside a URN.","nullable":true,"type":"string"},"name":{"type":"string","description":"Profile name"},"source":{"default":"manual_import","description":"How this contact was found. Optional for organic creation (defaults to manual_import), required for campaign-based addition. Unknown values default to manual_import.","type":"string","enum":["likes","comments","reposts","posts","company_followers","search_results","manual_import","event_attendees","group_members","engagement_scraping","content_search","followers_mining","people_search","job_search","company_search","network_expansion","bulk_visit","hubspot_import","salesforce_import","external_crm"]},"sourceAngle":{"description":"Which lead-gen angle found this (e.g., 'vp-sales-france')","type":"string"},"lifecycleStage":{"description":"Lifecycle stage. Defaults to 'contact' on creation. Omit when adding existing contacts to avoid downgrading their stage.","type":"string","enum":["contact","lead","qualified","approved","rejected"]},"hotScore":{"description":"Contact quality score (0-100)","type":"integer","minimum":0,"maximum":100},"qualificationNotes":{"description":"Agent reasoning for qualification decision","type":"string"},"leadBrief":{"description":"Human-readable lead summary for sales prep (2-3 sentences)","type":"string"},"notes":{"type":"string"}},"required":["linkedinUrl","name","source"]},"description":"Contacts to add (single or bulk)"}},"required":["contacts"]}}}},"responses":{"201":{"description":"Contacts added","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"results":{"type":"object","properties":{"created":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"errors":{"type":"array","items":{"type":"string"}}},"required":["created","skipped","errors"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","results","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/contacts/campaigns/{campaignId}/health":{"get":{"operationId":"campaignHealth","x-speakeasy-name-override":"getCampaignHealth","summary":"Diagnose campaign health","description":"Returns real-time health status for a campaign: 13 blocker checks (status, ICP, credentials, interval, limits, business hours, circuit breaker), pipeline stats, success rate, and recent dispatch log.","tags":["campaigns"],"security":[{"token":[]}],"parameters":[{"name":"campaignId","in":"path","required":true,"description":"Campaign ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Campaign health diagnostics","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"status":{"type":"string"},"schedule":{"type":"string","description":"Business hours window (e.g. '09:00-18:00')"},"timezone":{"type":"string"},"runDays":{"type":"array","items":{"type":"string"}},"dailyTarget":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"totalTarget":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["id","name","type","status","schedule","timezone","runDays","dailyTarget","totalTarget"],"additionalProperties":false},"blockers":{"type":"array","items":{"type":"object","properties":{"check":{"type":"string","description":"Check name (e.g. campaign_status, icp_context, credential_valid, business_hours)"},"blocking":{"type":"boolean","description":"True if this check is currently blocking dispatch"},"details":{"type":"string","description":"Human-readable details about the check result"}},"required":["check","blocking","details"],"additionalProperties":false}},"pipeline":{"type":"object","properties":{"lastTask":{"nullable":true,"type":"object","properties":{"type":{"type":"string"},"status":{"type":"string"},"completedAt":{"nullable":true,"type":"string"},"createdAt":{"type":"string"}},"required":["type","status","completedAt","createdAt"],"additionalProperties":false},"todayCount":{"type":"object","additionalProperties":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"successRate24h":{"nullable":true,"description":"Success rate % over last 24h (null if no data)","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["lastTask","todayCount","successRate24h"],"additionalProperties":false},"recentSkips":{"type":"array","items":{},"description":"Recent dispatch skip log entries from Redis"}},"required":["campaign","blockers","pipeline","recentSkips"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/issues":{"get":{"x-bereach":{"agents":[]},"operationId":"getIssues","summary":"List active issues blocking campaign progress","description":"Unified read of campaign issues — capability gaps (missing ICP/tone/strategy), AI provider auth/billing trips, LinkedIn session expired, dispatch skip-reasons, reasoner verdicts, and rate limits — all collapsed into one shape with category and severity. Pass `campaignId` to scope to a single campaign. Routine pacing (business hours, target reached, chain in progress) is intentionally NOT surfaced.","tags":["issues"],"security":[{"token":[]}],"parameters":[{"name":"campaignId","in":"query","required":false,"description":"Restrict to issues touching one campaign (id or slug).","schema":{"type":"string"}},{"name":"scope","in":"query","required":false,"description":"active (default) hides resolved; all includes them.","schema":{"type":"string","enum":["active","all"]}},{"name":"categories","in":"query","required":false,"description":"Comma-separated subset of categories (e.g. `auth,billing,rate-limit` for header banners).","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Max issues to return (default 30, max 50).","schema":{"type":"integer"}},{"name":"verbose","in":"query","required":false,"description":"Include evidence and raw fields (default false — compact format omits these large fields).","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Active issues for the user (and optionally a single campaign).","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"issues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"campaignId":{"type":"string"},"campaignName":{"type":"string"},"source":{"type":"string","enum":["reasoner","skip-reason","capability-gap","circuit","credential","lifecycle"]},"category":{"type":"string","enum":["missing-context","auth","billing","rate-limit","no-work","config","infra","stranded-replies","stalled"]},"severity":{"type":"string","enum":["info","warn","block"]},"state":{"type":"string","enum":["active","resolved","snoozed"]},"dedupeKey":{"type":"string","description":"Stable identity for cross-producer dedupe — `${category}:${campaignId|user}`, optionally suffixed with `:${reasonFamily}` for `missing-context` so distinct user actions stay separate."},"summary":{"type":"string"},"fixHint":{"type":"string"},"fixUrl":{"type":"string"},"evidence":{"description":"Reasoner-only: human-readable evidence trail.","type":"string"},"suggestedRemediations":{"type":"array","items":{"type":"string"}},"firstSeenAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastSeenAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"resolvedAt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"resolvedBy":{"type":"string","enum":["manual","auto","sweep"]},"raw":{"type":"object","additionalProperties":{}}},"required":["id","source","category","severity","state","dedupeKey","summary","firstSeenAt","lastSeenAt"],"additionalProperties":false}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total matching issues before limit"},"hasMore":{"type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["success","issues","total","hasMore","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/contacts/campaigns/{campaignId}/health/classify":{"post":{"x-bereach":{"agents":["orchestrator"]},"operationId":"campaignHealthCheck","x-speakeasy-name-override":"classifyCampaignHealth","summary":"AI-classify campaign health","description":"Ask the AI-first campaign health reasoner to classify a campaign's current state. Returns a diagnosis (healthy? root causes? severity?) plus concrete remediations in the user's language. Use when the user asks why a campaign is stalled, or when you want to confirm a campaign is progressing. Publishes dedup alerts (24h) as a side effect so they appear in Recent Activity.","tags":["campaigns"],"security":[{"token":[]}],"parameters":[{"name":"campaignId","in":"path","required":true,"description":"Campaign id, slug, or name — all resolve server-side.","schema":{"type":"string"}}],"responses":{"200":{"description":"Classification result","content":{"application/json":{"schema":{"type":"object","properties":{"healthy":{"type":"boolean"},"summary":{"type":"string"},"severity":{"type":"string","enum":["low","medium","high"]},"rootCauses":{"type":"array","items":{"type":"string"}},"remediations":{"type":"array","items":{"type":"string"}}},"required":["healthy","summary"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/contacts/by-url":{"get":{"x-bereach":{"agents":["orchestrator","lead_gen","outreach"]},"operationId":"contactsGetByUrl","x-speakeasy-name-override":"getByUrl","summary":"Look up contact by LinkedIn URL","description":"Find a contact by LinkedIn URL. Returns full contact with activities and campaign memberships..","tags":["contacts"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"linkedinUrl","schema":{"type":"string","description":"LinkedIn profile URL to look up"},"required":true,"description":"LinkedIn profile URL to look up"}],"responses":{"200":{"description":"Contact found","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"contact":{"type":"object","properties":{"id":{"type":"string"},"linkedinUrl":{"type":"string"},"profileUrn":{"nullable":true,"description":"LinkedIn profile URN (e.g. urn:li:fsd_profile:ACoAAA...)","type":"string"},"publicIdentifier":{"nullable":true,"description":"LinkedIn vanity slug (e.g. joshuaau)","type":"string"},"name":{"type":"string"},"lifecycleStage":{"type":"string"},"hotScore":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"qualificationNotes":{"nullable":true,"type":"string"},"leadBrief":{"nullable":true,"type":"string"},"notes":{"nullable":true,"type":"string"},"stageChangedAt":{"nullable":true,"type":"string"},"profileData":{"nullable":true},"profileUpdatedAt":{"nullable":true,"type":"string"},"conversationData":{"nullable":true},"conversationUpdatedAt":{"nullable":true,"type":"string"},"outreachStatus":{"type":"string"},"lastContactedAt":{"nullable":true,"type":"string"},"lastRepliedAt":{"nullable":true,"type":"string"},"nextFollowUpAt":{"nullable":true,"type":"string"},"doNotContact":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"activities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"content":{"nullable":true,"type":"string"},"metadata":{"nullable":true},"createdAt":{"type":"string"}},"required":["id","type","content","metadata","createdAt"],"additionalProperties":false}},"campaigns":{"type":"array","items":{"type":"object","properties":{"campaignId":{"type":"string"},"campaignName":{"type":"string"},"campaignStatus":{"type":"string"},"source":{"type":"string"},"sourceAngle":{"nullable":true,"type":"string"},"addedAt":{"type":"string"}},"required":["campaignId","campaignName","campaignStatus","source","sourceAngle","addedAt"],"additionalProperties":false}}},"required":["id","linkedinUrl","profileUrn","publicIdentifier","name","lifecycleStage","hotScore","qualificationNotes","leadBrief","notes","stageChangedAt","profileData","profileUpdatedAt","conversationData","conversationUpdatedAt","outreachStatus","lastContactedAt","lastRepliedAt","nextFollowUpAt","doNotContact","tags","createdAt","updatedAt","activities","campaigns"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (always 0 for contacts queries)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before next call of the same type (always 0 for contacts queries)."}},"required":["success","contact","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/me/switch-account":{"post":{"operationId":"switchAccount","x-speakeasy-name-override":"switchAccount","summary":"Switch active LinkedIn account","description":"Switch the active LinkedIn account. All subsequent API calls will use the selected account's credentials.","tags":["profile"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"example":{"credentialsId":"clxyz1234"},"schema":{"type":"object","properties":{"credentialsId":{"type":"string","minLength":1,"description":"The LinkedIn credentials ID to switch to (from listAccounts)"}},"required":["credentialsId"]}}}},"responses":{"200":{"description":"Account switched","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"account":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"avatar":{"nullable":true,"type":"string"},"plan":{"type":"string"}},"required":["id","name","avatar","plan"],"additionalProperties":false,"description":"Switched account summary"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","account","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/me/linkedin/connections":{"get":{"x-bereach":{"cost":"read","agents":["lead_gen"],"resultShape":"list"},"operationId":"getConnections","x-speakeasy-name-override":"listConnections","summary":"List LinkedIn connections","description":"List your LinkedIn connections (1st degree) with name, headline, profile URL, and connection date.","tags":["profile"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"start","schema":{"description":"Pagination offset","default":0,"type":"integer","minimum":0,"maximum":9007199254740991},"description":"Pagination offset"},{"in":"query","name":"count","schema":{"description":"Results per page (max 40)","default":40,"type":"integer","minimum":1,"maximum":40},"description":"Results per page (max 40)"},{"in":"query","name":"sortType","schema":{"description":"Sort order (default RECENTLY_ADDED)","type":"string","enum":["RECENTLY_ADDED"]},"description":"Sort order (default RECENTLY_ADDED)"},{"in":"query","name":"keywords","schema":{"description":"Filter connections by name","type":"string"},"description":"Filter connections by name"}],"responses":{"200":{"description":"Connections list","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"connections":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"headline":{"nullable":true,"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"profileUrn":{"nullable":true,"type":"string"},"publicIdentifier":{"nullable":true,"type":"string"},"profilePicture":{"nullable":true,"description":"Profile picture URL","type":"string"},"connectedAt":{"nullable":true,"description":"Connection date (Unix timestamp ms or ISO string)","anyOf":[{"type":"number"},{"type":"string"}]}},"required":["name","headline","profileUrl","profileUrn","publicIdentifier","profilePicture","connectedAt"],"additionalProperties":false}},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasMore":{"type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","connections","count","start","total","hasMore","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/me/linkedin/activity":{"get":{"x-bereach":{"cost":"read","agents":["orchestrator","lead_gen"]},"operationId":"getOwnActivity","x-speakeasy-name-override":"getMyActivity","summary":"Get recent activity (comments or reactions)","description":"Get recent activity (comments or reactions) by the authenticated user or a company page. Useful for verifying authorship of actions.","tags":["profile"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"tabType","schema":{"default":"COMMENTS","description":"Type of activity to fetch","type":"string","enum":["COMMENTS","REACTIONS"]},"description":"Type of activity to fetch"},{"in":"query","name":"companyId","schema":{"description":"Company page ID to fetch organization activity instead of personal","type":"string"},"description":"Company page ID to fetch organization activity instead of personal"},{"in":"query","name":"count","schema":{"default":20,"description":"Number of items per page (max 50)","type":"integer","minimum":1,"maximum":50},"description":"Number of items per page (max 50)"},{"in":"query","name":"start","schema":{"default":0,"description":"Pagination offset","type":"integer","minimum":0,"maximum":9007199254740991},"description":"Pagination offset"},{"in":"query","name":"paginationToken","schema":{"description":"Pagination token from previous response","type":"string"},"description":"Pagination token from previous response"}],"responses":{"200":{"description":"Activity list","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"actor":{"type":"string","description":"'personal' for user activity, 'company:{id}' for org activity"},"tabType":{"type":"string","enum":["COMMENTS","REACTIONS"]},"items":{"type":"array","items":{},"description":"Activity items — comments or reactions depending on tabType"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"start":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paginationToken":{"nullable":true,"type":"string"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed by this call (0 for free endpoints, cached results, or duplicates)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before making another call of the same type. 0 means no wait needed."}},"required":["success","actor","tabType","items","count","total","start","paginationToken","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/scheduled-messages":{"get":{"x-bereach":{"agents":["orchestrator","outreach"]},"operationId":"scheduledMessageList","x-speakeasy-name-override":"list","summary":"List scheduled messages","description":"List messages with optional filters by status, contact, or campaign. Valid status values: draft | scheduled | sending | sent | failed | cancelled. Do NOT pass outreachStatus values (like 'replied') here — to find contacts who replied to a DM, use contacts_search(outreachStatus:'replied') or inbox_list.","tags":["scheduledMessages"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"status","schema":{"type":"string","enum":["draft","scheduled","sending","sent","failed","cancelled"]}},{"in":"query","name":"contactId","schema":{"type":"string"}},{"in":"query","name":"campaignSlug","schema":{"type":"string"}},{"in":"query","name":"limit","schema":{"default":50,"type":"integer","minimum":1,"maximum":200}},{"in":"query","name":"offset","schema":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Messages list","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"contactId":{"type":"string"},"contactName":{"description":"Contact name (included in list, absent in create)","nullable":true,"type":"string"},"contactLinkedinUrl":{"description":"Contact LinkedIn URL (included in list, absent in create)","nullable":true,"type":"string"},"message":{"type":"string"},"status":{"type":"string","enum":["draft","scheduled","sending","sent","failed","cancelled"]},"scheduledSendAt":{"nullable":true,"type":"string"},"sentAt":{"nullable":true,"type":"string"},"campaignSlug":{"nullable":true,"type":"string"},"errorMessage":{"description":"Error message if status is 'failed'","nullable":true,"type":"string"},"createdAt":{"type":"string"}},"required":["id","contactId","message","status","scheduledSendAt","sentAt","campaignSlug","createdAt"],"additionalProperties":false}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"offset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed (always 0 for workspace operations)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait (always 0 for workspace operations)."}},"required":["success","messages","total","limit","offset","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"post":{"x-bereach":{"agents":["orchestrator","outreach"],"guards":["profileTargeting","contactTargetingBulk","scheduledSend","warmupBlocked"]},"operationId":"scheduledMessageCreate","x-speakeasy-name-override":"create","summary":"Create a draft DM","description":"Create a draft message for a contact. Set status to 'scheduled' with scheduledSendAt to queue for auto-send..","tags":["scheduledMessages"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contactId":{"type":"string","description":"Internal contact ID"},"message":{"type":"string","description":"DM text"},"status":{"description":"Default 'draft'","type":"string","enum":["draft","scheduled"]},"scheduledSendAt":{"description":"ISO datetime for auto-send","type":"string"},"campaignSlug":{"type":"string"}},"required":["contactId","message"]}}}},"responses":{"201":{"description":"Message created","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"scheduledMessage":{"type":"object","properties":{"id":{"type":"string"},"contactId":{"type":"string"},"contactName":{"description":"Contact name (included in list, absent in create)","nullable":true,"type":"string"},"contactLinkedinUrl":{"description":"Contact LinkedIn URL (included in list, absent in create)","nullable":true,"type":"string"},"message":{"type":"string"},"status":{"type":"string","enum":["draft","scheduled","sending","sent","failed","cancelled"]},"scheduledSendAt":{"nullable":true,"type":"string"},"sentAt":{"nullable":true,"type":"string"},"campaignSlug":{"nullable":true,"type":"string"},"errorMessage":{"description":"Error message if status is 'failed'","nullable":true,"type":"string"},"createdAt":{"type":"string"}},"required":["id","contactId","message","status","scheduledSendAt","sentAt","campaignSlug","createdAt"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed (always 0 for workspace operations)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait (always 0 for workspace operations)."}},"required":["success","scheduledMessage","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/scheduled-messages/schedule":{"post":{"x-bereach":{"agents":["orchestrator","outreach"],"guards":["scheduledSend","warmupBlocked"]},"operationId":"draftSchedule","x-speakeasy-name-override":"batchSchedule","summary":"Batch-schedule drafts for auto-send","description":"Schedule existing draft messages for auto-send at a specific time..","tags":["scheduledMessages"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contactIds":{"description":"Schedule all drafts for these contacts","type":"array","items":{"type":"string"}},"messageIds":{"description":"Schedule specific messages","type":"array","items":{"type":"string"}},"scheduledSendAt":{"type":"string","description":"ISO datetime for sending"},"editedMessages":{"description":"Map of messageId → new content for last-minute edits before scheduling","type":"object","additionalProperties":{"type":"string"}}},"required":["scheduledSendAt"]}}}},"responses":{"200":{"description":"Messages scheduled","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"scheduled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of messages scheduled"},"triggerFailures":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of cron trigger failures (messages reverted to draft)"},"scheduledSendAt":{"type":"string","description":"ISO datetime for first send"},"staggerMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Minutes between staggered sends (0 if single message)"},"lastSendAt":{"type":"string","description":"ISO datetime when last staggered message will be sent"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed (always 0 for workspace operations)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait (always 0 for workspace operations)."}},"required":["success","scheduled","triggerFailures","scheduledSendAt","staggerMinutes","lastSendAt","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/scheduled-messages/update":{"patch":{"x-bereach":{"agents":["orchestrator","outreach"]},"operationId":"scheduledMessageUpdate","x-speakeasy-name-override":"update","summary":"Edit a draft DM","description":"Edit the text or scheduled-send time of a draft DM. Only rows in `draft` status are editable — scheduled/sending/sent/failed/cancelled are terminal for text edits. Returns `{updated, ineligible}` so the caller can distinguish missing ids from already-approved rows.","tags":["scheduledMessages"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Scheduled message id to edit"},"message":{"description":"New DM text","type":"string"},"scheduledSendAt":{"description":"New ISO datetime, or null to clear","nullable":true,"type":"string"}},"required":["messageId"]}}}},"responses":{"200":{"description":"Message updated","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"updated":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"contactId":{"type":"string"},"contactName":{"description":"Contact name (included in list, absent in create)","nullable":true,"type":"string"},"contactLinkedinUrl":{"description":"Contact LinkedIn URL (included in list, absent in create)","nullable":true,"type":"string"},"message":{"type":"string"},"status":{"type":"string","enum":["draft","scheduled","sending","sent","failed","cancelled"]},"scheduledSendAt":{"nullable":true,"type":"string"},"sentAt":{"nullable":true,"type":"string"},"campaignSlug":{"nullable":true,"type":"string"},"errorMessage":{"description":"Error message if status is 'failed'","nullable":true,"type":"string"},"createdAt":{"type":"string"}},"required":["id","contactId","message","status","scheduledSendAt","sentAt","campaignSlug","createdAt"],"additionalProperties":false}},"ineligible":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"currentStatus":{"type":"string"}},"required":["id","currentStatus"],"additionalProperties":false}},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed (always 0 for workspace operations)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait (always 0 for workspace operations)."}},"required":["success","updated","ineligible","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/scheduled-messages/cancel":{"patch":{"x-bereach":{"agents":["orchestrator","outreach"]},"operationId":"scheduledMessageCancel","x-speakeasy-name-override":"cancel","summary":"Cancel scheduled or draft messages","description":"Cancel messages by ID or by contact..","tags":["scheduledMessages"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"messageIds":{"description":"Cancel specific messages","type":"array","items":{"type":"string"}},"contactIds":{"description":"Cancel all pending for these contacts","type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Messages cancelled","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"cancelled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed (always 0 for workspace operations)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait (always 0 for workspace operations)."}},"required":["success","cancelled","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/context":{"get":{"x-bereach":{"agents":["orchestrator","lead_gen","outreach"]},"operationId":"contextList","x-speakeasy-name-override":"listEntries","summary":"List context entries","description":"List user-managed context entries (user profile, ICP, Messaging Playbook, search-strategy, engagement-strategy, etc.). By default returns a 200-char content preview per entry to stay within context budget — pass fullContent=true to retrieve complete content for a specific entry. Use scope and type filters to narrow results; fetching all entries without filters can return hundreds of rows.","tags":["context"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"scope","schema":{"description":"Filter by scope (e.g. \"campaign:abc\", \"user\")","type":"string"},"description":"Filter by scope (e.g. \"campaign:abc\", \"user\")"},{"in":"query","name":"type","schema":{"description":"Filter by type (e.g. \"icp\", \"playbook\")","type":"string"},"description":"Filter by type (e.g. \"icp\", \"playbook\")"},{"in":"query","name":"limit","schema":{"default":20,"description":"Max entries to return (default 20, max 50). Paginate with offset for more.","type":"integer","minimum":1,"maximum":50},"description":"Max entries to return (default 20, max 50). Paginate with offset for more."},{"in":"query","name":"offset","schema":{"default":0,"description":"Pagination offset","type":"integer","minimum":0,"maximum":9007199254740991},"description":"Pagination offset"},{"in":"query","name":"fullContent","schema":{"default":false,"description":"Return full content instead of 200-char preview. Use only when retrieving a specific entry (combine with type+scope filters).","type":"boolean"},"description":"Return full content instead of 200-char preview. Use only when retrieving a specific entry (combine with type+scope filters)."}],"responses":{"200":{"description":"Context entries","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique entry ID"},"type":{"type":"string"},"label":{"nullable":true,"type":"string"},"content":{"type":"string","description":"Full content (present when fullContent=true) or a 200-char preview"},"contentPreview":{"description":"First 200 chars of content — present when fullContent is not requested","type":"string"},"scope":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","type","label","content","scope","updatedAt"],"additionalProperties":false}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Total matching entries"},"hasMore":{"type":"boolean"},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed (always 0 for workspace operations)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait (always 0 for workspace operations)."}},"required":["success","entries","total","hasMore","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"put":{"x-bereach":{"agents":["orchestrator","lead_gen","outreach"]},"operationId":"contextSet","x-speakeasy-name-override":"set","summary":"Create or update a context entry","description":"Save context (ICP, Messaging Playbook, user profile, search-strategy, engagement-strategy, etc.).","tags":["context"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Context type — closed set (server rejects anything else with 400 INVALID_CONTEXT_TYPE). Pick the canonical slot that matches the content; free-form \"custom:*\" slugs are rejected. Per-slot contracts:\n• \"user-profile\" — Who the operator is — name, role, company, background. Saved once globally; personalises every message.\n• \"offering\" — What the operator sells — products, services, agencies, anything they deliver to clients. Saved once globally.\n• \"icp\" — Who this campaign targets — titles, industries, seniority, geography, company size. Guides discovery and qualification.\n• \"playbook\" — How outreach is WRITTEN for this campaign — strategy, angle, value-prop, voice/tone, AND the messaging cadence (initial DM, follow-up timing, J+N reminders). One field covers the full messaging brief.\n• \"search-strategy\" — WHERE the campaign sources leads — followers, hashtags, competitor posts, search keywords, watchlists. Discovery rules only.\n• \"engagement-strategy\" — WARMUP behavior only — which posts the operator likes/comments on to stay visible, comment style, and invitation-reply policy. Contains no messaging or follow-up timing (that lives in the playbook).\n• \"competitor-monitor\" — Up to 10 company pages plus up to 10 post URLs this campaign should re-scan for fresh engagers. Scoped to one campaign — create a new campaign for the overflow.\n• \"watchlist-post\" / \"watchlist-profile\" — managed via the watchlist surface (use postTicketId from collect_posts results).\nBoundary rule: messaging cadence (J+N follow-ups, drip timing) ALWAYS belongs in playbook, NEVER in engagement-strategy. If a single user message mixes warmup behavior AND messaging cadence, emit two context_set calls (one per slot)."},"content":{"default":"","description":"Markdown content. For watchlist-post contexts, a JSON-serialized object with author metadata.","type":"string"},"scope":{"description":"Defaults to \"user\". IMPORTANT: \"search-strategy\" and \"engagement-strategy\" types MUST use scope=\"campaign:{id}\" — global user scope is rejected for these types.","type":"string"},"label":{"description":"Display label","type":"string"},"postTicketId":{"description":"For watchlist-post: pass the _postTicketId value from each post object in the collect_posts result. Server resolves the real postUrl from the ticket — fabricated IDs are rejected.","type":"string"}},"required":["type"]}}}},"responses":{"200":{"description":"Context saved","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"entry":{"type":"object","properties":{"id":{"type":"string","description":"Unique entry ID"},"type":{"type":"string"},"label":{"nullable":true,"type":"string"},"content":{"type":"string","description":"Full content (present when fullContent=true) or a 200-char preview"},"contentPreview":{"description":"First 200 chars of content — present when fullContent is not requested","type":"string"},"scope":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","type","label","content","scope","updatedAt"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed (always 0 for workspace operations)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait (always 0 for workspace operations)."}},"required":["success","entry","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"delete":{"x-bereach":{"agents":["orchestrator"]},"operationId":"contextDelete","x-speakeasy-name-override":"delete","summary":"Delete a context entry","description":"Delete a context entry by type and scope..","tags":["context"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"type","schema":{"type":"string","description":"Context type to delete"},"required":true,"description":"Context type to delete"},{"in":"query","name":"scope","schema":{"description":"Scope (defaults to \"user\")","type":"string"},"description":"Scope (defaults to \"user\")"}],"responses":{"200":{"description":"Context deleted","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed (always 0 for workspace operations)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait (always 0 for workspace operations)."}},"required":["success","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/tasks/list":{"get":{"x-bereach":{"agents":["orchestrator"]},"operationId":"listTasks","x-speakeasy-name-override":"listTasks","summary":"List tasks","description":"List tasks for the authenticated user with optional filters..","tags":["tasks"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"status","schema":{"description":"Filter by task status","type":"string","enum":["queued","dispatched","accepted","running","succeeded","failed","cancelled"]},"description":"Filter by task status"},{"in":"query","name":"type","schema":{"description":"Filter by task type (e.g. outreach-draft)","type":"string"},"description":"Filter by task type (e.g. outreach-draft)"},{"in":"query","name":"campaignId","schema":{"description":"Filter by campaign ID","type":"string"},"description":"Filter by campaign ID"},{"in":"query","name":"limit","schema":{"default":50,"type":"integer","minimum":1,"maximum":100}},{"in":"query","name":"offset","schema":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991}}],"responses":{"200":{"description":"Task list","content":{"application/json":{"schema":{"type":"object","properties":{"tasks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","description":"Task type (e.g. discover-qualify, outreach-draft, engage-comment)"},"campaignId":{"nullable":true,"type":"string"},"status":{"type":"string","enum":["queued","dispatched","accepted","running","succeeded","failed","cancelled"]},"priority":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"model":{"nullable":true,"type":"string"},"result":{"nullable":true,"description":"Structured task result (after completion)"},"error":{"nullable":true,"type":"string"},"workflowRunId":{"nullable":true,"type":"string"},"createdAt":{"type":"string"},"dispatchedAt":{"nullable":true,"type":"string"},"completedAt":{"nullable":true,"type":"string"}},"required":["id","type","campaignId","status","priority","model","result","error","workflowRunId","createdAt","dispatchedAt","completedAt"],"additionalProperties":false}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"offset":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tasks","total","limit","offset"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/tasks/{id}/cancel":{"post":{"x-bereach":{"agents":[]},"operationId":"cancelTask","x-speakeasy-name-override":"cancelTask","summary":"Cancel a task","description":"Cancel a queued or running task. If already terminal, returns current status..","tags":["tasks"],"security":[{"token":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Task ID"}],"responses":{"200":{"description":"Task cancelled or already terminal","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"status":{"type":"string"},"message":{"type":"string"}},"required":["success","status"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/events/feed":{"get":{"x-bereach":{"agents":["orchestrator"]},"operationId":"eventsFeed","x-speakeasy-name-override":"eventsFeed","summary":"Poll for events","description":"Returns recent user events (task completions, replies, connections, campaign milestones). Use the cursor for pagination. Events expire after 48 hours..","tags":["tasks"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"since","schema":{"description":"ISO timestamp or epoch ms (default: 2 hours ago)","type":"string"},"description":"ISO timestamp or epoch ms (default: 2 hours ago)"},{"in":"query","name":"limit","schema":{"default":20,"type":"integer","minimum":1,"maximum":50}}],"responses":{"200":{"description":"Events","content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["task:completed","task:failed","reply:received","connection:accepted","campaign:target_reached","campaign:completed","campaign:paused"]},"campaignId":{"type":"string"},"campaignName":{"type":"string"},"summary":{"type":"string","description":"Human-readable one-line summary"},"metadata":{"type":"object","additionalProperties":{}},"timestamp":{"type":"number","description":"Unix epoch ms"}},"required":["id","type","summary","metadata","timestamp"],"additionalProperties":false}},"cursor":{"description":"Timestamp of most recent event (pass as 'since' for next poll)","type":"number"}},"required":["events"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/drafts/review":{"post":{"x-bereach":{"agents":["orchestrator","outreach"]},"operationId":"reviewDrafts","x-speakeasy-name-override":"reviewDrafts","summary":"Batch approve/reject draft DMs","description":"Approve or reject draft messages for a campaign. Approved drafts are scheduled for immediate send. Optionally edit message text before approval..","tags":["scheduledMessages"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"campaignId":{"type":"string","description":"Campaign ID"},"approved":{"description":"Message IDs to approve and send","type":"array","items":{"type":"string"}},"rejected":{"description":"Message IDs to reject/cancel","type":"array","items":{"type":"string"}},"editedMessages":{"description":"Map of messageId to new text (applied before approval)","type":"object","additionalProperties":{"type":"string"}}},"required":["campaignId"]}}}},"responses":{"200":{"description":"Review applied","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["success","approved","rejected"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/chains/{workflowRunId}/cancel":{"post":{"operationId":"cancelChain","x-speakeasy-name-override":"cancelChain","summary":"Cancel a workflow chain","description":"Cancel an entire workflow chain and all its in-flight tasks..","tags":["tasks"],"security":[{"token":[]}],"parameters":[{"name":"workflowRunId","in":"path","required":true,"schema":{"type":"string"},"description":"Workflow run ID"}],"responses":{"200":{"description":"Chain cancelled","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"tasksCancelled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Number of in-flight tasks cancelled"}},"required":["success","tasksCancelled"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/agent/snapshot":{"get":{"x-bereach":{"agents":["orchestrator","lead_gen","outreach"]},"operationId":"contextGet","x-speakeasy-name-override":"agentSnapshot","summary":"Agent session snapshot","description":"FULL SESSION SNAPSHOT for initialization only — returns all data in one call: credits, pipeline, ALL contexts across all campaigns, pendingDrafts, accounts, campaigns, events. NOT a targeted context lookup. To retrieve specific context entries (ICP, playbook, search-strategy, etc.), use context_list with type= and scope= filters — not context_get.","tags":["tasks"],"security":[{"token":[]}],"responses":{"200":{"description":"Session snapshot","content":{"application/json":{"schema":{"type":"object","properties":{"credits":{"nullable":true,"description":"Credit balance and usage"},"pipeline":{"type":"object","additionalProperties":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"description":"Contact counts by lifecycle stage"},"contexts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"label":{"nullable":true,"type":"string"},"content":{"type":"string"},"scope":{"type":"string"}},"required":["type","label","content","scope"],"additionalProperties":false}},"pendingDrafts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"failedDrafts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unreadDMs":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"pendingSentInvitations":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"activeAccount":{"nullable":true,"type":"object","properties":{"id":{"type":"string"},"name":{"nullable":true,"type":"string"},"plan":{"type":"string"},"headline":{"nullable":true,"type":"string"},"isUnlimited":{"type":"boolean"},"creditsLimit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"simulateWrites":{"type":"boolean"},"isCurrent":{"type":"boolean"}},"required":["id","name","plan","headline","isUnlimited","creditsLimit","creditsCount","simulateWrites","isCurrent"],"additionalProperties":false},"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"nullable":true,"type":"string"},"plan":{"type":"string"},"headline":{"nullable":true,"type":"string"},"isUnlimited":{"type":"boolean"},"creditsLimit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"simulateWrites":{"type":"boolean"},"isCurrent":{"type":"boolean"}},"required":["id","name","plan","headline","isUnlimited","creditsLimit","creditsCount","simulateWrites","isCurrent"],"additionalProperties":false}},"leadGenState":{"nullable":true},"outreachState":{"nullable":true},"activeCampaigns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"status":{"type":"string"},"context":{"nullable":true},"stageCounts":{"type":"object","properties":{"contact":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lead":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"qualified":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"approved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"rejected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["contact","lead","qualified","approved","rejected","total"],"additionalProperties":false},"limits":{"nullable":true,"description":"Per-campaign daily action limits","type":"object","properties":{"messagesPerDay":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"connectionsPerDay":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"commentsPerDay":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"visitsPerDay":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"repliesPerDay":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"additionalProperties":false}},"required":["id","name","type","status","context","stageCounts","limits"],"additionalProperties":false}},"campaignTaskStatus":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"description":"Per-campaign in-flight task counts by status"},"campaignChecks":{},"sessionMeta":{"nullable":true},"onboardingState":{"nullable":true},"recentEvents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["task:completed","task:failed","reply:received","connection:accepted","campaign:target_reached","campaign:completed","campaign:paused"]},"campaignId":{"type":"string"},"campaignName":{"type":"string"},"summary":{"type":"string","description":"Human-readable one-line summary"},"metadata":{"type":"object","additionalProperties":{}},"timestamp":{"type":"number","description":"Unix epoch ms"}},"required":["id","type","summary","metadata","timestamp"],"additionalProperties":false}}},"required":["credits","pipeline","contexts","pendingDrafts","failedDrafts","unreadDMs","pendingSentInvitations","activeAccount","accounts","leadGenState","outreachState","activeCampaigns","campaignTaskStatus","campaignChecks","sessionMeta","onboardingState","recentEvents"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/me/settings":{"get":{"x-bereach":{"excludeTool":true},"operationId":"getSettings","x-speakeasy-name-override":"getSettings","summary":"Get account settings","description":"Returns user profile, location, proxy, Anthropic key status, subscription, LinkedIn accounts, and pending invites..","tags":["profile"],"security":[{"token":[]}],"responses":{"200":{"description":"Account settings","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"user":{"type":"object","properties":{"id":{"type":"string"},"name":{"nullable":true,"type":"string"},"email":{"nullable":true,"type":"string"},"image":{"nullable":true,"type":"string"},"phone":{"nullable":true,"type":"string"},"createdAt":{"type":"string"}},"required":["id","name","email","image","phone","createdAt"],"additionalProperties":false},"location":{"type":"object","properties":{"country":{"nullable":true,"type":"string"},"city":{"nullable":true,"type":"string"}},"required":["country","city"],"additionalProperties":false},"proxy":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"additionalProperties":{}},"anthropicKey":{"type":"object","properties":{"isSet":{"type":"boolean"},"partial":{"nullable":true,"type":"string"}},"required":["isSet","partial"],"additionalProperties":false},"subscription":{"type":"object","properties":{"plan":{"type":"string"},"tier":{"type":"string"},"proSeatsIncluded":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"proSeatsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"status":{"nullable":true,"type":"string"},"currentPeriodEnd":{"nullable":true,"type":"string"},"hasStripe":{"type":"boolean"}},"required":["plan","tier","proSeatsIncluded","proSeatsUsed","status","currentPeriodEnd","hasStripe"],"additionalProperties":false},"linkedinAccounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"label":{"nullable":true,"type":"string"},"isDefault":{"type":"boolean"},"linkedinName":{"nullable":true,"type":"string"},"linkedinEmail":{"nullable":true,"type":"string"},"profilePic":{"nullable":true,"type":"string"},"profileUrl":{"nullable":true,"type":"string"},"headline":{"nullable":true,"type":"string"},"isValid":{"type":"boolean"},"isActive":{"type":"boolean"},"validationError":{"nullable":true,"type":"string"},"accountPlan":{"nullable":true,"type":"string"},"credits":{"type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"nullable":true,"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"isUnlimited":{"type":"boolean"}},"required":["current","limit","isUnlimited"],"additionalProperties":false},"proxy":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"],"additionalProperties":{}},"apiKey":{"nullable":true,"type":"object","properties":{"partialKey":{"type":"string"},"createdAt":{"type":"string"}},"required":["partialKey","createdAt"],"additionalProperties":false},"createdAt":{"type":"string"}},"required":["id","label","isDefault","linkedinName","linkedinEmail","profilePic","profileUrl","headline","isValid","isActive","validationError","accountPlan","credits","proxy","apiKey","createdAt"],"additionalProperties":false}},"pendingInvites":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"email":{"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"code":{"type":"string"},"maxUses":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"useCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expiresAt":{"nullable":true,"type":"string"},"createdAt":{"type":"string"}},"required":["id","email","name","code","maxUses","useCount","expiresAt","createdAt"],"additionalProperties":false}}},"required":["success","user","location","proxy","anthropicKey","subscription","linkedinAccounts","pendingInvites"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"patch":{"x-bereach":{"excludeTool":true},"operationId":"patchSettings","x-speakeasy-name-override":"patchSettings","summary":"Update account settings","description":"Update user country, city, phone, or Anthropic API key. Location changes propagate to proxy config. Anthropic key is validated before saving..","tags":["profile"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"country":{"description":"ISO country code","type":"string","minLength":1,"maxLength":10},"city":{"type":"string","minLength":1,"maxLength":100},"phone":{"nullable":true,"type":"string","maxLength":30},"anthropicKey":{"description":"Anthropic API key (sk-ant-api...). Set to null to remove.","nullable":true,"type":"string","minLength":1}}}}}},"responses":{"200":{"description":"Settings updated","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]}},"required":["success"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/me/linkedin/revalidate":{"post":{"x-bereach":{"excludeTool":true},"operationId":"revalidateLinkedin","x-speakeasy-name-override":"revalidateLinkedin","summary":"Re-validate LinkedIn session","description":"Makes a lightweight LinkedIn /me call to verify credentials are still valid. Fixes false-invalid states..","tags":["profile"],"security":[{"token":[]}],"responses":{"200":{"description":"Validation result","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"message":{"type":"string"},"wasInvalid":{"type":"boolean","description":"True if credentials were previously marked invalid"}},"required":["success","message","wasInvalid"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/settings/dm-polling":{"get":{"x-bereach":{"excludeTool":true},"operationId":"getDmPollingSettings","x-speakeasy-name-override":"getDmPollingSettings","summary":"Get DM polling settings","description":"Get DM and connection polling settings for the active LinkedIn account..","tags":["settings"],"security":[{"token":[]}],"responses":{"200":{"description":"Polling settings","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"settings":{"type":"object","properties":{"dmPollingEnabled":{"type":"boolean"},"dmWebhookUrl":{"nullable":true,"type":"string"},"dmLastPolledAt":{"nullable":true,"type":"string"},"connectionPollingEnabled":{"type":"boolean"},"connectionLastPolledAt":{"nullable":true,"type":"string"}},"required":["dmPollingEnabled","dmWebhookUrl","dmLastPolledAt","connectionPollingEnabled","connectionLastPolledAt"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed (always 0 for workspace operations)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait (always 0 for workspace operations)."}},"required":["success","settings","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"patch":{"x-bereach":{"excludeTool":true},"operationId":"patchDmPollingSettings","x-speakeasy-name-override":"patchDmPollingSettings","summary":"Update DM polling settings","description":"Enable/disable DM or connection polling and set webhook URL..","tags":["settings"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"dmPollingEnabled":{"type":"boolean"},"dmWebhookUrl":{"description":"Webhook URL for DM events","nullable":true,"type":"string"},"connectionPollingEnabled":{"description":"Enable polling to detect accepted connections","type":"boolean"}}}}}},"responses":{"200":{"description":"Settings updated","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"settings":{"type":"object","properties":{"dmPollingEnabled":{"type":"boolean"},"dmWebhookUrl":{"nullable":true,"type":"string"},"dmLastPolledAt":{"nullable":true,"type":"string"},"connectionPollingEnabled":{"type":"boolean"},"connectionLastPolledAt":{"nullable":true,"type":"string"}},"required":["dmPollingEnabled","dmWebhookUrl","dmLastPolledAt","connectionPollingEnabled","connectionLastPolledAt"],"additionalProperties":false},"creditsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits consumed (always 0 for workspace operations)."},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait (always 0 for workspace operations)."}},"required":["success","settings","creditsUsed","retryAfter"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/workspace/accounts/{id}":{"delete":{"x-bereach":{"excludeTool":true},"operationId":"deleteWorkspaceAccount","x-speakeasy-name-override":"deleteWorkspaceAccount","summary":"Remove a LinkedIn account","description":"Remove a LinkedIn account from the workspace. Cannot remove the default account. Cancels in-flight tasks, releases proxy IPs, and decrements Pro seats if applicable.","tags":["workspace"],"security":[{"token":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"LinkedIn credentials ID"}],"responses":{"200":{"description":"Account removed","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"message":{"type":"string"}},"required":["success","message"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/workspace/accounts/upgrade":{"post":{"x-bereach":{"excludeTool":true},"operationId":"upgradeWorkspaceAccount","x-speakeasy-name-override":"upgradeWorkspaceAccount","summary":"Upgrade or downgrade account plan","description":"Upgrade a LinkedIn account from Free to Pro (assigns proxy, unlimited credits) or downgrade from Pro to Free. Requires available Pro seats.","tags":["workspace"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"credentialsId":{"type":"string","description":"LinkedIn credentials ID"},"action":{"type":"string","enum":["upgrade","downgrade"]}},"required":["credentialsId","action"]}}}},"responses":{"200":{"description":"Plan changed","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"message":{"type":"string"},"seatsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"seatsIncluded":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["success","message","seatsUsed","seatsIncluded"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/workspace/invites":{"post":{"x-bereach":{"excludeTool":true},"operationId":"createWorkspaceInvite","x-speakeasy-name-override":"createWorkspaceInvite","summary":"Create or list workspace invites","description":"Create a workspace invitation (action: \"create\") or list existing ones (action: \"list\"). Sends an email if provided. Codes expire in 14 days..","tags":["workspace"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["create","list"],"description":"\"create\" to make a new invite, \"list\" to get existing"},"email":{"description":"Invitee email (sends invite email)","type":"string"},"name":{"description":"Invitee name","type":"string"},"maxUses":{"default":1,"description":"Max times code can be used","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["action"]}}}},"responses":{"200":{"description":"Invite created or listed","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"invite":{"type":"object","properties":{"id":{"type":"string"},"email":{"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"code":{"type":"string"},"status":{"type":"string"},"maxUses":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"useCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expiresAt":{"nullable":true,"type":"string"},"createdAt":{"type":"string"}},"required":["id","email","name","code","maxUses","useCount","expiresAt","createdAt"],"additionalProperties":false}},"required":["success","invite"],"additionalProperties":false},{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"invites":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"email":{"nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"code":{"type":"string"},"status":{"type":"string"},"maxUses":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"useCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"expiresAt":{"nullable":true,"type":"string"},"createdAt":{"type":"string"}},"required":["id","email","name","code","maxUses","useCount","expiresAt","createdAt"],"additionalProperties":false}},"workspace":{"type":"object","properties":{"tier":{"type":"string"},"proSeatsIncluded":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"proSeatsUsed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["tier","proSeatsIncluded","proSeatsUsed"],"additionalProperties":false}},"required":["success","invites","workspace"],"additionalProperties":false}]}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"delete":{"x-bereach":{"excludeTool":true},"operationId":"deleteWorkspaceInvite","x-speakeasy-name-override":"deleteWorkspaceInvite","summary":"Delete a workspace invite","description":"Delete an invitation by ID..","tags":["workspace"],"security":[{"token":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"inviteId":{"type":"string","description":"Invite ID to delete"}},"required":["inviteId"]}}}},"responses":{"200":{"description":"Invite deleted","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]}},"required":["success"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}},"/api-token":{"get":{"x-bereach":{"excludeTool":true},"operationId":"getApiToken","x-speakeasy-name-override":"getApiToken","summary":"Get API token","description":"Decrypt and return the full API token for a specific LinkedIn account.","tags":["profile"],"security":[{"token":[]}],"parameters":[{"in":"query","name":"accountId","schema":{"description":"LinkedIn credentials ID (defaults to current account)","type":"string"},"description":"LinkedIn credentials ID (defaults to current account)"}],"responses":{"200":{"description":"Token returned","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"nullable":true,"type":"string"},"partialKey":{"type":"string"},"createdAt":{"type":"string"},"accountId":{"type":"string"}},"required":["token"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"post":{"x-bereach":{"excludeTool":true},"operationId":"createApiToken","x-speakeasy-name-override":"createApiToken","summary":"Create API token","description":"Generate a new API token scoped to a specific LinkedIn account. Only one token per account allowed.","tags":["profile"],"security":[{"token":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"description":"LinkedIn credentials ID (defaults to current account)","type":"string"}}}}}},"responses":{"200":{"description":"Token created","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"token":{"type":"string","description":"Full API token (brc_...) - only shown once"},"partialKey":{"type":"string"},"accountId":{"type":"string"}},"required":["success","token","partialKey","accountId"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}},"delete":{"x-bereach":{"excludeTool":true},"operationId":"deleteApiToken","x-speakeasy-name-override":"deleteApiToken","summary":"Delete API token","description":"Delete the API token for a specific LinkedIn account.","tags":["profile"],"security":[{"token":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"description":"LinkedIn credentials ID (defaults to current account)","type":"string"}}}}}},"responses":{"200":{"description":"Token deleted","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]}},"required":["success"],"additionalProperties":false}}}},"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}}}}},"components":{"responses":{"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_request","message":"The server cannot or will not process the request due to something that is perceived to be a client error.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"401":{"description":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","content":{"application/json":{"example":{"success":false,"error":{"code":"unauthorized","message":"Although HTTP specifies \"unauthorized\", this response means \"unauthenticated\". Authenticate to continue.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"403":{"description":"The client does not have access rights to the content.","content":{"application/json":{"example":{"success":false,"error":{"code":"forbidden","message":"The client does not have access rights to the content.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"example":{"success":false,"error":{"code":"not_found","message":"The server cannot find the requested resource.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"409":{"description":"The request conflicts with the current state of the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"conflict","message":"The request conflicts with the current state of the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"410":{"description":"The requested content has been permanently deleted from the server.","content":{"application/json":{"example":{"success":false,"error":{"code":"invite_expired","message":"The requested content has been permanently deleted from the server.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"example":{"success":false,"error":{"code":"unprocessable_entity","message":"The request was well-formed but was unable to be followed due to semantic errors.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"429":{"description":"Rate limit exceeded. Read error.retryAfter for the wait time in seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"rate_limit_exceeded","message":"Rate limit exceeded","docs":"https://bereach.ai","retryAfter":4,"daily":{"current":25,"limit":150},"weekly":null}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"]},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"retryAfter":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Seconds to wait before retrying."},"daily":{"nullable":true,"description":"Current and max daily usage (null if no daily cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false},"weekly":{"nullable":true,"description":"Current and max weekly usage (null if no weekly cap).","type":"object","properties":{"current":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["current","limit"],"additionalProperties":false}},"required":["code","message","retryAfter","daily","weekly"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"500":{"description":"The server encountered a situation it does not know how to handle.","content":{"application/json":{"example":{"success":false,"error":{"code":"internal_server_error","message":"The server encountered a situation it does not know how to handle.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"502":{"description":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"bad_gateway","message":"LinkedIn returned a server error or the proxy connection failed. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}},"503":{"description":"Proxy capacity temporarily exceeded. Retry after a few seconds.","content":{"application/json":{"example":{"success":false,"error":{"code":"service_unavailable","message":"Proxy capacity temporarily exceeded. Retry after a few seconds.","docs":"https://bereach.ai"}},"schema":{"type":"object","properties":{"success":{"default":false,"type":"boolean","enum":[false]},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string","format":"uri"},"details":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["code","message"],"additionalProperties":false}},"required":["success","error"],"additionalProperties":false}}}}},"securitySchemes":{"token":{"type":"http","description":"Default authentication mechanism","scheme":"bearer","x-speakeasy-example":"BEREACH_API_KEY"}}}}