{ "openapi": "3.1.0", "info": { "title": "SocQ Agent API", "version": "v1-063d1c96173a", "description": "Asynchronous social data API generated from the SocQ Capability Registry." }, "servers": [ { "url": "https://api.socq.ai" } ], "paths": { "/v1/facebook-ad-library/ad": { "post": { "operationId": "socq_facebook_ad_library_ad", "summary": "Facebook Ad Library Ad API", "description": "Facebook Ad Library Ad API", "tags": [ "facebook-ad-library" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "url": { "type": "string", "minLength": 1, "description": "A public content or product URL." } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/facebook-ad-library/company-ads": { "post": { "operationId": "socq_facebook_ad_library_company_ads", "summary": "Facebook Ad Library Company Ads API", "description": "Facebook Ad Library Company Ads API", "tags": [ "facebook-ad-library" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "country": { "type": "string", "minLength": 1 }, "end_date": { "type": "string", "minLength": 1 }, "language": { "type": "string", "minLength": 1 }, "media_type": { "type": "string", "minLength": 1 }, "page_id": { "type": "string", "minLength": 1, "description": "A public page identifier." }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "sort_by": { "type": "string", "minLength": 1 }, "start_date": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 } }, "required": [ "page_id" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/facebook-ad-library/company-search": { "post": { "operationId": "socq_facebook_ad_library_company_search", "summary": "Facebook Ad Library Company Search API", "description": "Facebook Ad Library Company Search API", "tags": [ "facebook-ad-library" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "query": { "type": "string", "minLength": 1, "description": "Search query." } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/facebook-ad-library/search": { "post": { "operationId": "socq_facebook_ad_library_search", "summary": "Facebook Ad Library Search API", "description": "Facebook Ad Library Search API", "tags": [ "facebook-ad-library" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "ad_type": { "type": "string", "minLength": 1 }, "country": { "type": "string", "minLength": 1 }, "end_date": { "type": "string", "minLength": 1 }, "media_type": { "type": "string", "minLength": 1 }, "query": { "type": "string", "minLength": 1, "description": "Search query." }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "search_type": { "type": "string", "minLength": 1 }, "sort_by": { "type": "string", "minLength": 1 }, "start_date": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/facebook-marketplace/item": { "post": { "operationId": "socq_facebook_marketplace_item", "summary": "Facebook Marketplace Item API", "description": "Facebook Marketplace Item API", "tags": [ "facebook-marketplace" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/facebook-marketplace/location-search": { "post": { "operationId": "socq_facebook_marketplace_location_search", "summary": "Facebook Marketplace Location Search API", "description": "Facebook Marketplace Location Search API", "tags": [ "facebook-marketplace" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "query": { "type": "string", "minLength": 1, "description": "Search query." } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/facebook-marketplace/search": { "post": { "operationId": "socq_facebook_marketplace_search", "summary": "Facebook Marketplace Search API", "description": "Facebook Marketplace Search API", "tags": [ "facebook-marketplace" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "availability": { "type": "string", "minLength": 1 }, "condition": { "type": "string", "minLength": 1 }, "date_listed": { "type": "string", "minLength": 1 }, "delivery_method": { "type": "string", "minLength": 1 }, "latitude": { "type": "number", "minimum": -90, "maximum": 90 }, "longitude": { "type": "number", "minimum": -180, "maximum": 180 }, "max_price": { "type": "number", "minimum": 0 }, "min_price": { "type": "number", "minimum": 0 }, "query": { "type": "string", "minLength": 1, "description": "Search query." }, "radius_km": { "type": "number", "exclusiveMinimum": 0 }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "sort_by": { "type": "string", "minLength": 1 } }, "required": [ "latitude", "longitude", "query" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/facebook/comments": { "post": { "operationId": "socq_facebook_comments", "summary": "Facebook Comments API", "description": "Facebook Comments API", "tags": [ "facebook" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "callback_url": { "type": "string", "format": "uri" }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/facebook/pages": { "post": { "operationId": "socq_facebook_pages", "summary": "Facebook Page API", "description": "Facebook Page API", "tags": [ "facebook" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "callback_url": { "type": "string", "format": "uri" }, "query": { "type": "string", "minLength": 1, "description": "Search query." }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." }, "usernames": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public account usernames." } }, "required": [], "anyOf": [ { "required": [ "query" ] }, { "required": [ "urls" ] }, { "required": [ "usernames" ] } ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/facebook/posts": { "post": { "operationId": "socq_facebook_posts", "summary": "Facebook Posts API", "description": "Facebook Posts API", "tags": [ "facebook" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "callback_url": { "type": "string", "format": "uri" }, "query": { "type": "string", "minLength": 1, "description": "Search query." }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." }, "usernames": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public account usernames." } }, "required": [], "anyOf": [ { "required": [ "query" ] }, { "required": [ "urls" ] }, { "required": [ "usernames" ] } ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/instagram/comments": { "post": { "operationId": "socq_instagram_comments", "summary": "Instagram Comments API", "description": "Instagram Comments API", "tags": [ "instagram" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "callback_url": { "type": "string", "format": "uri" }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/instagram/followers-count": { "post": { "operationId": "socq_instagram_followers_count", "summary": "Instagram Followers Count API", "description": "Instagram Followers Count API", "tags": [ "instagram" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "callback_url": { "type": "string", "format": "uri" }, "query": { "type": "string", "minLength": 1, "description": "Search query." }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." }, "usernames": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public account usernames." } }, "required": [], "anyOf": [ { "required": [ "query" ] }, { "required": [ "urls" ] }, { "required": [ "usernames" ] } ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/instagram/posts": { "post": { "operationId": "socq_instagram_posts", "summary": "Instagram Posts API", "description": "Instagram Post API", "tags": [ "instagram" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "callback_url": { "type": "string", "format": "uri" }, "query": { "type": "string", "minLength": 1, "description": "Search query." }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." }, "usernames": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public account usernames." } }, "required": [], "anyOf": [ { "required": [ "query" ] }, { "required": [ "urls" ] }, { "required": [ "usernames" ] } ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/instagram/reels": { "post": { "operationId": "socq_instagram_reels", "summary": "Instagram Reels API", "description": "Instagram Reel API", "tags": [ "instagram" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "callback_url": { "type": "string", "format": "uri" }, "query": { "type": "string", "minLength": 1, "description": "Search query." }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." }, "usernames": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public account usernames." } }, "required": [], "anyOf": [ { "required": [ "query" ] }, { "required": [ "urls" ] }, { "required": [ "usernames" ] } ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/instagram/search": { "post": { "operationId": "socq_instagram_search", "summary": "Instagram Search API", "description": "Instagram Search API", "tags": [ "instagram" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "callback_url": { "type": "string", "format": "uri" }, "query": { "type": "string", "minLength": 1, "description": "Search query." }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." }, "usernames": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public account usernames." } }, "required": [], "anyOf": [ { "required": [ "query" ] }, { "required": [ "urls" ] }, { "required": [ "usernames" ] } ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/linkedin/companies": { "post": { "operationId": "socq_linkedin_companies", "summary": "LinkedIn Companies API", "description": "LinkedIn Companies API", "tags": [ "linkedin" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/linkedin/jobs": { "post": { "operationId": "socq_linkedin_jobs", "summary": "LinkedIn Jobs API", "description": "LinkedIn Jobs API", "tags": [ "linkedin" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/linkedin/posts": { "post": { "operationId": "socq_linkedin_posts", "summary": "LinkedIn Posts API", "description": "LinkedIn Posts API", "tags": [ "linkedin" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/linkedin/profiles": { "post": { "operationId": "socq_linkedin_profiles", "summary": "LinkedIn Profiles API", "description": "LinkedIn Profiles API", "tags": [ "linkedin" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/pinterest/pins": { "post": { "operationId": "socq_pinterest_pins", "summary": "Pinterest Pins API", "description": "Pinterest Pins API", "tags": [ "pinterest" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/pinterest/profiles": { "post": { "operationId": "socq_pinterest_profiles", "summary": "Pinterest Profiles API", "description": "Pinterest Profiles API", "tags": [ "pinterest" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/pinterest/search": { "post": { "operationId": "socq_pinterest_search", "summary": "Pinterest Search API", "description": "Pinterest Search API", "tags": [ "pinterest" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "query": { "type": "string", "minLength": 1, "description": "Search query." }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/pinterest/user-pins": { "post": { "operationId": "socq_pinterest_user_pins", "summary": "Pinterest User Pins API", "description": "Pinterest User Pins API", "tags": [ "pinterest" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/reddit/comments": { "post": { "operationId": "socq_reddit_comments", "summary": "Reddit Comments API", "description": "Reddit Comments API", "tags": [ "reddit" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/reddit/posts": { "post": { "operationId": "socq_reddit_posts", "summary": "Reddit Posts API", "description": "Reddit Posts API", "tags": [ "reddit" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/reddit/search": { "post": { "operationId": "socq_reddit_search", "summary": "Reddit Search API", "description": "Reddit Search API", "tags": [ "reddit" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "published_within": { "type": "string", "minLength": 1 }, "query": { "type": "string", "minLength": 1, "description": "Search query." }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/reddit/subreddit-posts": { "post": { "operationId": "socq_reddit_subreddit_posts", "summary": "Reddit Subreddit Posts API", "description": "Reddit Subreddit Posts API", "tags": [ "reddit" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "sort_by": { "type": "string", "minLength": 1 }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/threads/posts": { "post": { "operationId": "socq_threads_posts", "summary": "Threads Posts API", "description": "Threads Posts API", "tags": [ "threads" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/threads/profiles": { "post": { "operationId": "socq_threads_profiles", "summary": "Threads Profiles API", "description": "Threads Profiles API", "tags": [ "threads" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/threads/user-posts": { "post": { "operationId": "socq_threads_user_posts", "summary": "Threads User Posts API", "description": "Threads User Posts API", "tags": [ "threads" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/tiktok-shop/product": { "post": { "operationId": "socq_tiktok_shop_product", "summary": "TikTok Shop Product API", "description": "TikTok Shop Product API", "tags": [ "tiktok-shop" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "region": { "type": "string", "minLength": 1 }, "url": { "type": "string", "minLength": 1, "description": "A public content or product URL." } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/tiktok-shop/product-reviews": { "post": { "operationId": "socq_tiktok_shop_product_reviews", "summary": "TikTok Shop Product Reviews API", "description": "TikTok Shop Product Reviews API", "tags": [ "tiktok-shop" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "region": { "type": "string", "minLength": 1 }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "url": { "type": "string", "minLength": 1, "description": "A public content or product URL." } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/tiktok-shop/products": { "post": { "operationId": "socq_tiktok_shop_products", "summary": "TikTok Shop Products API", "description": "TikTok Shop Products API", "tags": [ "tiktok-shop" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "region": { "type": "string", "minLength": 1 }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "sort_by": { "type": "string", "minLength": 1 }, "url": { "type": "string", "minLength": 1, "description": "A public content or product URL." } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/tiktok-shop/search": { "post": { "operationId": "socq_tiktok_shop_search", "summary": "TikTok Shop Search API", "description": "TikTok Shop Search API", "tags": [ "tiktok-shop" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "query": { "type": "string", "minLength": 1, "description": "Search query." }, "region": { "type": "string", "minLength": 1 }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/tiktok-shop/user-showcase": { "post": { "operationId": "socq_tiktok_shop_user_showcase", "summary": "TikTok Shop User Showcase API", "description": "TikTok Shop User Showcase API", "tags": [ "tiktok-shop" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "region": { "type": "string", "minLength": 1 }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "username": { "type": "string", "minLength": 1, "description": "A public account username." } }, "required": [ "username" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/tiktok/comments": { "post": { "operationId": "socq_tiktok_comments", "summary": "TikTok Comments API", "description": "TikTok Comments API", "tags": [ "tiktok" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/tiktok/hashtags": { "post": { "operationId": "socq_tiktok_hashtags", "summary": "TikTok Hashtags API", "description": "TikTok Hashtags API", "tags": [ "tiktok" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "hashtags": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Hashtags with or without the # prefix." }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 } }, "required": [ "hashtags" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/tiktok/profiles": { "post": { "operationId": "socq_tiktok_profiles", "summary": "TikTok Profiles API", "description": "TikTok Profiles API", "tags": [ "tiktok" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "usernames": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public account usernames." } }, "required": [ "usernames" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/tiktok/search": { "post": { "operationId": "socq_tiktok_search", "summary": "TikTok Search API", "description": "TikTok Search API", "tags": [ "tiktok" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "published_within": { "type": "string", "minLength": 1 }, "query": { "type": "string", "minLength": 1, "description": "Search query." }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "sort_by": { "type": "string", "minLength": 1 } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/tiktok/videos": { "post": { "operationId": "socq_tiktok_videos", "summary": "TikTok Videos API", "description": "TikTok Videos API", "tags": [ "tiktok" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/x/posts": { "post": { "operationId": "socq_x_posts", "summary": "X Posts API", "description": "X Posts API", "tags": [ "x" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/x/profiles": { "post": { "operationId": "socq_x_profiles", "summary": "X Profiles API", "description": "X Profiles API", "tags": [ "x" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "usernames": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public account usernames." } }, "required": [ "usernames" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/x/search": { "post": { "operationId": "socq_x_search", "summary": "X Search API", "description": "X Search API", "tags": [ "x" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "query": { "type": "string", "minLength": 1, "description": "Search query." }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "sort_by": { "type": "string", "minLength": 1 } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/x/user-posts": { "post": { "operationId": "socq_x_user_posts", "summary": "X User Posts API", "description": "X User Posts API", "tags": [ "x" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "usernames": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public account usernames." } }, "required": [ "usernames" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/youtube/channel-videos": { "post": { "operationId": "socq_youtube_channel_videos", "summary": "YouTube Channel Videos API", "description": "YouTube Channel Videos API", "tags": [ "youtube" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/youtube/channels": { "post": { "operationId": "socq_youtube_channels", "summary": "YouTube Channels API", "description": "YouTube Channels API", "tags": [ "youtube" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/youtube/comments": { "post": { "operationId": "socq_youtube_comments", "summary": "YouTube Comments API", "description": "YouTube Comments API", "tags": [ "youtube" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "sort_by": { "type": "string", "minLength": 1 }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/youtube/search": { "post": { "operationId": "socq_youtube_search", "summary": "YouTube Search API", "description": "YouTube Search API", "tags": [ "youtube" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "duration": { "type": "string", "minLength": 1 }, "has_captions": { "type": "boolean" }, "published_within": { "type": "string", "minLength": 1 }, "query": { "type": "string", "minLength": 1, "description": "Search query." }, "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "sort_by": { "type": "string", "minLength": 1 } }, "required": [ "query" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/youtube/shorts": { "post": { "operationId": "socq_youtube_shorts", "summary": "YouTube Shorts API", "description": "YouTube Shorts API", "tags": [ "youtube" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "results_limit": { "type": "integer", "minimum": 1, "maximum": 2000 }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/youtube/transcripts": { "post": { "operationId": "socq_youtube_transcripts", "summary": "YouTube Transcripts API", "description": "YouTube Transcripts API", "tags": [ "youtube" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "language": { "type": "string", "minLength": 1 }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/youtube/videos": { "post": { "operationId": "socq_youtube_videos", "summary": "YouTube Videos API", "description": "YouTube Videos API", "tags": [ "youtube" ], "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "additionalProperties": false, "properties": { "urls": { "type": "array", "items": { "type": "string", "minLength": 1 }, "minItems": 1, "description": "Public profile or content URLs." } }, "required": [ "urls" ] } } } }, "responses": { "200": { "description": "Task accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSubmitResponse" } } } } } } }, "/v1/tasks/{task_id}": { "get": { "operationId": "getAgentTask", "summary": "Get task status and paginated results", "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50 } } ], "responses": { "200": { "description": "Task detail" } } } }, "/v1/tasks/{task_id}/files": { "get": { "operationId": "getAgentTaskFiles", "summary": "List task result files", "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Task files" } } } }, "/v1/catalog": { "get": { "operationId": "getCapabilityCatalog", "summary": "Get the machine-readable capability catalog", "responses": { "200": { "description": "Capability catalog" } } } }, "/v1/account": { "get": { "operationId": "getAgentAccount", "summary": "Get the authenticated account and credit balance", "security": [ { "bearerAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Account summary" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" }, "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key" } }, "schemas": { "AgentSubmitResponse": { "type": "object", "properties": { "code": { "type": "integer", "const": 200 }, "data": { "type": "object", "properties": { "task_id": { "type": "string" }, "status": { "type": "string" }, "created_time": { "type": [ "string", "null" ] }, "idempotent_replay": { "type": "boolean" } }, "required": [ "task_id", "status" ] } } } } } }